wheniwork

package module
v0.7.0 Latest Latest
Warning

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

Go to latest
Published: May 13, 2025 License: MIT Imports: 11 Imported by: 0

README

Quiqup WheniWork API Client

Go Reference

The Quiqup WhenIWork API client is a golang client implemented using oapi-codegen, it supports only a subset of the overall spec provided by wheniwork as their spec is broken, it uses an approach where openapi spec is still at the core primarily to be able to adopt the full spec if the main open api spec can be cleaned and fixed.

In Development

Package is in active development

Supported APIs

Endpoint Description Supported
/2/shifts List Shifts
/2/shifts/{id} Get, Update, or Delete a single shift by ID
/2/times List or Create Times
/2/times/{id} Get, Update, or Delete a single time by ID
/2/sites List or Create Sites
/2/sites/{id} Get, Update, or Delete Site
/2/shifts/bulk Bulk Update Shifts
/2/shifts/eligible List eligible users for OpenShift
/2/shifts/notify Notify shifts
/2/shifts/notify/{id} Notify single shift
/2/shifts/publish Publish Shifts
/2/shifts/unassign Unassign/Release Shifts
/2/shifts/unpublish Unpublish Shifts
/2/shifts/{id}/assign Assign multiple users to an OpenShift
/2/shifts/{id}/history Fetch shift history
/2/shifts/{id}/swapusers Swap users on a shift
/2/users List or Create Users
/2/users/{id} Get User
/2/users/avatar/{id} Get User Avatar
/2/users/bulkupdate Bulk Update Users
/2/users/invite Invite Users
/2/users/invite/{id} Invite single user
/2/users/profile Get User Profile
/2/locations List or Create Locations
/2/locations/{id} Get, Update, or Delete a single location by ID
/2/account Get Account
/2/account/{id} Get Account by ID
/2/account/{id}/admins List Admins
/2/account/settings Update Account Settings
/2/annotations List or Create Annotations
/2/annotations/{id} Get or Update Annotation
/2/availabilityevents List or Create Availability Events
/2/availabilityevents/{id} Get or Update Availability Event
/2/availabilityevents/{id}/exceptions Get or Update Availability Event Exceptions
/2/blocks List or Create Shift Templates (Blocks)
/2/blocks/{id} Get or Update a Shift Template (Block)
/2/import Create Import
/2/import/{id} Get Import
/2/import/{id}/finalize Finalize Import
/2/import/{id}/preview Preview Import
/2/payrolls List Payrolls
/2/payrolls/{id} Get Payroll
/2/payrolls/{id}/stats Get Payroll Statistics
/2/payrolls/notices Payroll Notices
/2/positions List or Create Positions
/2/positions/{id} Get, Update, or Delete a Position
/2/positions/bulk Bulk Update Positions
/2/punch/state Get Punch State
/2/requests List or Create Time Off Requests
/2/requests/{request_id} Get, Update, or Delete Time Off Request
/2/requesttypes List Of Time Off Request Types
/2/requesttypes/{id} Get or Delete Time Off Request Type
/2/swaps List or Create Shift Swaps
/2/swaps/{swap_id} Get or Delete a specific shift request
/2/times/clockin Clock In
/2/times/clockout Clock Out
/2/templates List or Create Schedule Templates
/2/templates/{id} Get Schedule Template
/2/timezones List Timezones
/2/timezones/{id} Get Timezone
/2/users/alerts Get User Alerts

/2/shifts/{id}/history is now supported in the OpenAPI 3.0.0 spec and available for use.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Changelog

All notable changes are documented in CHANGELOG.md. This project follows Keep a Changelog and Semantic Versioning.

Branching Model

We use Gitflow for managing releases and tracking changes in the changelog. Please follow the Gitflow workflow for all contributions and releases.

Documentation

Overview

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

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

Index

Constants

View Source
const (
	WTokenScopes  = "WToken.Scopes"
	W_TokenScopes = "W_Token.Scopes"
)
View Source
const WIWTimeFormat = "Mon, 02 Jan 2006 15:04:05 -0700"

Variables

This section is empty.

Functions

func NewAssignUsersToOpenShiftRequest

func NewAssignUsersToOpenShiftRequest(server string, id int, body AssignUsersToOpenShiftJSONRequestBody) (*http.Request, error)

NewAssignUsersToOpenShiftRequest calls the generic AssignUsersToOpenShift builder with application/json body

func NewAssignUsersToOpenShiftRequestWithBody

func NewAssignUsersToOpenShiftRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewAssignUsersToOpenShiftRequestWithBody generates requests for AssignUsersToOpenShift with any type of body

func NewBulkCreateUsersRequest

func NewBulkCreateUsersRequest(server string, body BulkCreateUsersJSONRequestBody) (*http.Request, error)

NewBulkCreateUsersRequest calls the generic BulkCreateUsers builder with application/json body

func NewBulkCreateUsersRequestWithBody

func NewBulkCreateUsersRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBulkCreateUsersRequestWithBody generates requests for BulkCreateUsers with any type of body

func NewBulkUpdateShiftsRequest

func NewBulkUpdateShiftsRequest(server string, params *BulkUpdateShiftsParams, body BulkUpdateShiftsJSONRequestBody) (*http.Request, error)

NewBulkUpdateShiftsRequest calls the generic BulkUpdateShifts builder with application/json body

func NewBulkUpdateShiftsRequestWithBody

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

NewBulkUpdateShiftsRequestWithBody generates requests for BulkUpdateShifts with any type of body

func NewCreateAccountRequest

func NewCreateAccountRequest(server string, body CreateAccountJSONRequestBody) (*http.Request, error)

NewCreateAccountRequest calls the generic CreateAccount builder with application/json body

func NewCreateAccountRequestWithBody

func NewCreateAccountRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAccountRequestWithBody generates requests for CreateAccount with any type of body

func NewCreateLocationRequest

func NewCreateLocationRequest(server string, body CreateLocationJSONRequestBody) (*http.Request, error)

NewCreateLocationRequest calls the generic CreateLocation builder with application/json body

func NewCreateLocationRequestWithBody

func NewCreateLocationRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateLocationRequestWithBody generates requests for CreateLocation with any type of body

func NewCreateOrUpdateUserAvatarRequestWithBody

func NewCreateOrUpdateUserAvatarRequestWithBody(server string, id int, params *CreateOrUpdateUserAvatarParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrUpdateUserAvatarRequestWithBody generates requests for CreateOrUpdateUserAvatar with any type of body

func NewCreateSiteRequest

func NewCreateSiteRequest(server string, params *CreateSiteParams, body CreateSiteJSONRequestBody) (*http.Request, error)

NewCreateSiteRequest calls the generic CreateSite builder with application/json body

func NewCreateSiteRequestWithBody

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

NewCreateSiteRequestWithBody generates requests for CreateSite with any type of body

func NewCreateTimeRequest

func NewCreateTimeRequest(server string, body CreateTimeJSONRequestBody) (*http.Request, error)

NewCreateTimeRequest calls the generic CreateTime builder with application/json body

func NewCreateTimeRequestWithBody

func NewCreateTimeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTimeRequestWithBody generates requests for CreateTime with any type of body

func NewCreateUserRequest

func NewCreateUserRequest(server string, params *CreateUserParams, body CreateUserJSONRequestBody) (*http.Request, error)

NewCreateUserRequest calls the generic CreateUser builder with application/json body

func NewCreateUserRequestWithBody

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

NewCreateUserRequestWithBody generates requests for CreateUser with any type of body

func NewDeleteLocationRequest

func NewDeleteLocationRequest(server string, id int, params *DeleteLocationParams) (*http.Request, error)

NewDeleteLocationRequest generates requests for DeleteLocation

func NewDeleteShiftRequest

func NewDeleteShiftRequest(server string, id int, params *DeleteShiftParams) (*http.Request, error)

NewDeleteShiftRequest generates requests for DeleteShift

func NewDeleteSiteRequest

func NewDeleteSiteRequest(server string, id int) (*http.Request, error)

NewDeleteSiteRequest generates requests for DeleteSite

func NewDeleteTimeRequest

func NewDeleteTimeRequest(server string, id int) (*http.Request, error)

NewDeleteTimeRequest generates requests for DeleteTime

func NewDeleteUserRequest

func NewDeleteUserRequest(server string, id int, params *DeleteUserParams) (*http.Request, error)

NewDeleteUserRequest generates requests for DeleteUser

func NewGetAccountRequest

func NewGetAccountRequest(server string) (*http.Request, error)

NewGetAccountRequest generates requests for GetAccount

func NewGetLocationRequest

func NewGetLocationRequest(server string, id int) (*http.Request, error)

NewGetLocationRequest generates requests for GetLocation

func NewGetShiftHistoryRequest

func NewGetShiftHistoryRequest(server string, id int, params *GetShiftHistoryParams) (*http.Request, error)

NewGetShiftHistoryRequest generates requests for GetShiftHistory

func NewGetShiftRequest

func NewGetShiftRequest(server string, id int, params *GetShiftParams) (*http.Request, error)

NewGetShiftRequest generates requests for GetShift

func NewGetSiteRequest

func NewGetSiteRequest(server string, id int) (*http.Request, error)

NewGetSiteRequest generates requests for GetSite

func NewGetSwapUsersRequest

func NewGetSwapUsersRequest(server string, id int, params *GetSwapUsersParams) (*http.Request, error)

NewGetSwapUsersRequest generates requests for GetSwapUsers

func NewGetTimeRequest

func NewGetTimeRequest(server string, id int) (*http.Request, error)

NewGetTimeRequest generates requests for GetTime

func NewGetUserProfileRequest

func NewGetUserProfileRequest(server string, params *GetUserProfileParams) (*http.Request, error)

NewGetUserProfileRequest generates requests for GetUserProfile

func NewGetUserRequest

func NewGetUserRequest(server string, id int, params *GetUserParams) (*http.Request, error)

NewGetUserRequest generates requests for GetUser

func NewInviteSingleUserRequest

func NewInviteSingleUserRequest(server string, id int, body InviteSingleUserJSONRequestBody) (*http.Request, error)

NewInviteSingleUserRequest calls the generic InviteSingleUser builder with application/json body

func NewInviteSingleUserRequestWithBody

func NewInviteSingleUserRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewInviteSingleUserRequestWithBody generates requests for InviteSingleUser with any type of body

func NewInviteUsersRequest

func NewInviteUsersRequest(server string, body InviteUsersJSONRequestBody) (*http.Request, error)

NewInviteUsersRequest calls the generic InviteUsers builder with application/json body

func NewInviteUsersRequestWithBody

func NewInviteUsersRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewInviteUsersRequestWithBody generates requests for InviteUsers with any type of body

func NewListEligibleUsersForOpenShiftRequest

func NewListEligibleUsersForOpenShiftRequest(server string, params *ListEligibleUsersForOpenShiftParams) (*http.Request, error)

NewListEligibleUsersForOpenShiftRequest generates requests for ListEligibleUsersForOpenShift

func NewListLocationsRequest

func NewListLocationsRequest(server string, params *ListLocationsParams) (*http.Request, error)

NewListLocationsRequest generates requests for ListLocations

func NewListShiftsRequest

func NewListShiftsRequest(server string, params *ListShiftsParams) (*http.Request, error)

NewListShiftsRequest generates requests for ListShifts

func NewListSitesRequest

func NewListSitesRequest(server string, params *ListSitesParams) (*http.Request, error)

NewListSitesRequest generates requests for ListSites

func NewListTimesRequest

func NewListTimesRequest(server string, params *ListTimesParams) (*http.Request, error)

NewListTimesRequest generates requests for ListTimes

func NewListUsersRequest

func NewListUsersRequest(server string, params *ListUsersParams) (*http.Request, error)

NewListUsersRequest generates requests for ListUsers

func NewLoginRequest

func NewLoginRequest(server string, params *LoginParams, body LoginJSONRequestBody) (*http.Request, error)

NewLoginRequest calls the generic Login builder with application/json body

func NewLoginRequestWithBody

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

NewLoginRequestWithBody generates requests for Login with any type of body

func NewNotifyShiftsRequest

func NewNotifyShiftsRequest(server string, params *NotifyShiftsParams, body NotifyShiftsJSONRequestBody) (*http.Request, error)

NewNotifyShiftsRequest calls the generic NotifyShifts builder with application/json body

func NewNotifyShiftsRequestWithBody

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

NewNotifyShiftsRequestWithBody generates requests for NotifyShifts with any type of body

func NewNotifySingleShiftRequest

func NewNotifySingleShiftRequest(server string, id int, params *NotifySingleShiftParams, body NotifySingleShiftJSONRequestBody) (*http.Request, error)

NewNotifySingleShiftRequest calls the generic NotifySingleShift builder with application/json body

func NewNotifySingleShiftRequestWithBody

func NewNotifySingleShiftRequestWithBody(server string, id int, params *NotifySingleShiftParams, contentType string, body io.Reader) (*http.Request, error)

NewNotifySingleShiftRequestWithBody generates requests for NotifySingleShift with any type of body

func NewPublishShiftsRequest

func NewPublishShiftsRequest(server string, params *PublishShiftsParams, body PublishShiftsJSONRequestBody) (*http.Request, error)

NewPublishShiftsRequest calls the generic PublishShifts builder with application/json body

func NewPublishShiftsRequestWithBody

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

NewPublishShiftsRequestWithBody generates requests for PublishShifts with any type of body

func NewUnassignShiftsRequest

func NewUnassignShiftsRequest(server string, body UnassignShiftsJSONRequestBody) (*http.Request, error)

NewUnassignShiftsRequest calls the generic UnassignShifts builder with application/json body

func NewUnassignShiftsRequestWithBody

func NewUnassignShiftsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUnassignShiftsRequestWithBody generates requests for UnassignShifts with any type of body

func NewUnpublishShiftsRequest

func NewUnpublishShiftsRequest(server string, body UnpublishShiftsJSONRequestBody) (*http.Request, error)

NewUnpublishShiftsRequest calls the generic UnpublishShifts builder with application/json body

func NewUnpublishShiftsRequestWithBody

func NewUnpublishShiftsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUnpublishShiftsRequestWithBody generates requests for UnpublishShifts with any type of body

func NewUpdateAccountRequest

func NewUpdateAccountRequest(server string, id int, body UpdateAccountJSONRequestBody) (*http.Request, error)

NewUpdateAccountRequest calls the generic UpdateAccount builder with application/json body

func NewUpdateAccountRequestWithBody

func NewUpdateAccountRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAccountRequestWithBody generates requests for UpdateAccount with any type of body

func NewUpdateLocationRequest

func NewUpdateLocationRequest(server string, id int, body UpdateLocationJSONRequestBody) (*http.Request, error)

NewUpdateLocationRequest calls the generic UpdateLocation builder with application/json body

func NewUpdateLocationRequestWithBody

func NewUpdateLocationRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewUpdateLocationRequestWithBody generates requests for UpdateLocation with any type of body

func NewUpdateShiftRequest

func NewUpdateShiftRequest(server string, id int, params *UpdateShiftParams, body UpdateShiftJSONRequestBody) (*http.Request, error)

NewUpdateShiftRequest calls the generic UpdateShift builder with application/json body

func NewUpdateShiftRequestWithBody

func NewUpdateShiftRequestWithBody(server string, id int, params *UpdateShiftParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateShiftRequestWithBody generates requests for UpdateShift with any type of body

func NewUpdateSiteRequest

func NewUpdateSiteRequest(server string, id int, body UpdateSiteJSONRequestBody) (*http.Request, error)

NewUpdateSiteRequest calls the generic UpdateSite builder with application/json body

func NewUpdateSiteRequestWithBody

func NewUpdateSiteRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewUpdateSiteRequestWithBody generates requests for UpdateSite with any type of body

func NewUpdateTimeRequest

func NewUpdateTimeRequest(server string, id int, body UpdateTimeJSONRequestBody) (*http.Request, error)

NewUpdateTimeRequest calls the generic UpdateTime builder with application/json body

func NewUpdateTimeRequestWithBody

func NewUpdateTimeRequestWithBody(server string, id int, contentType string, body io.Reader) (*http.Request, error)

NewUpdateTimeRequestWithBody generates requests for UpdateTime with any type of body

func NewUpdateUserRequest

func NewUpdateUserRequest(server string, id int, params *UpdateUserParams, body UpdateUserJSONRequestBody) (*http.Request, error)

NewUpdateUserRequest calls the generic UpdateUser builder with application/json body

func NewUpdateUserRequestWithBody

func NewUpdateUserRequestWithBody(server string, id int, params *UpdateUserParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateUserRequestWithBody generates requests for UpdateUser with any type of body

Types

type Account

type Account struct {
	Company  *string   `json:"company,omitempty"`
	Id       *int      `json:"id,omitempty"`
	Timezone *Timezone `json:"timezone,omitempty"`
}

Account defines model for Account.

type AssignUsersToOpenShiftJSONRequestBody

type AssignUsersToOpenShiftJSONRequestBody = ShiftAssignRequest

AssignUsersToOpenShiftJSONRequestBody defines body for AssignUsersToOpenShift for application/json ContentType.

type AssignUsersToOpenShiftResponse

type AssignUsersToOpenShiftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Openshiftapprovalrequests *[]OpenShiftApprovalRequest `json:"openshiftapprovalrequests,omitempty"`
		Shifts                    *[]Shift                    `json:"shifts,omitempty"`
	}
	JSONDefault *Error
}

func ParseAssignUsersToOpenShiftResponse

func ParseAssignUsersToOpenShiftResponse(rsp *http.Response) (*AssignUsersToOpenShiftResponse, error)

ParseAssignUsersToOpenShiftResponse parses an HTTP response from a AssignUsersToOpenShiftWithResponse call

func (AssignUsersToOpenShiftResponse) Status

Status returns HTTPResponse.Status

func (AssignUsersToOpenShiftResponse) StatusCode

func (r AssignUsersToOpenShiftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BaseScheduledBreak

type BaseScheduledBreak struct {
	AccountId *int `json:"account_id,omitempty"`

	// CreatedAt Date and time the break was created at.
	CreatedAt *string `json:"created_at,omitempty"`

	// CreatedBy The id of the user who created the break.
	CreatedBy *int `json:"created_by,omitempty"`

	// Id ID of the break. Provide in the request when updating an existing break.
	Id *int `json:"id,omitempty"`

	// Length The length of the break (seconds).
	Length int `json:"length"`

	// Paid Whether the break is a paid rest break (true) or unpaid meal break (false)
	Paid bool `json:"paid"`

	// Sort Breaks are sorted by start time if it is available. If no start time is provided, breaks are sorted by their position in the request. In a mixed list, breaks without a start time keep their original position, while breaks with a start time are sorted amongst themselves.
	Sort *int `json:"sort,omitempty"`

	// UpdatedAt Date and time the break was last updated.
	UpdatedAt *string `json:"updated_at,omitempty"`

	// UpdatedBy The id of the user who last edited the break.
	UpdatedBy *int `json:"updated_by,omitempty"`
}

BaseScheduledBreak defines model for BaseScheduledBreak.

type BulkCreateUsersJSONBody

type BulkCreateUsersJSONBody = []UserRequest

BulkCreateUsersJSONBody defines parameters for BulkCreateUsers.

type BulkCreateUsersJSONRequestBody

type BulkCreateUsersJSONRequestBody = BulkCreateUsersJSONBody

BulkCreateUsersJSONRequestBody defines body for BulkCreateUsers for application/json ContentType.

type BulkCreateUsersResponse

type BulkCreateUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BulkUserResponse
	JSON404      *Error
	JSONDefault  *Error
}

func ParseBulkCreateUsersResponse

func ParseBulkCreateUsersResponse(rsp *http.Response) (*BulkCreateUsersResponse, error)

ParseBulkCreateUsersResponse parses an HTTP response from a BulkCreateUsersWithResponse call

func (BulkCreateUsersResponse) Status

func (r BulkCreateUsersResponse) Status() string

Status returns HTTPResponse.Status

func (BulkCreateUsersResponse) StatusCode

func (r BulkCreateUsersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkEditShiftRequest

type BulkEditShiftRequest = []ShiftBulk

BulkEditShiftRequest Array of shift objects to update

type BulkUpdateShiftsJSONRequestBody

type BulkUpdateShiftsJSONRequestBody = BulkEditShiftRequest

BulkUpdateShiftsJSONRequestBody defines body for BulkUpdateShifts for application/json ContentType.

type BulkUpdateShiftsParams

type BulkUpdateShiftsParams struct {
	// AssignOpenshiftInstances When set to true, any multiple instance openshifts that are being assigned will assign only one openshift off the stack rather than the entire stack.
	AssignOpenshiftInstances *bool `form:"assign_openshift_instances,omitempty" json:"assign_openshift_instances,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

BulkUpdateShiftsParams defines parameters for BulkUpdateShifts.

type BulkUpdateShiftsResponse

type BulkUpdateShiftsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Shifts Array of shift objects to update
		Shifts *[]Shift `json:"shifts,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseBulkUpdateShiftsResponse

func ParseBulkUpdateShiftsResponse(rsp *http.Response) (*BulkUpdateShiftsResponse, error)

ParseBulkUpdateShiftsResponse parses an HTTP response from a BulkUpdateShiftsWithResponse call

func (BulkUpdateShiftsResponse) Status

func (r BulkUpdateShiftsResponse) Status() string

Status returns HTTPResponse.Status

func (BulkUpdateShiftsResponse) StatusCode

func (r BulkUpdateShiftsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BulkUserResponse

type BulkUserResponse struct {
	// Count The total number of invites sent.
	Count *int `json:"count,omitempty"`

	// InvalidRows List of invalid user rows
	InvalidRows *[]struct {
		// Row The row number in the input array.
		Row  *int  `json:"row,omitempty"`
		User *User `json:"user,omitempty"`
	} `json:"invalidRows,omitempty"`

	// Locations An array of locations (schedules) assigned to this user.
	Locations *[]int `json:"locations,omitempty"`

	// Success True if at least one invite was sent.
	Success *bool `json:"success,omitempty"`

	// ValidRows List of valid user rows
	ValidRows *[]struct {
		// Row The row number in the input array.
		Row  *int  `json:"row,omitempty"`
		User *User `json:"user,omitempty"`
	} `json:"validRows,omitempty"`
}

BulkUserResponse Response for both Valid/Invalid requests

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) AssignUsersToOpenShift

func (c *Client) AssignUsersToOpenShift(ctx context.Context, id int, body AssignUsersToOpenShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AssignUsersToOpenShiftWithBody

func (c *Client) AssignUsersToOpenShiftWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BulkCreateUsers

func (c *Client) BulkCreateUsers(ctx context.Context, body BulkCreateUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BulkCreateUsersWithBody

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

func (*Client) BulkUpdateShifts

func (c *Client) BulkUpdateShifts(ctx context.Context, params *BulkUpdateShiftsParams, body BulkUpdateShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BulkUpdateShiftsWithBody

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

func (*Client) CreateAccount

func (c *Client) CreateAccount(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAccountWithBody

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

func (*Client) CreateLocation

func (c *Client) CreateLocation(ctx context.Context, body CreateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateLocationWithBody

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

func (*Client) CreateOrUpdateUserAvatarWithBody

func (c *Client) CreateOrUpdateUserAvatarWithBody(ctx context.Context, id int, params *CreateOrUpdateUserAvatarParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSite

func (c *Client) CreateSite(ctx context.Context, params *CreateSiteParams, body CreateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSiteWithBody

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

func (*Client) CreateTime

func (c *Client) CreateTime(ctx context.Context, body CreateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTimeWithBody

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

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, params *CreateUserParams, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateUserWithBody

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

func (*Client) DeleteLocation

func (c *Client) DeleteLocation(ctx context.Context, id int, params *DeleteLocationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteShift

func (c *Client) DeleteShift(ctx context.Context, id int, params *DeleteShiftParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteSite

func (c *Client) DeleteSite(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteTime

func (c *Client) DeleteTime(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, id int, params *DeleteUserParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAccount

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

func (*Client) GetLocation

func (c *Client) GetLocation(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetShift

func (c *Client) GetShift(ctx context.Context, id int, params *GetShiftParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetShiftHistory

func (c *Client) GetShiftHistory(ctx context.Context, id int, params *GetShiftHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSite

func (c *Client) GetSite(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSwapUsers

func (c *Client) GetSwapUsers(ctx context.Context, id int, params *GetSwapUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTime

func (c *Client) GetTime(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUser

func (c *Client) GetUser(ctx context.Context, id int, params *GetUserParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUserProfile

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

func (*Client) InviteSingleUser

func (c *Client) InviteSingleUser(ctx context.Context, id int, body InviteSingleUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteSingleUserWithBody

func (c *Client) InviteSingleUserWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteUsers

func (c *Client) InviteUsers(ctx context.Context, body InviteUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteUsersWithBody

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

func (*Client) ListEligibleUsersForOpenShift

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

func (*Client) ListLocations

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

func (*Client) ListShifts

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

func (*Client) ListSites

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

func (*Client) ListTimes

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

func (*Client) ListUsers

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

func (*Client) Login

func (c *Client) Login(ctx context.Context, params *LoginParams, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LoginWithBody

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

func (*Client) NotifyShifts

func (c *Client) NotifyShifts(ctx context.Context, params *NotifyShiftsParams, body NotifyShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) NotifyShiftsWithBody

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

func (*Client) NotifySingleShift

func (c *Client) NotifySingleShift(ctx context.Context, id int, params *NotifySingleShiftParams, body NotifySingleShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) NotifySingleShiftWithBody

func (c *Client) NotifySingleShiftWithBody(ctx context.Context, id int, params *NotifySingleShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PublishShifts

func (c *Client) PublishShifts(ctx context.Context, params *PublishShiftsParams, body PublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PublishShiftsWithBody

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

func (*Client) UnassignShifts

func (c *Client) UnassignShifts(ctx context.Context, body UnassignShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UnassignShiftsWithBody

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

func (*Client) UnpublishShifts

func (c *Client) UnpublishShifts(ctx context.Context, body UnpublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UnpublishShiftsWithBody

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

func (*Client) UpdateAccount

func (c *Client) UpdateAccount(ctx context.Context, id int, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccountWithBody

func (c *Client) UpdateAccountWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateLocation

func (c *Client) UpdateLocation(ctx context.Context, id int, body UpdateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateLocationWithBody

func (c *Client) UpdateLocationWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateShift

func (c *Client) UpdateShift(ctx context.Context, id int, params *UpdateShiftParams, body UpdateShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateShiftWithBody

func (c *Client) UpdateShiftWithBody(ctx context.Context, id int, params *UpdateShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSite

func (c *Client) UpdateSite(ctx context.Context, id int, body UpdateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSiteWithBody

func (c *Client) UpdateSiteWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTime

func (c *Client) UpdateTime(ctx context.Context, id int, body UpdateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateTimeWithBody

func (c *Client) UpdateTimeWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateUser

func (c *Client) UpdateUser(ctx context.Context, id int, params *UpdateUserParams, body UpdateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateUserWithBody

func (c *Client) UpdateUserWithBody(ctx context.Context, id int, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

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

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

	CreateAccount(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAccountWithBody request with any body
	UpdateAccountWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAccount(ctx context.Context, id int, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateLocation(ctx context.Context, body CreateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteLocation request
	DeleteLocation(ctx context.Context, id int, params *DeleteLocationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocation request
	GetLocation(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateLocationWithBody request with any body
	UpdateLocationWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateLocation(ctx context.Context, id int, body UpdateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	Login(ctx context.Context, params *LoginParams, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	BulkUpdateShifts(ctx context.Context, params *BulkUpdateShiftsParams, body BulkUpdateShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	NotifyShifts(ctx context.Context, params *NotifyShiftsParams, body NotifyShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// NotifySingleShiftWithBody request with any body
	NotifySingleShiftWithBody(ctx context.Context, id int, params *NotifySingleShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	NotifySingleShift(ctx context.Context, id int, params *NotifySingleShiftParams, body NotifySingleShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PublishShifts(ctx context.Context, params *PublishShiftsParams, body PublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	UnassignShifts(ctx context.Context, body UnassignShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	UnpublishShifts(ctx context.Context, body UnpublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteShift request
	DeleteShift(ctx context.Context, id int, params *DeleteShiftParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetShift request
	GetShift(ctx context.Context, id int, params *GetShiftParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AssignUsersToOpenShiftWithBody request with any body
	AssignUsersToOpenShiftWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AssignUsersToOpenShift(ctx context.Context, id int, body AssignUsersToOpenShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateShiftWithBody request with any body
	UpdateShiftWithBody(ctx context.Context, id int, params *UpdateShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateShift(ctx context.Context, id int, params *UpdateShiftParams, body UpdateShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetShiftHistory request
	GetShiftHistory(ctx context.Context, id int, params *GetShiftHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSwapUsers request
	GetSwapUsers(ctx context.Context, id int, params *GetSwapUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateSite(ctx context.Context, params *CreateSiteParams, body CreateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSite request
	DeleteSite(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSite request
	GetSite(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateSiteWithBody request with any body
	UpdateSiteWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateSite(ctx context.Context, id int, body UpdateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateTime(ctx context.Context, body CreateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteTime request
	DeleteTime(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTime request
	GetTime(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTimeWithBody request with any body
	UpdateTimeWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTime(ctx context.Context, id int, body UpdateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateUser(ctx context.Context, params *CreateUserParams, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrUpdateUserAvatarWithBody request with any body
	CreateOrUpdateUserAvatarWithBody(ctx context.Context, id int, params *CreateOrUpdateUserAvatarParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	BulkCreateUsers(ctx context.Context, body BulkCreateUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	InviteUsers(ctx context.Context, body InviteUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InviteSingleUserWithBody request with any body
	InviteSingleUserWithBody(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	InviteSingleUser(ctx context.Context, id int, body InviteSingleUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// DeleteUser request
	DeleteUser(ctx context.Context, id int, params *DeleteUserParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUser request
	GetUser(ctx context.Context, id int, params *GetUserParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateUserWithBody request with any body
	UpdateUserWithBody(ctx context.Context, id int, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateUser(ctx context.Context, id int, params *UpdateUserParams, body UpdateUserJSONRequestBody, 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) AssignUsersToOpenShiftWithBodyWithResponse

func (c *ClientWithResponses) AssignUsersToOpenShiftWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssignUsersToOpenShiftResponse, error)

AssignUsersToOpenShiftWithBodyWithResponse request with arbitrary body returning *AssignUsersToOpenShiftResponse

func (*ClientWithResponses) AssignUsersToOpenShiftWithResponse

func (c *ClientWithResponses) AssignUsersToOpenShiftWithResponse(ctx context.Context, id int, body AssignUsersToOpenShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*AssignUsersToOpenShiftResponse, error)

func (*ClientWithResponses) BulkCreateUsersWithBodyWithResponse

func (c *ClientWithResponses) BulkCreateUsersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkCreateUsersResponse, error)

BulkCreateUsersWithBodyWithResponse request with arbitrary body returning *BulkCreateUsersResponse

func (*ClientWithResponses) BulkCreateUsersWithResponse

func (c *ClientWithResponses) BulkCreateUsersWithResponse(ctx context.Context, body BulkCreateUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkCreateUsersResponse, error)

func (*ClientWithResponses) BulkUpdateShiftsWithBodyWithResponse

func (c *ClientWithResponses) BulkUpdateShiftsWithBodyWithResponse(ctx context.Context, params *BulkUpdateShiftsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpdateShiftsResponse, error)

BulkUpdateShiftsWithBodyWithResponse request with arbitrary body returning *BulkUpdateShiftsResponse

func (*ClientWithResponses) BulkUpdateShiftsWithResponse

func (c *ClientWithResponses) BulkUpdateShiftsWithResponse(ctx context.Context, params *BulkUpdateShiftsParams, body BulkUpdateShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateShiftsResponse, error)

func (*ClientWithResponses) CreateAccountWithBodyWithResponse

func (c *ClientWithResponses) CreateAccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAccountResponse, error)

CreateAccountWithBodyWithResponse request with arbitrary body returning *CreateAccountResponse

func (*ClientWithResponses) CreateAccountWithResponse

func (c *ClientWithResponses) CreateAccountWithResponse(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAccountResponse, error)

func (*ClientWithResponses) CreateLocationWithBodyWithResponse

func (c *ClientWithResponses) CreateLocationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateLocationResponse, error)

CreateLocationWithBodyWithResponse request with arbitrary body returning *CreateLocationResponse

func (*ClientWithResponses) CreateLocationWithResponse

func (c *ClientWithResponses) CreateLocationWithResponse(ctx context.Context, body CreateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateLocationResponse, error)

func (*ClientWithResponses) CreateOrUpdateUserAvatarWithBodyWithResponse

func (c *ClientWithResponses) CreateOrUpdateUserAvatarWithBodyWithResponse(ctx context.Context, id int, params *CreateOrUpdateUserAvatarParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrUpdateUserAvatarResponse, error)

CreateOrUpdateUserAvatarWithBodyWithResponse request with arbitrary body returning *CreateOrUpdateUserAvatarResponse

func (*ClientWithResponses) CreateSiteWithBodyWithResponse

func (c *ClientWithResponses) CreateSiteWithBodyWithResponse(ctx context.Context, params *CreateSiteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSiteResponse, error)

CreateSiteWithBodyWithResponse request with arbitrary body returning *CreateSiteResponse

func (*ClientWithResponses) CreateSiteWithResponse

func (c *ClientWithResponses) CreateSiteWithResponse(ctx context.Context, params *CreateSiteParams, body CreateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSiteResponse, error)

func (*ClientWithResponses) CreateTimeWithBodyWithResponse

func (c *ClientWithResponses) CreateTimeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTimeResponse, error)

CreateTimeWithBodyWithResponse request with arbitrary body returning *CreateTimeResponse

func (*ClientWithResponses) CreateTimeWithResponse

func (c *ClientWithResponses) CreateTimeWithResponse(ctx context.Context, body CreateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTimeResponse, error)

func (*ClientWithResponses) CreateUserWithBodyWithResponse

func (c *ClientWithResponses) CreateUserWithBodyWithResponse(ctx context.Context, params *CreateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

CreateUserWithBodyWithResponse request with arbitrary body returning *CreateUserResponse

func (*ClientWithResponses) CreateUserWithResponse

func (c *ClientWithResponses) CreateUserWithResponse(ctx context.Context, params *CreateUserParams, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

func (*ClientWithResponses) DeleteLocationWithResponse

func (c *ClientWithResponses) DeleteLocationWithResponse(ctx context.Context, id int, params *DeleteLocationParams, reqEditors ...RequestEditorFn) (*DeleteLocationResponse, error)

DeleteLocationWithResponse request returning *DeleteLocationResponse

func (*ClientWithResponses) DeleteShiftWithResponse

func (c *ClientWithResponses) DeleteShiftWithResponse(ctx context.Context, id int, params *DeleteShiftParams, reqEditors ...RequestEditorFn) (*DeleteShiftResponse, error)

DeleteShiftWithResponse request returning *DeleteShiftResponse

func (*ClientWithResponses) DeleteSiteWithResponse

func (c *ClientWithResponses) DeleteSiteWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*DeleteSiteResponse, error)

DeleteSiteWithResponse request returning *DeleteSiteResponse

func (*ClientWithResponses) DeleteTimeWithResponse

func (c *ClientWithResponses) DeleteTimeWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*DeleteTimeResponse, error)

DeleteTimeWithResponse request returning *DeleteTimeResponse

func (*ClientWithResponses) DeleteUserWithResponse

func (c *ClientWithResponses) DeleteUserWithResponse(ctx context.Context, id int, params *DeleteUserParams, reqEditors ...RequestEditorFn) (*DeleteUserResponse, error)

DeleteUserWithResponse request returning *DeleteUserResponse

func (*ClientWithResponses) GetAccountWithResponse

func (c *ClientWithResponses) GetAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountResponse, error)

GetAccountWithResponse request returning *GetAccountResponse

func (*ClientWithResponses) GetLocationWithResponse

func (c *ClientWithResponses) GetLocationWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*GetLocationResponse, error)

GetLocationWithResponse request returning *GetLocationResponse

func (*ClientWithResponses) GetShiftHistoryWithResponse

func (c *ClientWithResponses) GetShiftHistoryWithResponse(ctx context.Context, id int, params *GetShiftHistoryParams, reqEditors ...RequestEditorFn) (*GetShiftHistoryResponse, error)

GetShiftHistoryWithResponse request returning *GetShiftHistoryResponse

func (*ClientWithResponses) GetShiftWithResponse

func (c *ClientWithResponses) GetShiftWithResponse(ctx context.Context, id int, params *GetShiftParams, reqEditors ...RequestEditorFn) (*GetShiftResponse, error)

GetShiftWithResponse request returning *GetShiftResponse

func (*ClientWithResponses) GetSiteWithResponse

func (c *ClientWithResponses) GetSiteWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*GetSiteResponse, error)

GetSiteWithResponse request returning *GetSiteResponse

func (*ClientWithResponses) GetSwapUsersWithResponse

func (c *ClientWithResponses) GetSwapUsersWithResponse(ctx context.Context, id int, params *GetSwapUsersParams, reqEditors ...RequestEditorFn) (*GetSwapUsersResponse, error)

GetSwapUsersWithResponse request returning *GetSwapUsersResponse

func (*ClientWithResponses) GetTimeWithResponse

func (c *ClientWithResponses) GetTimeWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*GetTimeResponse, error)

GetTimeWithResponse request returning *GetTimeResponse

func (*ClientWithResponses) GetUserProfileWithResponse

func (c *ClientWithResponses) GetUserProfileWithResponse(ctx context.Context, params *GetUserProfileParams, reqEditors ...RequestEditorFn) (*GetUserProfileResponse, error)

GetUserProfileWithResponse request returning *GetUserProfileResponse

func (*ClientWithResponses) GetUserWithResponse

func (c *ClientWithResponses) GetUserWithResponse(ctx context.Context, id int, params *GetUserParams, reqEditors ...RequestEditorFn) (*GetUserResponse, error)

GetUserWithResponse request returning *GetUserResponse

func (*ClientWithResponses) InviteSingleUserWithBodyWithResponse

func (c *ClientWithResponses) InviteSingleUserWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteSingleUserResponse, error)

InviteSingleUserWithBodyWithResponse request with arbitrary body returning *InviteSingleUserResponse

func (*ClientWithResponses) InviteSingleUserWithResponse

func (c *ClientWithResponses) InviteSingleUserWithResponse(ctx context.Context, id int, body InviteSingleUserJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteSingleUserResponse, error)

func (*ClientWithResponses) InviteUsersWithBodyWithResponse

func (c *ClientWithResponses) InviteUsersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteUsersResponse, error)

InviteUsersWithBodyWithResponse request with arbitrary body returning *InviteUsersResponse

func (*ClientWithResponses) InviteUsersWithResponse

func (c *ClientWithResponses) InviteUsersWithResponse(ctx context.Context, body InviteUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteUsersResponse, error)

func (*ClientWithResponses) ListEligibleUsersForOpenShiftWithResponse

func (c *ClientWithResponses) ListEligibleUsersForOpenShiftWithResponse(ctx context.Context, params *ListEligibleUsersForOpenShiftParams, reqEditors ...RequestEditorFn) (*ListEligibleUsersForOpenShiftResponse, error)

ListEligibleUsersForOpenShiftWithResponse request returning *ListEligibleUsersForOpenShiftResponse

func (*ClientWithResponses) ListLocationsWithResponse

func (c *ClientWithResponses) ListLocationsWithResponse(ctx context.Context, params *ListLocationsParams, reqEditors ...RequestEditorFn) (*ListLocationsResponse, error)

ListLocationsWithResponse request returning *ListLocationsResponse

func (*ClientWithResponses) ListShiftsWithResponse

func (c *ClientWithResponses) ListShiftsWithResponse(ctx context.Context, params *ListShiftsParams, reqEditors ...RequestEditorFn) (*ListShiftsResponse, error)

ListShiftsWithResponse request returning *ListShiftsResponse

func (*ClientWithResponses) ListSitesWithResponse

func (c *ClientWithResponses) ListSitesWithResponse(ctx context.Context, params *ListSitesParams, reqEditors ...RequestEditorFn) (*ListSitesResponse, error)

ListSitesWithResponse request returning *ListSitesResponse

func (*ClientWithResponses) ListTimesWithResponse

func (c *ClientWithResponses) ListTimesWithResponse(ctx context.Context, params *ListTimesParams, reqEditors ...RequestEditorFn) (*ListTimesResponse, error)

ListTimesWithResponse request returning *ListTimesResponse

func (*ClientWithResponses) ListUsersWithResponse

func (c *ClientWithResponses) ListUsersWithResponse(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*ListUsersResponse, error)

ListUsersWithResponse request returning *ListUsersResponse

func (*ClientWithResponses) LoginWithBodyWithResponse

func (c *ClientWithResponses) LoginWithBodyWithResponse(ctx context.Context, params *LoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LoginResponse, error)

LoginWithBodyWithResponse request with arbitrary body returning *LoginResponse

func (*ClientWithResponses) LoginWithResponse

func (c *ClientWithResponses) LoginWithResponse(ctx context.Context, params *LoginParams, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)

func (*ClientWithResponses) NotifyShiftsWithBodyWithResponse

func (c *ClientWithResponses) NotifyShiftsWithBodyWithResponse(ctx context.Context, params *NotifyShiftsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*NotifyShiftsResponse, error)

NotifyShiftsWithBodyWithResponse request with arbitrary body returning *NotifyShiftsResponse

func (*ClientWithResponses) NotifyShiftsWithResponse

func (c *ClientWithResponses) NotifyShiftsWithResponse(ctx context.Context, params *NotifyShiftsParams, body NotifyShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*NotifyShiftsResponse, error)

func (*ClientWithResponses) NotifySingleShiftWithBodyWithResponse

func (c *ClientWithResponses) NotifySingleShiftWithBodyWithResponse(ctx context.Context, id int, params *NotifySingleShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*NotifySingleShiftResponse, error)

NotifySingleShiftWithBodyWithResponse request with arbitrary body returning *NotifySingleShiftResponse

func (*ClientWithResponses) NotifySingleShiftWithResponse

func (c *ClientWithResponses) NotifySingleShiftWithResponse(ctx context.Context, id int, params *NotifySingleShiftParams, body NotifySingleShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*NotifySingleShiftResponse, error)

func (*ClientWithResponses) PublishShiftsWithBodyWithResponse

func (c *ClientWithResponses) PublishShiftsWithBodyWithResponse(ctx context.Context, params *PublishShiftsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishShiftsResponse, error)

PublishShiftsWithBodyWithResponse request with arbitrary body returning *PublishShiftsResponse

func (*ClientWithResponses) PublishShiftsWithResponse

func (c *ClientWithResponses) PublishShiftsWithResponse(ctx context.Context, params *PublishShiftsParams, body PublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*PublishShiftsResponse, error)

func (*ClientWithResponses) UnassignShiftsWithBodyWithResponse

func (c *ClientWithResponses) UnassignShiftsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnassignShiftsResponse, error)

UnassignShiftsWithBodyWithResponse request with arbitrary body returning *UnassignShiftsResponse

func (*ClientWithResponses) UnassignShiftsWithResponse

func (c *ClientWithResponses) UnassignShiftsWithResponse(ctx context.Context, body UnassignShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*UnassignShiftsResponse, error)

func (*ClientWithResponses) UnpublishShiftsWithBodyWithResponse

func (c *ClientWithResponses) UnpublishShiftsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnpublishShiftsResponse, error)

UnpublishShiftsWithBodyWithResponse request with arbitrary body returning *UnpublishShiftsResponse

func (*ClientWithResponses) UnpublishShiftsWithResponse

func (c *ClientWithResponses) UnpublishShiftsWithResponse(ctx context.Context, body UnpublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*UnpublishShiftsResponse, error)

func (*ClientWithResponses) UpdateAccountWithBodyWithResponse

func (c *ClientWithResponses) UpdateAccountWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

UpdateAccountWithBodyWithResponse request with arbitrary body returning *UpdateAccountResponse

func (*ClientWithResponses) UpdateAccountWithResponse

func (c *ClientWithResponses) UpdateAccountWithResponse(ctx context.Context, id int, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

func (*ClientWithResponses) UpdateLocationWithBodyWithResponse

func (c *ClientWithResponses) UpdateLocationWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateLocationResponse, error)

UpdateLocationWithBodyWithResponse request with arbitrary body returning *UpdateLocationResponse

func (*ClientWithResponses) UpdateLocationWithResponse

func (c *ClientWithResponses) UpdateLocationWithResponse(ctx context.Context, id int, body UpdateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateLocationResponse, error)

func (*ClientWithResponses) UpdateShiftWithBodyWithResponse

func (c *ClientWithResponses) UpdateShiftWithBodyWithResponse(ctx context.Context, id int, params *UpdateShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateShiftResponse, error)

UpdateShiftWithBodyWithResponse request with arbitrary body returning *UpdateShiftResponse

func (*ClientWithResponses) UpdateShiftWithResponse

func (c *ClientWithResponses) UpdateShiftWithResponse(ctx context.Context, id int, params *UpdateShiftParams, body UpdateShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateShiftResponse, error)

func (*ClientWithResponses) UpdateSiteWithBodyWithResponse

func (c *ClientWithResponses) UpdateSiteWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSiteResponse, error)

UpdateSiteWithBodyWithResponse request with arbitrary body returning *UpdateSiteResponse

func (*ClientWithResponses) UpdateSiteWithResponse

func (c *ClientWithResponses) UpdateSiteWithResponse(ctx context.Context, id int, body UpdateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSiteResponse, error)

func (*ClientWithResponses) UpdateTimeWithBodyWithResponse

func (c *ClientWithResponses) UpdateTimeWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTimeResponse, error)

UpdateTimeWithBodyWithResponse request with arbitrary body returning *UpdateTimeResponse

func (*ClientWithResponses) UpdateTimeWithResponse

func (c *ClientWithResponses) UpdateTimeWithResponse(ctx context.Context, id int, body UpdateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTimeResponse, error)

func (*ClientWithResponses) UpdateUserWithBodyWithResponse

func (c *ClientWithResponses) UpdateUserWithBodyWithResponse(ctx context.Context, id int, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error)

UpdateUserWithBodyWithResponse request with arbitrary body returning *UpdateUserResponse

func (*ClientWithResponses) UpdateUserWithResponse

func (c *ClientWithResponses) UpdateUserWithResponse(ctx context.Context, id int, params *UpdateUserParams, body UpdateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetAccountWithResponse request
	GetAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountResponse, error)

	// CreateAccountWithBodyWithResponse request with any body
	CreateAccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAccountResponse, error)

	CreateAccountWithResponse(ctx context.Context, body CreateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAccountResponse, error)

	// UpdateAccountWithBodyWithResponse request with any body
	UpdateAccountWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

	UpdateAccountWithResponse(ctx context.Context, id int, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

	// ListLocationsWithResponse request
	ListLocationsWithResponse(ctx context.Context, params *ListLocationsParams, reqEditors ...RequestEditorFn) (*ListLocationsResponse, error)

	// CreateLocationWithBodyWithResponse request with any body
	CreateLocationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateLocationResponse, error)

	CreateLocationWithResponse(ctx context.Context, body CreateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateLocationResponse, error)

	// DeleteLocationWithResponse request
	DeleteLocationWithResponse(ctx context.Context, id int, params *DeleteLocationParams, reqEditors ...RequestEditorFn) (*DeleteLocationResponse, error)

	// GetLocationWithResponse request
	GetLocationWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*GetLocationResponse, error)

	// UpdateLocationWithBodyWithResponse request with any body
	UpdateLocationWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateLocationResponse, error)

	UpdateLocationWithResponse(ctx context.Context, id int, body UpdateLocationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateLocationResponse, error)

	// LoginWithBodyWithResponse request with any body
	LoginWithBodyWithResponse(ctx context.Context, params *LoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LoginResponse, error)

	LoginWithResponse(ctx context.Context, params *LoginParams, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)

	// ListShiftsWithResponse request
	ListShiftsWithResponse(ctx context.Context, params *ListShiftsParams, reqEditors ...RequestEditorFn) (*ListShiftsResponse, error)

	// BulkUpdateShiftsWithBodyWithResponse request with any body
	BulkUpdateShiftsWithBodyWithResponse(ctx context.Context, params *BulkUpdateShiftsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkUpdateShiftsResponse, error)

	BulkUpdateShiftsWithResponse(ctx context.Context, params *BulkUpdateShiftsParams, body BulkUpdateShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkUpdateShiftsResponse, error)

	// ListEligibleUsersForOpenShiftWithResponse request
	ListEligibleUsersForOpenShiftWithResponse(ctx context.Context, params *ListEligibleUsersForOpenShiftParams, reqEditors ...RequestEditorFn) (*ListEligibleUsersForOpenShiftResponse, error)

	// NotifyShiftsWithBodyWithResponse request with any body
	NotifyShiftsWithBodyWithResponse(ctx context.Context, params *NotifyShiftsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*NotifyShiftsResponse, error)

	NotifyShiftsWithResponse(ctx context.Context, params *NotifyShiftsParams, body NotifyShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*NotifyShiftsResponse, error)

	// NotifySingleShiftWithBodyWithResponse request with any body
	NotifySingleShiftWithBodyWithResponse(ctx context.Context, id int, params *NotifySingleShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*NotifySingleShiftResponse, error)

	NotifySingleShiftWithResponse(ctx context.Context, id int, params *NotifySingleShiftParams, body NotifySingleShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*NotifySingleShiftResponse, error)

	// PublishShiftsWithBodyWithResponse request with any body
	PublishShiftsWithBodyWithResponse(ctx context.Context, params *PublishShiftsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishShiftsResponse, error)

	PublishShiftsWithResponse(ctx context.Context, params *PublishShiftsParams, body PublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*PublishShiftsResponse, error)

	// UnassignShiftsWithBodyWithResponse request with any body
	UnassignShiftsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnassignShiftsResponse, error)

	UnassignShiftsWithResponse(ctx context.Context, body UnassignShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*UnassignShiftsResponse, error)

	// UnpublishShiftsWithBodyWithResponse request with any body
	UnpublishShiftsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnpublishShiftsResponse, error)

	UnpublishShiftsWithResponse(ctx context.Context, body UnpublishShiftsJSONRequestBody, reqEditors ...RequestEditorFn) (*UnpublishShiftsResponse, error)

	// DeleteShiftWithResponse request
	DeleteShiftWithResponse(ctx context.Context, id int, params *DeleteShiftParams, reqEditors ...RequestEditorFn) (*DeleteShiftResponse, error)

	// GetShiftWithResponse request
	GetShiftWithResponse(ctx context.Context, id int, params *GetShiftParams, reqEditors ...RequestEditorFn) (*GetShiftResponse, error)

	// AssignUsersToOpenShiftWithBodyWithResponse request with any body
	AssignUsersToOpenShiftWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AssignUsersToOpenShiftResponse, error)

	AssignUsersToOpenShiftWithResponse(ctx context.Context, id int, body AssignUsersToOpenShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*AssignUsersToOpenShiftResponse, error)

	// UpdateShiftWithBodyWithResponse request with any body
	UpdateShiftWithBodyWithResponse(ctx context.Context, id int, params *UpdateShiftParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateShiftResponse, error)

	UpdateShiftWithResponse(ctx context.Context, id int, params *UpdateShiftParams, body UpdateShiftJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateShiftResponse, error)

	// GetShiftHistoryWithResponse request
	GetShiftHistoryWithResponse(ctx context.Context, id int, params *GetShiftHistoryParams, reqEditors ...RequestEditorFn) (*GetShiftHistoryResponse, error)

	// GetSwapUsersWithResponse request
	GetSwapUsersWithResponse(ctx context.Context, id int, params *GetSwapUsersParams, reqEditors ...RequestEditorFn) (*GetSwapUsersResponse, error)

	// ListSitesWithResponse request
	ListSitesWithResponse(ctx context.Context, params *ListSitesParams, reqEditors ...RequestEditorFn) (*ListSitesResponse, error)

	// CreateSiteWithBodyWithResponse request with any body
	CreateSiteWithBodyWithResponse(ctx context.Context, params *CreateSiteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSiteResponse, error)

	CreateSiteWithResponse(ctx context.Context, params *CreateSiteParams, body CreateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSiteResponse, error)

	// DeleteSiteWithResponse request
	DeleteSiteWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*DeleteSiteResponse, error)

	// GetSiteWithResponse request
	GetSiteWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*GetSiteResponse, error)

	// UpdateSiteWithBodyWithResponse request with any body
	UpdateSiteWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSiteResponse, error)

	UpdateSiteWithResponse(ctx context.Context, id int, body UpdateSiteJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSiteResponse, error)

	// ListTimesWithResponse request
	ListTimesWithResponse(ctx context.Context, params *ListTimesParams, reqEditors ...RequestEditorFn) (*ListTimesResponse, error)

	// CreateTimeWithBodyWithResponse request with any body
	CreateTimeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTimeResponse, error)

	CreateTimeWithResponse(ctx context.Context, body CreateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTimeResponse, error)

	// DeleteTimeWithResponse request
	DeleteTimeWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*DeleteTimeResponse, error)

	// GetTimeWithResponse request
	GetTimeWithResponse(ctx context.Context, id int, reqEditors ...RequestEditorFn) (*GetTimeResponse, error)

	// UpdateTimeWithBodyWithResponse request with any body
	UpdateTimeWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTimeResponse, error)

	UpdateTimeWithResponse(ctx context.Context, id int, body UpdateTimeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTimeResponse, error)

	// ListUsersWithResponse request
	ListUsersWithResponse(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*ListUsersResponse, error)

	// CreateUserWithBodyWithResponse request with any body
	CreateUserWithBodyWithResponse(ctx context.Context, params *CreateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

	CreateUserWithResponse(ctx context.Context, params *CreateUserParams, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)

	// CreateOrUpdateUserAvatarWithBodyWithResponse request with any body
	CreateOrUpdateUserAvatarWithBodyWithResponse(ctx context.Context, id int, params *CreateOrUpdateUserAvatarParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrUpdateUserAvatarResponse, error)

	// BulkCreateUsersWithBodyWithResponse request with any body
	BulkCreateUsersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkCreateUsersResponse, error)

	BulkCreateUsersWithResponse(ctx context.Context, body BulkCreateUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkCreateUsersResponse, error)

	// InviteUsersWithBodyWithResponse request with any body
	InviteUsersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteUsersResponse, error)

	InviteUsersWithResponse(ctx context.Context, body InviteUsersJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteUsersResponse, error)

	// InviteSingleUserWithBodyWithResponse request with any body
	InviteSingleUserWithBodyWithResponse(ctx context.Context, id int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteSingleUserResponse, error)

	InviteSingleUserWithResponse(ctx context.Context, id int, body InviteSingleUserJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteSingleUserResponse, error)

	// GetUserProfileWithResponse request
	GetUserProfileWithResponse(ctx context.Context, params *GetUserProfileParams, reqEditors ...RequestEditorFn) (*GetUserProfileResponse, error)

	// DeleteUserWithResponse request
	DeleteUserWithResponse(ctx context.Context, id int, params *DeleteUserParams, reqEditors ...RequestEditorFn) (*DeleteUserResponse, error)

	// GetUserWithResponse request
	GetUserWithResponse(ctx context.Context, id int, params *GetUserParams, reqEditors ...RequestEditorFn) (*GetUserResponse, error)

	// UpdateUserWithBodyWithResponse request with any body
	UpdateUserWithBodyWithResponse(ctx context.Context, id int, params *UpdateUserParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error)

	UpdateUserWithResponse(ctx context.Context, id int, params *UpdateUserParams, body UpdateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserResponse, error)
}

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

type CreateAccountJSONRequestBody

type CreateAccountJSONRequestBody = Account

CreateAccountJSONRequestBody defines body for CreateAccount for application/json ContentType.

type CreateAccountResponse

type CreateAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Account *Account `json:"account,omitempty"`
		Success *bool    `json:"success,omitempty"`
	}
	JSONDefault *Error
}

func ParseCreateAccountResponse

func ParseCreateAccountResponse(rsp *http.Response) (*CreateAccountResponse, error)

ParseCreateAccountResponse parses an HTTP response from a CreateAccountWithResponse call

func (CreateAccountResponse) Status

func (r CreateAccountResponse) Status() string

Status returns HTTPResponse.Status

func (CreateAccountResponse) StatusCode

func (r CreateAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateLocationJSONRequestBody

type CreateLocationJSONRequestBody = ScheduleRequest

CreateLocationJSONRequestBody defines body for CreateLocation for application/json ContentType.

type CreateLocationResponse

type CreateLocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Location *Schedule `json:"location,omitempty"`
	}
	JSONDefault *Error
}

func ParseCreateLocationResponse

func ParseCreateLocationResponse(rsp *http.Response) (*CreateLocationResponse, error)

ParseCreateLocationResponse parses an HTTP response from a CreateLocationWithResponse call

func (CreateLocationResponse) Status

func (r CreateLocationResponse) Status() string

Status returns HTTPResponse.Status

func (CreateLocationResponse) StatusCode

func (r CreateLocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrUpdateUserAvatarParams

type CreateOrUpdateUserAvatarParams struct {
	// ContentType The type of content being uploaded
	ContentType string `json:"content-type"`
}

CreateOrUpdateUserAvatarParams defines parameters for CreateOrUpdateUserAvatar.

type CreateOrUpdateUserAvatarResponse

type CreateOrUpdateUserAvatarResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		User *User `json:"user,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseCreateOrUpdateUserAvatarResponse

func ParseCreateOrUpdateUserAvatarResponse(rsp *http.Response) (*CreateOrUpdateUserAvatarResponse, error)

ParseCreateOrUpdateUserAvatarResponse parses an HTTP response from a CreateOrUpdateUserAvatarWithResponse call

func (CreateOrUpdateUserAvatarResponse) Status

Status returns HTTPResponse.Status

func (CreateOrUpdateUserAvatarResponse) StatusCode

func (r CreateOrUpdateUserAvatarResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSiteJSONRequestBody

type CreateSiteJSONRequestBody = SiteRequest

CreateSiteJSONRequestBody defines body for CreateSite for application/json ContentType.

type CreateSiteParams added in v0.7.0

type CreateSiteParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

CreateSiteParams defines parameters for CreateSite.

type CreateSiteResponse

type CreateSiteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Site *Site `json:"site,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseCreateSiteResponse

func ParseCreateSiteResponse(rsp *http.Response) (*CreateSiteResponse, error)

ParseCreateSiteResponse parses an HTTP response from a CreateSiteWithResponse call

func (CreateSiteResponse) Status

func (r CreateSiteResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSiteResponse) StatusCode

func (r CreateSiteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTimeJSONRequestBody

type CreateTimeJSONRequestBody = TimeRequest

CreateTimeJSONRequestBody defines body for CreateTime for application/json ContentType.

type CreateTimeResponse

type CreateTimeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Time *Time `json:"time,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseCreateTimeResponse

func ParseCreateTimeResponse(rsp *http.Response) (*CreateTimeResponse, error)

ParseCreateTimeResponse parses an HTTP response from a CreateTimeWithResponse call

func (CreateTimeResponse) Status

func (r CreateTimeResponse) Status() string

Status returns HTTPResponse.Status

func (CreateTimeResponse) StatusCode

func (r CreateTimeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateUserJSONRequestBody

type CreateUserJSONRequestBody = UserRequest

CreateUserJSONRequestBody defines body for CreateUser for application/json ContentType.

type CreateUserParams added in v0.6.0

type CreateUserParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

CreateUserParams defines parameters for CreateUser.

type CreateUserResponse

type CreateUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		User *User `json:"user,omitempty"`
	}
	JSON401     *Error
	JSON404     *Error
	JSONDefault *Error
}

func ParseCreateUserResponse

func ParseCreateUserResponse(rsp *http.Response) (*CreateUserResponse, error)

ParseCreateUserResponse parses an HTTP response from a CreateUserWithResponse call

func (CreateUserResponse) Status

func (r CreateUserResponse) Status() string

Status returns HTTPResponse.Status

func (CreateUserResponse) StatusCode

func (r CreateUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteLocationParams

type DeleteLocationParams struct {
	// Ids The IDs of the multiple shift templates
	Ids *string `form:"ids,omitempty" json:"ids,omitempty"`
}

DeleteLocationParams defines parameters for DeleteLocation.

type DeleteLocationResponse

type DeleteLocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Success *bool `json:"success,omitempty"`
	}
	JSONDefault *Error
}

func ParseDeleteLocationResponse

func ParseDeleteLocationResponse(rsp *http.Response) (*DeleteLocationResponse, error)

ParseDeleteLocationResponse parses an HTTP response from a DeleteLocationWithResponse call

func (DeleteLocationResponse) Status

func (r DeleteLocationResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteLocationResponse) StatusCode

func (r DeleteLocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteShiftParams

type DeleteShiftParams struct {
	// Message Used to notify the shift's assignee that their shift has been deleted. Your message will be added to the notification email. If you want to send the notification email without a message, simply send a single space. Must be URL encoded.
	Message *string `form:"message,omitempty" json:"message,omitempty"`

	// Chain Only applies to repeating shifts. Any value will delete the shift and all shifts that come after it on the chain.
	Chain *string `form:"chain,omitempty" json:"chain,omitempty"`
}

DeleteShiftParams defines parameters for DeleteShift.

type DeleteShiftResponse

type DeleteShiftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Deleted The IDs of the shifts that were deleted
		Deleted *[]int `json:"deleted,omitempty"`

		// Success Whether deletion was successful. If absent, it means nothing was actually deleted.
		Success *bool `json:"success,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseDeleteShiftResponse

func ParseDeleteShiftResponse(rsp *http.Response) (*DeleteShiftResponse, error)

ParseDeleteShiftResponse parses an HTTP response from a DeleteShiftWithResponse call

func (DeleteShiftResponse) Status

func (r DeleteShiftResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteShiftResponse) StatusCode

func (r DeleteShiftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSiteResponse

type DeleteSiteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Success Whether deletion was successful.
		Success *bool `json:"success,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseDeleteSiteResponse

func ParseDeleteSiteResponse(rsp *http.Response) (*DeleteSiteResponse, error)

ParseDeleteSiteResponse parses an HTTP response from a DeleteSiteWithResponse call

func (DeleteSiteResponse) Status

func (r DeleteSiteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSiteResponse) StatusCode

func (r DeleteSiteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteTimeResponse

type DeleteTimeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Success Whether deletion was successful.
		Success *bool `json:"success,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseDeleteTimeResponse

func ParseDeleteTimeResponse(rsp *http.Response) (*DeleteTimeResponse, error)

ParseDeleteTimeResponse parses an HTTP response from a DeleteTimeWithResponse call

func (DeleteTimeResponse) Status

func (r DeleteTimeResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteTimeResponse) StatusCode

func (r DeleteTimeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteUserParams

type DeleteUserParams struct {
	// DeletedShifts Indicates whether or not to delete this user's future shifts. If not deleted, those shifts will be moved to Open Shifts.
	DeletedShifts *bool `form:"deleted_shifts,omitempty" json:"deleted_shifts,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

DeleteUserParams defines parameters for DeleteUser.

type DeleteUserResponse

type DeleteUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Success *bool `json:"success,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseDeleteUserResponse

func ParseDeleteUserResponse(rsp *http.Response) (*DeleteUserResponse, error)

ParseDeleteUserResponse parses an HTTP response from a DeleteUserWithResponse call

func (DeleteUserResponse) Status

func (r DeleteUserResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteUserResponse) StatusCode

func (r DeleteUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error struct {
	Code    *int                    `json:"code,omitempty"`
	Details *map[string]interface{} `json:"details,omitempty"`
	Error   *string                 `json:"error,omitempty"`
	Message *string                 `json:"message,omitempty"`
}

Error defines model for Error.

type GetAccountResponse

type GetAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Account *Account `json:"account,omitempty"`
	}
	JSONDefault *Error
}

func ParseGetAccountResponse

func ParseGetAccountResponse(rsp *http.Response) (*GetAccountResponse, error)

ParseGetAccountResponse parses an HTTP response from a GetAccountWithResponse call

func (GetAccountResponse) Status

func (r GetAccountResponse) Status() string

Status returns HTTPResponse.Status

func (GetAccountResponse) StatusCode

func (r GetAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationResponse

type GetLocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Location *Schedule `json:"location,omitempty"`
	}
	JSONDefault *Error
}

func ParseGetLocationResponse

func ParseGetLocationResponse(rsp *http.Response) (*GetLocationResponse, error)

ParseGetLocationResponse parses an HTTP response from a GetLocationWithResponse call

func (GetLocationResponse) Status

func (r GetLocationResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationResponse) StatusCode

func (r GetLocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetShiftHistoryParams

type GetShiftHistoryParams struct {
	// IncludeDeleted Flag to indicate if you want to search for a deleted shift's history (off by default)
	IncludeDeleted *bool `form:"include_deleted,omitempty" json:"include_deleted,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

GetShiftHistoryParams defines parameters for GetShiftHistory.

type GetShiftHistoryResponse

type GetShiftHistoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// History Array of history events
		History *[]ShiftHistory `json:"history,omitempty"`
		Shift   *Shift          `json:"shift,omitempty"`
	}
	JSONDefault *Error
}

func ParseGetShiftHistoryResponse

func ParseGetShiftHistoryResponse(rsp *http.Response) (*GetShiftHistoryResponse, error)

ParseGetShiftHistoryResponse parses an HTTP response from a GetShiftHistoryWithResponse call

func (GetShiftHistoryResponse) Status

func (r GetShiftHistoryResponse) Status() string

Status returns HTTPResponse.Status

func (GetShiftHistoryResponse) StatusCode

func (r GetShiftHistoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetShiftParams

type GetShiftParams struct {
	// IncludeRepeatingShiftsTo End date to include repeating shifts in series, if applicable
	IncludeRepeatingShiftsTo *WIWTime `form:"include_repeating_shifts_to,omitempty" json:"include_repeating_shifts_to,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

GetShiftParams defines parameters for GetShift.

type GetShiftResponse

type GetShiftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// RepeatingShifts This field will be present if the `include_repeating_shifts_to` parameter is provided. If the fetched shift has a shift chain, we will insert all the shifts on that chain from the first up to the date specified in the parameter.
		RepeatingShifts *[]Shift `json:"repeating_shifts,omitempty"`
		Shift           *Shift   `json:"shift,omitempty"`

		// Shiftchains Any shift chain this shift is a part of
		Shiftchains *[]ShiftChain `json:"shiftchains,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseGetShiftResponse

func ParseGetShiftResponse(rsp *http.Response) (*GetShiftResponse, error)

ParseGetShiftResponse parses an HTTP response from a GetShiftWithResponse call

func (GetShiftResponse) Status

func (r GetShiftResponse) Status() string

Status returns HTTPResponse.Status

func (GetShiftResponse) StatusCode

func (r GetShiftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSiteResponse

type GetSiteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Site *Site `json:"site,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseGetSiteResponse

func ParseGetSiteResponse(rsp *http.Response) (*GetSiteResponse, error)

ParseGetSiteResponse parses an HTTP response from a GetSiteWithResponse call

func (GetSiteResponse) Status

func (r GetSiteResponse) Status() string

Status returns HTTPResponse.Status

func (GetSiteResponse) StatusCode

func (r GetSiteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSwapUsers200Users0

type GetSwapUsers200Users0 = []User

type GetSwapUsers200Users1

type GetSwapUsers200Users1 = []string

type GetSwapUsersParams

type GetSwapUsersParams struct {
	// Id The ID of the shift being dropped
	Id *int `form:"id,omitempty" json:"id,omitempty"`

	// Count Flag to indicate if only a count of eligible takers should be returned
	Count *int `form:"count,omitempty" json:"count,omitempty"`

	// IdsOnly Flag to indicate if only the IDs of the eligible takers should be returned
	IdsOnly *int `form:"ids_only,omitempty" json:"ids_only,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

GetSwapUsersParams defines parameters for GetSwapUsers.

type GetSwapUsersResponse

type GetSwapUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// CanRelease Indicates if this shift can be released
		CanRelease *bool `json:"can_release,omitempty"`

		// Count A count of all the eligible takers
		Count *int                    `json:"count,omitempty"`
		Users *GetSwapUsers_200_Users `json:"users,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseGetSwapUsersResponse

func ParseGetSwapUsersResponse(rsp *http.Response) (*GetSwapUsersResponse, error)

ParseGetSwapUsersResponse parses an HTTP response from a GetSwapUsersWithResponse call

func (GetSwapUsersResponse) Status

func (r GetSwapUsersResponse) Status() string

Status returns HTTPResponse.Status

func (GetSwapUsersResponse) StatusCode

func (r GetSwapUsersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSwapUsers_200_Users

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

type GetTimeResponse

type GetTimeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Time *Time `json:"time,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseGetTimeResponse

func ParseGetTimeResponse(rsp *http.Response) (*GetTimeResponse, error)

ParseGetTimeResponse parses an HTTP response from a GetTimeWithResponse call

func (GetTimeResponse) Status

func (r GetTimeResponse) Status() string

Status returns HTTPResponse.Status

func (GetTimeResponse) StatusCode

func (r GetTimeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserParams added in v0.6.0

type GetUserParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

GetUserParams defines parameters for GetUser.

type GetUserProfileParams added in v0.6.0

type GetUserProfileParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

GetUserProfileParams defines parameters for GetUserProfile.

type GetUserProfileResponse

type GetUserProfileResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		User *User `json:"user,omitempty"`
	}
	JSON401     *Error
	JSON404     *Error
	JSONDefault *Error
}

func ParseGetUserProfileResponse

func ParseGetUserProfileResponse(rsp *http.Response) (*GetUserProfileResponse, error)

ParseGetUserProfileResponse parses an HTTP response from a GetUserProfileWithResponse call

func (GetUserProfileResponse) Status

func (r GetUserProfileResponse) Status() string

Status returns HTTPResponse.Status

func (GetUserProfileResponse) StatusCode

func (r GetUserProfileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserResponse

type GetUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		User *User `json:"user,omitempty"`
	}
	JSON401     *Error
	JSON404     *Error
	JSONDefault *Error
}

func ParseGetUserResponse

func ParseGetUserResponse(rsp *http.Response) (*GetUserResponse, error)

ParseGetUserResponse parses an HTTP response from a GetUserWithResponse call

func (GetUserResponse) Status

func (r GetUserResponse) Status() string

Status returns HTTPResponse.Status

func (GetUserResponse) StatusCode

func (r GetUserResponse) 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 InviteSingleUserJSONBody

type InviteSingleUserJSONBody struct {
	// Message An optional message to include in the email invite.
	Message *string `json:"message,omitempty"`
}

InviteSingleUserJSONBody defines parameters for InviteSingleUser.

type InviteSingleUserJSONRequestBody

type InviteSingleUserJSONRequestBody InviteSingleUserJSONBody

InviteSingleUserJSONRequestBody defines body for InviteSingleUser for application/json ContentType.

type InviteSingleUserResponse

type InviteSingleUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InviteUserResponse
	JSONDefault  *Error
}

func ParseInviteSingleUserResponse

func ParseInviteSingleUserResponse(rsp *http.Response) (*InviteSingleUserResponse, error)

ParseInviteSingleUserResponse parses an HTTP response from a InviteSingleUserWithResponse call

func (InviteSingleUserResponse) Status

func (r InviteSingleUserResponse) Status() string

Status returns HTTPResponse.Status

func (InviteSingleUserResponse) StatusCode

func (r InviteSingleUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InviteUserRequest

type InviteUserRequest struct {
	// Ids List of existing user IDs to invite.
	Ids *[]int `json:"ids,omitempty"`

	// Message An optional message to include in the email invite.
	Message *string `json:"message,omitempty"`

	// SendAll Whether to invite all users who do not currently have a login/person. If this is true, the ids parameter will be ignored. Defaults to false.
	SendAll *bool `json:"send_all,omitempty"`
}

InviteUserRequest defines model for InviteUserRequest.

type InviteUserResponse

type InviteUserResponse struct {
	// Count The total number of invites sent.
	Count *int `json:"count,omitempty"`

	// Email The total number of invites sent via email.
	Email *int `json:"email,omitempty"`

	// Sms The total number of invites sent via text message.
	Sms *int `json:"sms,omitempty"`

	// Success True if at least one invite was sent.
	Success *bool `json:"success,omitempty"`
}

InviteUserResponse Valid

type InviteUsersJSONRequestBody

type InviteUsersJSONRequestBody = InviteUserRequest

InviteUsersJSONRequestBody defines body for InviteUsers for application/json ContentType.

type InviteUsersResponse

type InviteUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InviteUserResponse
	JSONDefault  *Error
}

func ParseInviteUsersResponse

func ParseInviteUsersResponse(rsp *http.Response) (*InviteUsersResponse, error)

ParseInviteUsersResponse parses an HTTP response from a InviteUsersWithResponse call

func (InviteUsersResponse) Status

func (r InviteUsersResponse) Status() string

Status returns HTTPResponse.Status

func (InviteUsersResponse) StatusCode

func (r InviteUsersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListEligibleUsersForOpenShiftParams

type ListEligibleUsersForOpenShiftParams struct {
	// Id The ID of the shift
	Id *int `form:"id,omitempty" json:"id,omitempty"`

	// Start Start time of the potential shift (required if Shift ID not present)
	Start *WIWTime `form:"start,omitempty" json:"start,omitempty"`

	// End End time of the potential shift (required if Shift ID not present)
	End *WIWTime `form:"end,omitempty" json:"end,omitempty"`

	// PositionId Position ID of the potential shift (required if Shift ID not present)
	PositionId *string `form:"position_id,omitempty" json:"position_id,omitempty"`

	// LocationId Location ID of the potential shift (required if Shift ID not present)
	LocationId *string `form:"location_id,omitempty" json:"location_id,omitempty"`

	// IsShared Is the shift a shared OpenShift
	IsShared *bool `form:"is_shared,omitempty" json:"is_shared,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

ListEligibleUsersForOpenShiftParams defines parameters for ListEligibleUsersForOpenShift.

type ListEligibleUsersForOpenShiftResponse

type ListEligibleUsersForOpenShiftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Users *[]User `json:"users,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseListEligibleUsersForOpenShiftResponse

func ParseListEligibleUsersForOpenShiftResponse(rsp *http.Response) (*ListEligibleUsersForOpenShiftResponse, error)

ParseListEligibleUsersForOpenShiftResponse parses an HTTP response from a ListEligibleUsersForOpenShiftWithResponse call

func (ListEligibleUsersForOpenShiftResponse) Status

Status returns HTTPResponse.Status

func (ListEligibleUsersForOpenShiftResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ListLocationsParams

type ListLocationsParams struct {
	// OnlyUnconfirmed Include only unconfirmed schedules/locations
	OnlyUnconfirmed *bool `form:"only_unconfirmed,omitempty" json:"only_unconfirmed,omitempty"`
}

ListLocationsParams defines parameters for ListLocations.

type ListLocationsResponse

type ListLocationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Locations *[]Schedule `json:"locations,omitempty"`
	}
	JSONDefault *Error
}

func ParseListLocationsResponse

func ParseListLocationsResponse(rsp *http.Response) (*ListLocationsResponse, error)

ParseListLocationsResponse parses an HTTP response from a ListLocationsWithResponse call

func (ListLocationsResponse) Status

func (r ListLocationsResponse) Status() string

Status returns HTTPResponse.Status

func (ListLocationsResponse) StatusCode

func (r ListLocationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListShiftsParams

type ListShiftsParams struct {
	// UserId The user id to filter by
	UserId *int `form:"user_id,omitempty" json:"user_id,omitempty"`

	// Start The start of the filter range.
	Start *WIWTime `form:"start,omitempty" json:"start,omitempty"`

	// End The end of the filter range.
	End *WIWTime `form:"end,omitempty" json:"end,omitempty"`

	// Unpublished Whether or not to include unpublished shifts. Requires supervisor rights.
	Unpublished *bool `form:"unpublished,omitempty" json:"unpublished,omitempty"`

	// IncludeOpen Whether or not to include open shifts from the user's assigned Schedules.
	IncludeOpen *bool `form:"include_open,omitempty" json:"include_open,omitempty"`

	// IncludeOnlyopen Whether or not to include only open shifts from the user's assigned Schedules.
	IncludeOnlyopen *bool `form:"include_onlyopen,omitempty" json:"include_onlyopen,omitempty"`

	// IncludeAllopen Whether to include open shifts across All Schedules. Requires "Manager or Admin access" level.
	IncludeAllopen *bool `form:"include_allopen,omitempty" json:"include_allopen,omitempty"`

	// Deleted Whether to include a list of shift IDs ("deleted_ids") that were deleted during the passed time window.
	Deleted *bool `form:"deleted,omitempty" json:"deleted,omitempty"`

	// IncludeSwaps Whether or not to include swap requests.
	IncludeSwaps *bool `form:"include_swaps,omitempty" json:"include_swaps,omitempty"`

	// Limit Maximum number of results to return.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// AllLocations Whether to include data from all locations. Shifts are marked as "readonly" if not a manager user.
	AllLocations *bool `form:"all_locations,omitempty" json:"all_locations,omitempty"`

	// LocationId One or more location IDs by which to limit results
	LocationId *string `form:"location_id,omitempty" json:"location_id,omitempty"`

	// ShiftSort True to sort results by user_id, false to sort by shift time. Missing for default sort
	ShiftSort *bool `form:"shift_sort,omitempty" json:"shift_sort,omitempty"`

	// IncludeRepeatingShiftsTo End date to include repeating shifts in series, if applicable
	IncludeRepeatingShiftsTo *WIWTime `form:"include_repeating_shifts_to,omitempty" json:"include_repeating_shifts_to,omitempty"`

	// TrimOpenshifts Setting to true will work w/ the Allow Partial Openshifts feature to display trimmed start/end times for
	// users that can take a conflicting openshift based on the account settings.
	TrimOpenshifts *bool `form:"trim_openshifts,omitempty" json:"trim_openshifts,omitempty"`

	// LimitByRules Setting to true will work w/ the Scheduling Rules feature to only return OpenShifts that the requester is eligible for
	// according to the scheduling rules settings for the account.
	LimitByRules *bool `form:"limit_by_rules,omitempty" json:"limit_by_rules,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

ListShiftsParams defines parameters for ListShifts.

type ListShiftsResponse

type ListShiftsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Locations *[]Schedule `json:"locations,omitempty"`
		Positions *[]Position `json:"positions,omitempty"`

		// RepeatingShifts This field will be present if the `include_repeating_shifts_to` parameter is provided. For each
		// fetched shift, if it is on a shift chain, we will insert all the shifts on that chain from the
		// first up to the date specified in the parameter.
		RepeatingShifts *[]Shift `json:"repeating_shifts,omitempty"`

		// Shiftchains Any shift chains that the fetched shifts are a part of
		Shiftchains *[]ShiftChain `json:"shiftchains,omitempty"`
		Shifts      *[]Shift      `json:"shifts,omitempty"`
		Sites       *[]Site       `json:"sites,omitempty"`
		Users       *[]User       `json:"users,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseListShiftsResponse

func ParseListShiftsResponse(rsp *http.Response) (*ListShiftsResponse, error)

ParseListShiftsResponse parses an HTTP response from a ListShiftsWithResponse call

func (ListShiftsResponse) Status

func (r ListShiftsResponse) Status() string

Status returns HTTPResponse.Status

func (ListShiftsResponse) StatusCode

func (r ListShiftsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSitesParams

type ListSitesParams struct {
	// IncludeDeleted Include deleted sites
	IncludeDeleted *bool `form:"include_deleted,omitempty" json:"include_deleted,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

ListSitesParams defines parameters for ListSites.

type ListSitesResponse

type ListSitesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Sites *[]Site `json:"sites,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseListSitesResponse

func ParseListSitesResponse(rsp *http.Response) (*ListSitesResponse, error)

ParseListSitesResponse parses an HTTP response from a ListSitesWithResponse call

func (ListSitesResponse) Status

func (r ListSitesResponse) Status() string

Status returns HTTPResponse.Status

func (ListSitesResponse) StatusCode

func (r ListSitesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTimesParams

type ListTimesParams struct {
	// Start The start of the filter range.
	Start *WIWTime `form:"start,omitempty" json:"start,omitempty"`

	// End The end of the filter range.
	End *WIWTime `form:"end,omitempty" json:"end,omitempty"`

	// UserId List of user ids to filter on
	UserId *string `form:"user_id,omitempty" json:"user_id,omitempty"`

	// OnlyOpen Return only times without an end time
	OnlyOpen *bool `form:"only_open,omitempty" json:"only_open,omitempty"`

	// UpdatedAt Only return times that have been updated since the provided timestamp.
	UpdatedAt *WIWTime `form:"updated_at,omitempty" json:"updated_at,omitempty"`

	// OverwriteWithRounded Flag to overwrite the start/end/length values with their rounded counterparts (if account setting is enabled)
	OverwriteWithRounded *int `form:"overwrite_with_rounded,omitempty" json:"overwrite_with_rounded,omitempty"`

	// IncludePaidBreakNote Returns the note for a Shift Break Paid Record. Deprecated - please refer to the break attestation docs [here](#tag/Break-Attestation)
	IncludePaidBreakNote *bool `form:"include_paid_break_note,omitempty" json:"include_paid_break_note,omitempty"`
}

ListTimesParams defines parameters for ListTimes.

type ListTimesResponse

type ListTimesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Times *[]Time `json:"times,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseListTimesResponse

func ParseListTimesResponse(rsp *http.Response) (*ListTimesResponse, error)

ParseListTimesResponse parses an HTTP response from a ListTimesWithResponse call

func (ListTimesResponse) Status

func (r ListTimesResponse) Status() string

Status returns HTTPResponse.Status

func (ListTimesResponse) StatusCode

func (r ListTimesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListUsersParams

type ListUsersParams struct {
	// LocationId One or more location IDs by which to limit results
	LocationId *[]int `form:"location_id,omitempty" json:"location_id,omitempty"`

	// ShowPending Include pending users in results. Defaults to true.
	ShowPending *bool `form:"show_pending,omitempty" json:"show_pending,omitempty"`

	// OnlyPending Include ONLY pending users in results. Defaults to false.
	OnlyPending *bool `form:"only_pending,omitempty" json:"only_pending,omitempty"`

	// ShowDeleted Include deleted users in results. Defaults to false.
	ShowDeleted *bool `form:"show_deleted,omitempty" json:"show_deleted,omitempty"`

	// OnlyDeleted Only include deleted/archived users in results. Defaults to false.
	OnlyDeleted *bool `form:"only_deleted,omitempty" json:"only_deleted,omitempty"`

	// Search Optional string to search by in users first name, last name, or email.
	Search *string `form:"search,omitempty" json:"search,omitempty"`

	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

ListUsersParams defines parameters for ListUsers.

type ListUsersResponse

type ListUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Users *[]User `json:"users,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseListUsersResponse

func ParseListUsersResponse(rsp *http.Response) (*ListUsersResponse, error)

ParseListUsersResponse parses an HTTP response from a ListUsersWithResponse call

func (ListUsersResponse) Status

func (r ListUsersResponse) Status() string

Status returns HTTPResponse.Status

func (ListUsersResponse) StatusCode

func (r ListUsersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Login

type Login struct {
	Avatar *struct {
		Size *string `json:"size,omitempty"`
		Url  *string `json:"url,omitempty"`
	} `json:"avatar,omitempty"`
	CreatedAt *WIWTime             `json:"created_at,omitempty"`
	Email     *openapi_types.Email `json:"email,omitempty"`
	FirstName *string              `json:"first_name,omitempty"`
	Id        *int                 `json:"id,omitempty"`
	LastName  *string              `json:"last_name,omitempty"`
	Name      *string              `json:"name,omitempty"`
	Token     *string              `json:"token,omitempty"`
	UpdatedAt *WIWTime             `json:"updated_at,omitempty"`
}

Login defines model for Login.

type LoginJSONBody

type LoginJSONBody struct {
	Email    *string `json:"email,omitempty"`
	Password *string `json:"password,omitempty"`
}

LoginJSONBody defines parameters for Login.

type LoginJSONRequestBody

type LoginJSONRequestBody LoginJSONBody

LoginJSONRequestBody defines body for Login for application/json ContentType.

type LoginParams

type LoginParams struct {
	// WKey The developer key
	WKey string `json:"W-Key"`

	// WUserID The user id
	WUserID *string `json:"W-UserID,omitempty"`
}

LoginParams defines parameters for Login.

type LoginResponse

type LoginResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Accounts *[]Account `json:"accounts,omitempty"`
		Login    *Login     `json:"login,omitempty"`
		Token    *string    `json:"token,omitempty"`
		Users    *[]User    `json:"users,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseLoginResponse

func ParseLoginResponse(rsp *http.Response) (*LoginResponse, error)

ParseLoginResponse parses an HTTP response from a LoginWithResponse call

func (LoginResponse) Status

func (r LoginResponse) Status() string

Status returns HTTPResponse.Status

func (LoginResponse) StatusCode

func (r LoginResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NotifyShiftsJSONRequestBody

type NotifyShiftsJSONRequestBody = ShiftNotifyRequest

NotifyShiftsJSONRequestBody defines body for NotifyShifts for application/json ContentType.

type NotifyShiftsParams added in v0.7.0

type NotifyShiftsParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

NotifyShiftsParams defines parameters for NotifyShifts.

type NotifyShiftsResponse

type NotifyShiftsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Email A count of the emails sent.
		Email *int `json:"email,omitempty"`

		// Sms A count of the SMS and/or push notifications (depending on user preferences) sent.
		Sms     *int  `json:"sms,omitempty"`
		Success *bool `json:"success,omitempty"`
	}
	JSONDefault *Error
}

func ParseNotifyShiftsResponse

func ParseNotifyShiftsResponse(rsp *http.Response) (*NotifyShiftsResponse, error)

ParseNotifyShiftsResponse parses an HTTP response from a NotifyShiftsWithResponse call

func (NotifyShiftsResponse) Status

func (r NotifyShiftsResponse) Status() string

Status returns HTTPResponse.Status

func (NotifyShiftsResponse) StatusCode

func (r NotifyShiftsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NotifySingleShiftJSONRequestBody

type NotifySingleShiftJSONRequestBody = SingleShiftNotifyRequest

NotifySingleShiftJSONRequestBody defines body for NotifySingleShift for application/json ContentType.

type NotifySingleShiftParams added in v0.7.0

type NotifySingleShiftParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

NotifySingleShiftParams defines parameters for NotifySingleShift.

type NotifySingleShiftResponse

type NotifySingleShiftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Email A count of the emails sent.
		Email *int `json:"email,omitempty"`

		// Sms A count of the SMS and/or push notifications (depending on user preferences) sent.
		Sms     *int  `json:"sms,omitempty"`
		Success *bool `json:"success,omitempty"`
	}
	JSONDefault *Error
}

func ParseNotifySingleShiftResponse

func ParseNotifySingleShiftResponse(rsp *http.Response) (*NotifySingleShiftResponse, error)

ParseNotifySingleShiftResponse parses an HTTP response from a NotifySingleShiftWithResponse call

func (NotifySingleShiftResponse) Status

func (r NotifySingleShiftResponse) Status() string

Status returns HTTPResponse.Status

func (NotifySingleShiftResponse) StatusCode

func (r NotifySingleShiftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type OpenShiftApprovalRequest

type OpenShiftApprovalRequest struct {
	// ApprovedAt The date and time when the OpenShift Approval request was approved
	ApprovedAt *WIWTime `json:"approved_at,omitempty"`

	// ApprovedBy The ID of the user who approved the OpenShift Approval request
	ApprovedBy *int `json:"approved_by,omitempty"`

	// Id The ID of the OpenShift Approval request
	Id *int `json:"id,omitempty"`

	// IsApproved Whether the OpenShift Approval request is approved
	IsApproved *bool `json:"is_approved,omitempty"`

	// Notes Notes about the OpenShift Approval request
	Notes *string `json:"notes,omitempty"`

	// ShiftId The ID of the shift associated with the OpenShift Approval request
	ShiftId *int `json:"shift_id,omitempty"`

	// UserId The ID of the user associated with the OpenShift Approval request
	UserId *int `json:"user_id,omitempty"`
}

OpenShiftApprovalRequest defines model for OpenShiftApprovalRequest.

type Place

type Place struct {
	Address      *string   `json:"address,omitempty"`
	BusinessName *string   `json:"business_name,omitempty"`
	Country      *string   `json:"country,omitempty"`
	Id           *int      `json:"id,omitempty"`
	Latitude     *float32  `json:"latitude,omitempty"`
	Locality     *string   `json:"locality,omitempty"`
	Longitude    *float32  `json:"longitude,omitempty"`
	PlaceId      *string   `json:"place_id,omitempty"`
	PlaceType    *[]string `json:"place_type,omitempty"`
	PostalCode   *string   `json:"postal_code,omitempty"`
	Region       *string   `json:"region,omitempty"`
	StreetName   *string   `json:"street_name,omitempty"`
	StreetNumber *string   `json:"street_number,omitempty"`
	SubLocality  *string   `json:"sub_locality,omitempty"`
	UpdatedAt    *WIWTime  `json:"updated_at,omitempty"`
}

Place defines model for Place.

type Position added in v0.7.0

type Position struct {
	AccountId *int     `json:"account_id,omitempty"`
	Color     *string  `json:"color,omitempty"`
	CreatedAt *WIWTime `json:"created_at,omitempty"`
	Id        *int     `json:"id,omitempty"`
	Name      *string  `json:"name,omitempty"`

	// Sort Custom sort order applied to this position
	Sort *int `json:"sort,omitempty"`

	// TipsTracking Whether this position tracks tips.
	// Note: the tips feature is needed to use this field.
	TipsTracking *bool    `json:"tips_tracking,omitempty"`
	UpdatedAt    *WIWTime `json:"updated_at,omitempty"`
}

Position defines model for Position.

type PublishShiftsJSONRequestBody

type PublishShiftsJSONRequestBody = ShiftPublish

PublishShiftsJSONRequestBody defines body for PublishShifts for application/json ContentType.

type PublishShiftsParams added in v0.7.0

type PublishShiftsParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

PublishShiftsParams defines parameters for PublishShifts.

type PublishShiftsResponse

type PublishShiftsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Shifts *[]Shift `json:"shifts,omitempty"`
	}
	JSONDefault *Error
}

func ParsePublishShiftsResponse

func ParsePublishShiftsResponse(rsp *http.Response) (*PublishShiftsResponse, error)

ParsePublishShiftsResponse parses an HTTP response from a PublishShiftsWithResponse call

func (PublishShiftsResponse) Status

func (r PublishShiftsResponse) Status() string

Status returns HTTPResponse.Status

func (PublishShiftsResponse) StatusCode

func (r PublishShiftsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Schedule

type Schedule struct {
	AccountId      *int       `json:"account_id,omitempty"`
	Address        *string    `json:"address,omitempty"`
	Coordinates    *[]float32 `json:"coordinates,omitempty"`
	CreatedAt      *WIWTime   `json:"created_at,omitempty"`
	DeletedAt      *WIWTime   `json:"deleted_at,omitempty"`
	Id             *int       `json:"id,omitempty"`
	IpAddress      *string    `json:"ip_address,omitempty"`
	IsDefault      *int       `json:"is_default,omitempty"`
	IsDeleted      *bool      `json:"is_deleted,omitempty"`
	Latitude       *float32   `json:"latitude,omitempty"`
	Longitude      *float32   `json:"longitude,omitempty"`
	MaxHours       *int       `json:"max_hours,omitempty"`
	Name           *string    `json:"name,omitempty"`
	Place          *Place     `json:"place,omitempty"`
	PlaceConfirmed *bool      `json:"place_confirmed,omitempty"`
	PlaceId        *int       `json:"place_id,omitempty"`
	Radius         *int       `json:"radius,omitempty"`
	Sort           *int       `json:"sort,omitempty"`
	UpdatedAt      *WIWTime   `json:"updated_at,omitempty"`
}

Schedule defines model for Schedule.

type ScheduleRequest

type ScheduleRequest struct {
	AccountId      *int       `json:"account_id,omitempty"`
	Address        *string    `json:"address,omitempty"`
	Coordinates    *[]float32 `json:"coordinates,omitempty"`
	IpAddress      *string    `json:"ip_address,omitempty"`
	IsDefault      *bool      `json:"is_default,omitempty"`
	Latitude       *float32   `json:"latitude,omitempty"`
	Longitude      *float32   `json:"longitude,omitempty"`
	MaxHours       *int       `json:"max_hours,omitempty"`
	Name           *string    `json:"name,omitempty"`
	Place          *Place     `json:"place,omitempty"`
	PlaceConfirmed *bool      `json:"place_confirmed,omitempty"`
	PlaceId        *string    `json:"place_id,omitempty"`
	Radius         *int       `json:"radius,omitempty"`
	Sort           *int       `json:"sort,omitempty"`
}

ScheduleRequest defines model for ScheduleRequest.

type Shift

type Shift struct {
	AccountId int `json:"account_id"`

	// Acknowledged If enabled; When the user confirmed the shift
	Acknowledged *int `json:"acknowledged,omitempty"`

	// AcknowledgedAt If enabled; When the user confirmed the shift
	AcknowledgedAt *WIWTime `json:"acknowledged_at,omitempty"`

	// Alerted Is the shift Alert sent
	Alerted *bool `json:"alerted,omitempty"`

	// BreakTime Length of the unpaid breaks for the shift in hours.
	BreakTime *float32 `json:"break_time,omitempty"`

	// Breaks An array of breaks for the shift. When updating a shift, any existing breaks for the shift that are not included in the request will be deleted.
	Breaks *[]ShiftScheduledBreak `json:"breaks,omitempty"`

	// Color Assign color to shift
	Color     *string  `json:"color,omitempty"`
	CreatedAt *WIWTime `json:"created_at,omitempty"`

	// CreatorId The user that created the shift
	CreatorId *int    `json:"creator_id,omitempty"`
	EndTime   WIWTime `json:"end_time"`
	Id        *int    `json:"id,omitempty"`
	Instances *int    `json:"instances,omitempty"`

	// IsApprovedWithoutTime Used to indicate that a manager or supervisor has approved a missing time entry for this shift
	IsApprovedWithoutTime *bool `json:"is_approved_without_time,omitempty"`
	IsOpen                *bool `json:"is_open,omitempty"`

	// IsShared Is the shift a shared OpenShift
	IsShared *bool `json:"is_shared,omitempty"`

	// IsTrimmed Is rounding active for shift
	IsTrimmed *bool `json:"is_trimmed,omitempty"`

	// LinkedUsers Array of user IDs that can take this openshift. Null means all users are eligible.
	LinkedUsers *[]int `json:"linked_users,omitempty"`

	// LocationId Location the shift belongs to
	LocationId int `json:"location_id"`

	// Notes Text notation for a Shift
	Notes      *string  `json:"notes,omitempty"`
	NotifiedAt *WIWTime `json:"notified_at,omitempty"`

	// OpenshiftApprovalRequestId ID of the associated OpenShift Approval request
	OpenshiftApprovalRequestId *int `json:"openshift_approval_request_id,omitempty"`
	PositionId                 *int `json:"position_id,omitempty"`

	// Published Is the shift published
	Published     *bool    `json:"published,omitempty"`
	PublishedDate *WIWTime `json:"published_date,omitempty"`

	// RequiresOpenshiftApproval Does this shift require OpenShift Approval
	RequiresOpenshiftApproval *bool `json:"requires_openshift_approval,omitempty"`

	// ShiftchainKey The ID to associate shifts in a repeating pattern
	ShiftchainKey *string  `json:"shiftchain_key,omitempty"`
	SiteId        *int     `json:"site_id,omitempty"`
	StartTime     WIWTime  `json:"start_time"`
	UpdatedAt     *WIWTime `json:"updated_at,omitempty"`

	// UserId The user assigned to the shift. Set to `0` for an Open Shift.
	UserId int `json:"user_id"`
}

Shift defines model for Shift.

type ShiftAssignRequest

type ShiftAssignRequest struct {
	// ShiftIds Array of shift IDs
	ShiftIds *[]string `json:"shift_ids,omitempty"`
}

ShiftAssignRequest defines model for ShiftAssignRequest.

type ShiftBulk

type ShiftBulk struct {
	AccountId *int     `json:"account_id,omitempty"`
	BreakTime *float32 `json:"break_time,omitempty"`

	// Color Assign color to shift
	Color   *string `json:"color,omitempty"`
	EndTime WIWTime `json:"end_time"`
	Id      int     `json:"id"`

	// LinkedUsers Array of user IDs that can take this openshift. Null means all users are eligible.
	LinkedUsers *[]int `json:"linked_users,omitempty"`

	// LocationId Location the shift belongs to
	LocationId int `json:"location_id"`

	// Notes Text notation for a Shift
	Notes      *string `json:"notes,omitempty"`
	PositionId *int    `json:"position_id,omitempty"`
	SiteId     *int    `json:"site_id,omitempty"`
	StartTime  WIWTime `json:"start_time"`

	// UserId The user assigned to the shift. Set to `0` for an Open Shift.
	UserId *int `json:"user_id,omitempty"`
}

ShiftBulk defines model for ShiftBulk.

type ShiftChain

type ShiftChain struct {
	// Count The number of shifts created by this chain.
	// Deprecated:
	Count *int    `json:"count,omitempty"`
	Key   *string `json:"key,omitempty"`

	// Rrule The RFC5545-compliant RRule representing the shift chain.
	Rrule *string `json:"rrule,omitempty"`

	// TimezoneId The timezone this chain is built in
	TimezoneId *string `json:"timezone_id,omitempty"`

	// Until The date when the shift chain ends.
	Until *openapi_types.Date `json:"until,omitempty"`

	// Week Represents the week frequency interval. `1` means weekly, `2` means every two weeks, etc.
	Week *int `json:"week,omitempty"`

	// Weekdays A bitmask of the weekdays which shifts in this chain occur on. In a seven-bit binary number, the most
	// significant bit represents Sunday and the least significant bit represents Monday (0b1000001).
	//
	// Examples:
	// | Days                      | Binary      | Decimal |
	// |---------------------------|-------------|---------|
	// | Monday through Friday     | `0b0011111` | 31      |
	// | Monday, Wednesday, Friday | `0b0010101` | 21      |
	// | Saturday and Sunday       | `0b1100000` | 96      |
	Weekdays *int `json:"weekdays,omitempty"`
}

ShiftChain defines model for ShiftChain.

type ShiftHistory

type ShiftHistory struct {
	Attributes *struct {
		// Actor The name of the user that triggered this shift history event
		Actor string `json:"actor"`

		// At The timestamp of when this shift history event was recorded
		At WIWTime `json:"at"`

		// Break Present in `created`, `current`, `break_changed` and `break_removed` events . The new value of shift break.
		Break *float32 `json:"break,omitempty"`

		// End Present in `current`, `created`, and `time_changed` events. The new end time.
		End *WIWTime `json:"end,omitempty"`

		// Position Present in `current`, `created`, `position_changed` and `position_removed` events. The new position.
		Position *string `json:"position,omitempty"`

		// Reason A reason code to provide additional context for why a shift history event was recorded
		Reason *ShiftHistoryAttributesReason `json:"reason,omitempty"`

		// Site Present in `current`, `created`, `site_changed` and `site_removed` events. The new site.
		Site *string `json:"site,omitempty"`

		// Start Present in `current`, `created`, and `time_changed` events. The new start time.
		Start *WIWTime `json:"start,omitempty"`

		// User Present in `current`, `created`, `reassigned`, `taken`, `accepted` and `released` events. The new user assigned to the shift.
		User *string `json:"user,omitempty"`
	} `json:"attributes,omitempty"`

	// Type The type of history event
	Type *ShiftHistoryType `json:"type,omitempty"`
}

ShiftHistory defines model for ShiftHistory.

type ShiftHistoryAttributesReason

type ShiftHistoryAttributesReason string

ShiftHistoryAttributesReason A reason code to provide additional context for why a shift history event was recorded

const (
	Assign                     ShiftHistoryAttributesReason = "assign"
	AssignApprove              ShiftHistoryAttributesReason = "assign-approve"
	CreatedFromRepeatingSeries ShiftHistoryAttributesReason = "created-from-repeating-series"
	Delete                     ShiftHistoryAttributesReason = "delete"
	DeleteBulk                 ShiftHistoryAttributesReason = "delete-bulk"
	DeleteClear                ShiftHistoryAttributesReason = "delete-clear"
	DeletedAssignedUser        ShiftHistoryAttributesReason = "deleted-assigned-user"
	Drop                       ShiftHistoryAttributesReason = "drop"
	Edit                       ShiftHistoryAttributesReason = "edit"
	OverwriteConflictsDelete   ShiftHistoryAttributesReason = "overwrite-conflicts-delete"
	Publish                    ShiftHistoryAttributesReason = "publish"
	RepeatingDelete            ShiftHistoryAttributesReason = "repeating-delete"
	Split                      ShiftHistoryAttributesReason = "split"
	Swap                       ShiftHistoryAttributesReason = "swap"
	Take                       ShiftHistoryAttributesReason = "take"
	Unpublish                  ShiftHistoryAttributesReason = "unpublish"
	UpdatedFromRepeatingSeries ShiftHistoryAttributesReason = "updated-from-repeating-series"
	UserRemovedFromSchedule    ShiftHistoryAttributesReason = "user-removed-from-schedule"
)

Defines values for ShiftHistoryAttributesReason.

type ShiftHistoryType

type ShiftHistoryType string

ShiftHistoryType The type of history event

const (
	Accepted        ShiftHistoryType = "accepted"
	BreakChanged    ShiftHistoryType = "break_changed"
	BreakRemoved    ShiftHistoryType = "break_removed"
	Confirmed       ShiftHistoryType = "confirmed"
	Created         ShiftHistoryType = "created"
	Current         ShiftHistoryType = "current"
	Deleted         ShiftHistoryType = "deleted"
	LocationChanged ShiftHistoryType = "location_changed"
	PositionChanged ShiftHistoryType = "position_changed"
	PositionRemoved ShiftHistoryType = "position_removed"
	Published       ShiftHistoryType = "published"
	Reassigned      ShiftHistoryType = "reassigned"
	Released        ShiftHistoryType = "released"
	SiteChanged     ShiftHistoryType = "site_changed"
	SiteRemoved     ShiftHistoryType = "site_removed"
	Taken           ShiftHistoryType = "taken"
	TimeChanged     ShiftHistoryType = "time_changed"
	Unpublished     ShiftHistoryType = "unpublished"
)

Defines values for ShiftHistoryType.

type ShiftNotifyRequest

type ShiftNotifyRequest struct {
	// All Should notifications be sent for all matching shifts, or only new and/or changed shifts since last notification.
	All *bool `json:"all,omitempty"`

	// End The end of the date range of shifts for which to send notifications
	End time.Time `json:"end"`

	// LocationId The location (schedule) with shifts to send notifications. If not set, all locations will be included.
	LocationId *int `json:"location_id,omitempty"`

	// Message A custom message to send with the shift notifications
	Message *string `json:"message,omitempty"`

	// PositionIds Limit schedule notifications to only shifts tagged to the given position IDs. Defaults to all positions.
	PositionIds *[]int `json:"position_ids,omitempty"`

	// SiteIds Limit schedule notifications to only shifts tagged to the given site IDs. Defaults to all sites.
	SiteIds *[]int `json:"site_ids,omitempty"`

	// Start The start of the date range of shifts for which to send notifications
	Start time.Time `json:"start"`

	// UserIds Limit schedule notifications to only shifts tagged to the given user IDs. Defaults to all users.
	UserIds *[]int `json:"user_ids,omitempty"`
}

ShiftNotifyRequest defines model for ShiftNotifyRequest.

type ShiftPublish

type ShiftPublish struct {
	// Ids List of shift IDs
	Ids *[]int `json:"ids,omitempty"`
}

ShiftPublish defines model for ShiftPublish.

type ShiftScheduledBreak

type ShiftScheduledBreak struct {
	AccountId *int `json:"account_id,omitempty"`

	// CreatedAt Date and time the break was created at.
	CreatedAt *string `json:"created_at,omitempty"`

	// CreatedBy The id of the user who created the break.
	CreatedBy *int `json:"created_by,omitempty"`

	// EndTime The end time of the break. Null if the break does not have an end time. Calculated from the start time of the break and the length.
	EndTime *string `json:"end_time,omitempty"`

	// Id ID of the break. Provide in the request when updating an existing break.
	Id *int `json:"id,omitempty"`

	// Length The length of the break (seconds).
	Length int `json:"length"`

	// Paid Whether the break is a paid rest break (true) or unpaid meal break (false)
	Paid bool `json:"paid"`

	// ShiftId The ID of the shift that the break applies to.
	ShiftId *int `json:"shift_id,omitempty"`

	// Sort Breaks are sorted by start time if it is available. If no start time is provided, breaks are sorted by their position in the request. In a mixed list, breaks without a start time keep their original position, while breaks with a start time are sorted amongst themselves.
	Sort *int `json:"sort,omitempty"`

	// StartTime The start time of the break. Null if the break does not have a start time.
	StartTime *string `json:"start_time,omitempty"`

	// UpdatedAt Date and time the break was last updated.
	UpdatedAt *string `json:"updated_at,omitempty"`

	// UpdatedBy The id of the user who last edited the break.
	UpdatedBy *int `json:"updated_by,omitempty"`
}

ShiftScheduledBreak defines model for ShiftScheduledBreak.

type ShiftUnassignRequest

type ShiftUnassignRequest struct {
	// ShiftIds Array of shift IDs
	ShiftIds *[]string `json:"shift_ids,omitempty"`
}

ShiftUnassignRequest defines model for ShiftUnassignRequest.

type SingleShiftNotifyRequest

type SingleShiftNotifyRequest struct {
	// Message A custom message to send with the shift notifications.
	Message *string `json:"message,omitempty"`
}

SingleShiftNotifyRequest defines model for SingleShiftNotifyRequest.

type Site

type Site struct {
	AccountId   *int       `json:"account_id,omitempty"`
	Address     *string    `json:"address,omitempty"`
	Color       *string    `json:"color,omitempty"`
	Coordinates *[]float32 `json:"coordinates,omitempty"`
	CreatedAt   *WIWTime   `json:"created_at,omitempty"`
	DeletedAt   *WIWTime   `json:"deleted_at,omitempty"`
	Description *string    `json:"description,omitempty"`
	Id          *int       `json:"id,omitempty"`
	IsDeleted   *bool      `json:"is_deleted,omitempty"`
	Latitude    *float32   `json:"latitude,omitempty"`
	LocationId  *int       `json:"location_id,omitempty"`
	Longitude   *float32   `json:"longitude,omitempty"`
	Name        *string    `json:"name,omitempty"`
	Place       *Place     `json:"place,omitempty"`
	PlaceId     *string    `json:"place_id,omitempty"`
	UpdatedAt   *WIWTime   `json:"updated_at,omitempty"`
}

Site defines model for Site.

type SiteRequest

type SiteRequest struct {
	AccountId   *int       `json:"account_id,omitempty"`
	Address     *string    `json:"address,omitempty"`
	Color       *string    `json:"color,omitempty"`
	Coordinates *[]float32 `json:"coordinates,omitempty"`
	Description *string    `json:"description,omitempty"`
	Latitude    *float32   `json:"latitude,omitempty"`
	LocationId  *int       `json:"location_id,omitempty"`
	Longitude   *float32   `json:"longitude,omitempty"`
	Name        *string    `json:"name,omitempty"`
	Place       *Place     `json:"place,omitempty"`
	PlaceId     *string    `json:"place_id,omitempty"`
}

SiteRequest defines model for SiteRequest.

type Time

type Time struct {
	// AccountId The account id
	AccountId *int `json:"account_id,omitempty"`

	// AlertType The type of alert for this time
	AlertType *int `json:"alert_type,omitempty"`

	// CashTips Any cash tips reported for the shift.
	// Note: the tips feature is required to see and use this field.
	CashTips *string `json:"cash_tips"`

	// CreatedAt When the time was created
	CreatedAt *WIWTime `json:"created_at,omitempty"`

	// CreatorId The user that created the time.
	CreatorId *int `json:"creator_id,omitempty"`

	// EndTime The end time
	EndTime *WIWTime `json:"end_time,omitempty"`

	// HourlyRate The base hourly rate for this time.
	HourlyRate *float32 `json:"hourly_rate,omitempty"`

	// Id The time id
	Id *int `json:"id,omitempty"`

	// IsAlerted If alert_type > 0
	IsAlerted *bool `json:"is_alerted,omitempty"`

	// IsApproved If the time is approved
	IsApproved *bool `json:"is_approved,omitempty"`

	// Length The length of the time in hours.
	Length *float32 `json:"length,omitempty"`

	// LocationId Location the time belongs to. 0 if unassigned.
	LocationId *int `json:"location_id,omitempty"`

	// ModifiedBy The user that modified the time
	ModifiedBy *int `json:"modified_by,omitempty"`

	// Notes Notes for a time
	Notes *string `json:"notes,omitempty"`

	// PositionId Position the time belongs to. 0 if unassigned.
	PositionId *int `json:"position_id,omitempty"`

	// RoundedEndTime The rounded end time. If rounding is not enabled this field will not be present.
	RoundedEndTime *WIWTime `json:"rounded_end_time,omitempty"`

	// RoundedLength The rounded length calculated from the rounded_start_time and rounded_end_time. If rounding is not enabled this field will not be present.
	RoundedLength *float32 `json:"rounded_length,omitempty"`

	// RoundedStartTime The rounded start time. If rounding is not enabled this field will not be present.
	RoundedStartTime *WIWTime `json:"rounded_start_time,omitempty"`

	// ShiftId A shift tied to this time. 0 if unassigned.
	ShiftId *int `json:"shift_id,omitempty"`

	// SiteId Site the time belongs to. 0 if unassigned.
	SiteId *int `json:"site_id,omitempty"`

	// SplitTime If the time crosses payroll periods, when to split it
	SplitTime *WIWTime `json:"split_time,omitempty"`

	// StartTime The start time
	StartTime *WIWTime `json:"start_time,omitempty"`

	// SyncHash The quickbooks sync hash
	SyncHash *string `json:"sync_hash,omitempty"`

	// SyncId The quickbooks sync id
	SyncId *string `json:"sync_id,omitempty"`

	// UpdatedAt When the time was updated
	UpdatedAt *WIWTime `json:"updated_at,omitempty"`

	// UserId The user assigned to the time.
	UserId *int `json:"user_id,omitempty"`
}

Time defines model for Time.

type TimeRequest

type TimeRequest struct {
	// CashTips The amount of cash tips reported for the time entry.
	CashTips *string `json:"cash_tips,omitempty"`

	// EndTime The end time
	EndTime *WIWTime `json:"end_time,omitempty"`

	// IsApproved If the time is approved
	IsApproved *bool `json:"is_approved,omitempty"`

	// LocationId Location the time belongs to. 0 if unassigned.
	LocationId *int `json:"location_id,omitempty"`

	// Notes Notes for a time
	Notes *string `json:"notes,omitempty"`

	// PositionId Position the time belongs to. 0 if unassigned.
	PositionId *int `json:"position_id,omitempty"`

	// RoundedEndTime The rounded end time. If rounding is not enabled this field will not be present.
	RoundedEndTime *WIWTime `json:"rounded_end_time,omitempty"`

	// RoundedStartTime The rounded start time. If rounding is not enabled this field will not be present.
	RoundedStartTime *WIWTime `json:"rounded_start_time,omitempty"`

	// ShiftId A shift tied to this time. 0 if unassigned.
	ShiftId *int `json:"shift_id,omitempty"`

	// SiteId Site the time belongs to. 0 if unassigned.
	SiteId *int `json:"site_id,omitempty"`

	// StartTime The start time. For accounts with Check payroll onboarded, time must not be past the end of the current pay period
	StartTime *WIWTime `json:"start_time,omitempty"`

	// UserId The user assigned to the times.
	UserId *int `json:"user_id,omitempty"`
}

TimeRequest defines model for TimeRequest.

type Timezone

type Timezone struct {
	Name string `json:"name"`
}

Timezone defines model for Timezone.

type UnassignShiftsJSONRequestBody

type UnassignShiftsJSONRequestBody = ShiftUnassignRequest

UnassignShiftsJSONRequestBody defines body for UnassignShifts for application/json ContentType.

type UnassignShiftsResponse

type UnassignShiftsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Shifts *[]Shift `json:"shifts,omitempty"`
	}
	JSONDefault *Error
}

func ParseUnassignShiftsResponse

func ParseUnassignShiftsResponse(rsp *http.Response) (*UnassignShiftsResponse, error)

ParseUnassignShiftsResponse parses an HTTP response from a UnassignShiftsWithResponse call

func (UnassignShiftsResponse) Status

func (r UnassignShiftsResponse) Status() string

Status returns HTTPResponse.Status

func (UnassignShiftsResponse) StatusCode

func (r UnassignShiftsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UnpublishShiftsJSONRequestBody

type UnpublishShiftsJSONRequestBody = ShiftPublish

UnpublishShiftsJSONRequestBody defines body for UnpublishShifts for application/json ContentType.

type UnpublishShiftsResponse

type UnpublishShiftsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Shifts *[]Shift `json:"shifts,omitempty"`
	}
	JSONDefault *Error
}

func ParseUnpublishShiftsResponse

func ParseUnpublishShiftsResponse(rsp *http.Response) (*UnpublishShiftsResponse, error)

ParseUnpublishShiftsResponse parses an HTTP response from a UnpublishShiftsWithResponse call

func (UnpublishShiftsResponse) Status

func (r UnpublishShiftsResponse) Status() string

Status returns HTTPResponse.Status

func (UnpublishShiftsResponse) StatusCode

func (r UnpublishShiftsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAccountJSONRequestBody

type UpdateAccountJSONRequestBody = Account

UpdateAccountJSONRequestBody defines body for UpdateAccount for application/json ContentType.

type UpdateAccountResponse

type UpdateAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Account *Account `json:"account,omitempty"`
	}
	JSONDefault *Error
}

func ParseUpdateAccountResponse

func ParseUpdateAccountResponse(rsp *http.Response) (*UpdateAccountResponse, error)

ParseUpdateAccountResponse parses an HTTP response from a UpdateAccountWithResponse call

func (UpdateAccountResponse) Status

func (r UpdateAccountResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateAccountResponse) StatusCode

func (r UpdateAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateLocationJSONRequestBody

type UpdateLocationJSONRequestBody = ScheduleRequest

UpdateLocationJSONRequestBody defines body for UpdateLocation for application/json ContentType.

type UpdateLocationResponse

type UpdateLocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Location *Schedule `json:"location,omitempty"`
	}
	JSONDefault *Error
}

func ParseUpdateLocationResponse

func ParseUpdateLocationResponse(rsp *http.Response) (*UpdateLocationResponse, error)

ParseUpdateLocationResponse parses an HTTP response from a UpdateLocationWithResponse call

func (UpdateLocationResponse) Status

func (r UpdateLocationResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateLocationResponse) StatusCode

func (r UpdateLocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateShiftJSONBody

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

UpdateShiftJSONBody defines parameters for UpdateShift.

type UpdateShiftJSONBody1

type UpdateShiftJSONBody1 = []Shift

UpdateShiftJSONBody1 defines parameters for UpdateShift.

type UpdateShiftJSONRequestBody

type UpdateShiftJSONRequestBody UpdateShiftJSONBody

UpdateShiftJSONRequestBody defines body for UpdateShift for application/json ContentType.

type UpdateShiftParams

type UpdateShiftParams struct {
	// IncludeRepeatingShiftsTo End date to include repeating shifts in series, if applicable
	IncludeRepeatingShiftsTo *WIWTime `form:"include_repeating_shifts_to,omitempty" json:"include_repeating_shifts_to,omitempty"`
}

UpdateShiftParams defines parameters for UpdateShift.

type UpdateShiftResponse

type UpdateShiftResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Deleted A list of shift IDs that were deleted as a result of the update. Applicable for updates to repeating shifts that impact future shifts on the same chain.
		Deleted *[]int `json:"deleted,omitempty"`

		// RepeatingShifts This field will be present if the `include_repeating_shifts_to` parameter is provided. We will insert the created or edited shifts from the beginning of the chain up to the date specified in the parameter.
		RepeatingShifts *[]Shift `json:"repeating_shifts,omitempty"`
		Shift           *Shift   `json:"shift,omitempty"`

		// Shiftchains Any shift chain this shift is a part of
		Shiftchains *[]ShiftChain `json:"shiftchains,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseUpdateShiftResponse

func ParseUpdateShiftResponse(rsp *http.Response) (*UpdateShiftResponse, error)

ParseUpdateShiftResponse parses an HTTP response from a UpdateShiftWithResponse call

func (UpdateShiftResponse) Status

func (r UpdateShiftResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateShiftResponse) StatusCode

func (r UpdateShiftResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateSiteJSONRequestBody

type UpdateSiteJSONRequestBody = SiteRequest

UpdateSiteJSONRequestBody defines body for UpdateSite for application/json ContentType.

type UpdateSiteResponse

type UpdateSiteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Site *Site `json:"site,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseUpdateSiteResponse

func ParseUpdateSiteResponse(rsp *http.Response) (*UpdateSiteResponse, error)

ParseUpdateSiteResponse parses an HTTP response from a UpdateSiteWithResponse call

func (UpdateSiteResponse) Status

func (r UpdateSiteResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSiteResponse) StatusCode

func (r UpdateSiteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTimeJSONRequestBody

type UpdateTimeJSONRequestBody = TimeRequest

UpdateTimeJSONRequestBody defines body for UpdateTime for application/json ContentType.

type UpdateTimeResponse

type UpdateTimeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Time *Time `json:"time,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseUpdateTimeResponse

func ParseUpdateTimeResponse(rsp *http.Response) (*UpdateTimeResponse, error)

ParseUpdateTimeResponse parses an HTTP response from a UpdateTimeWithResponse call

func (UpdateTimeResponse) Status

func (r UpdateTimeResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateTimeResponse) StatusCode

func (r UpdateTimeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateUserJSONRequestBody

type UpdateUserJSONRequestBody = UpdateUserRequest

UpdateUserJSONRequestBody defines body for UpdateUser for application/json ContentType.

type UpdateUserParams added in v0.6.0

type UpdateUserParams struct {
	// WUserID The ID of the account user
	WUserID int `json:"W-UserID"`
}

UpdateUserParams defines parameters for UpdateUser.

type UpdateUserRequest

type UpdateUserRequest struct {
	// AccountId ID of the primary account for this user.
	AccountId *int `json:"account_id,omitempty"`

	// Activated Whether the manager has activated this user.
	Activated *bool `json:"activated,omitempty"`

	// Email The email address of this user.
	Email *openapi_types.Email `json:"email,omitempty"`

	// EmployeeCode The user's employee code. This code can be used to clock in instead of the user's email address, or it can be used to help map users in When I Work to other services.
	EmployeeCode *string `json:"employee_code,omitempty"`

	// FirstName The first name of this user.
	FirstName *string `json:"first_name,omitempty"`

	// HourlyRate The base hourly rate for this user. The user can have additional wages based on the position they are working at the time. There is no currency attached, so customers are expected to input correct values for their currency or do their own conversion from USD.
	HourlyRate *float32 `json:"hourly_rate,omitempty"`

	// HoursMax The max hours that this user prefers to work. A manager may still schedule the user beyond this value.
	HoursMax *float32 `json:"hours_max,omitempty"`

	// HoursPreferred The preferred number of hours for this user to work.
	HoursPreferred *float32 `json:"hours_preferred,omitempty"`

	// Id Unique identifier for the user.
	Id *int `json:"id,omitempty"`

	// IsDeleted Whether the user has been deleted.
	IsDeleted *bool `json:"is_deleted,omitempty"`

	// LastLogin The date and time when this user last logged in.
	LastLogin *WIWTime `json:"last_login,omitempty"`

	// LastName The last name of this user.
	LastName *string `json:"last_name,omitempty"`

	// Locations An array of location IDs to be applied to this user.
	Locations *[]int `json:"locations,omitempty"`

	// LoginId Unique identifier for the login belonging to the user.
	LoginId *int `json:"login_id,omitempty"`

	// Notes Notes about this user. Visible only to supervisors+.
	Notes *string `json:"notes,omitempty"`

	// PhoneNumber The phone number of this user.
	PhoneNumber *string `json:"phone_number,omitempty"`

	// Positions An array of position IDs to be assigned to this user.
	Positions *[]int `json:"positions,omitempty"`

	// Reactivate Whether to reactivate a previously deleted user.
	Reactivate *bool `json:"reactivate,omitempty"`

	// Role The user's role.
	// - '1 = Admin'
	// - '2 = Manager'
	// - '3 = Employee (Default)'
	// - '4 = Lead (Unused)'
	// - '5 = Supervisor'
	Role *UpdateUserRequestRole `json:"role,omitempty"`

	// Type A bitwise flag representing additional wage options.
	Type *UpdateUserRequestType `json:"type,omitempty"`
}

UpdateUserRequest defines model for UpdateUserRequest.

type UpdateUserRequestRole

type UpdateUserRequestRole int

UpdateUserRequestRole The user's role. - '1 = Admin' - '2 = Manager' - '3 = Employee (Default)' - '4 = Lead (Unused)' - '5 = Supervisor'

const (
	UpdateUserRequestRoleN1 UpdateUserRequestRole = 1
	UpdateUserRequestRoleN2 UpdateUserRequestRole = 2
	UpdateUserRequestRoleN3 UpdateUserRequestRole = 3
	UpdateUserRequestRoleN4 UpdateUserRequestRole = 4
	UpdateUserRequestRoleN5 UpdateUserRequestRole = 5
)

Defines values for UpdateUserRequestRole.

type UpdateUserRequestType

type UpdateUserRequestType int

UpdateUserRequestType A bitwise flag representing additional wage options.

const (
	UpdateUserRequestTypeN1 UpdateUserRequestType = 1
	UpdateUserRequestTypeN2 UpdateUserRequestType = 2
	UpdateUserRequestTypeN3 UpdateUserRequestType = 3
)

Defines values for UpdateUserRequestType.

type UpdateUserResponse

type UpdateUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		User *User `json:"user,omitempty"`
	}
	JSON404     *Error
	JSONDefault *Error
}

func ParseUpdateUserResponse

func ParseUpdateUserResponse(rsp *http.Response) (*UpdateUserResponse, error)

ParseUpdateUserResponse parses an HTTP response from a UpdateUserWithResponse call

func (UpdateUserResponse) Status

func (r UpdateUserResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateUserResponse) StatusCode

func (r UpdateUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type User

type User struct {
	// AccountId ID of the primary account for this user.
	AccountId *int `json:"account_id,omitempty"`

	// Activated Whether the manager has activated this user.
	Activated *bool `json:"activated,omitempty"`

	// Email The email address of this user.
	Email *openapi_types.Email `json:"email,omitempty"`

	// EmployeeCode The user's employee code. This code can be used to clock in instead of the user's email address, or it can be used to help map users in When I Work to other services.
	EmployeeCode *string `json:"employee_code,omitempty"`

	// FirstName The first name of this user.
	FirstName *string `json:"first_name,omitempty"`

	// HourlyRate The base hourly rate for this user. The user can have additional wages based on the position they are working at the time. There is no currency attached, so customers are expected to input correct values for their currency or do their own conversion from USD.
	HourlyRate *float32 `json:"hourly_rate,omitempty"`

	// HoursMax The max hours that this user prefers to work. A manager may still schedule the user beyond this value.
	HoursMax *float32 `json:"hours_max,omitempty"`

	// HoursPreferred The preferred number of hours for this user to work.
	HoursPreferred *float32 `json:"hours_preferred,omitempty"`

	// Id Unique identifier for the user.
	Id *int `json:"id,omitempty"`

	// IsDeleted Whether the user has been deleted.
	IsDeleted *bool `json:"is_deleted,omitempty"`

	// LastLogin The date and time when this user last logged in.
	LastLogin *WIWTime `json:"last_login,omitempty"`

	// LastName The last name of this user.
	LastName *string `json:"last_name,omitempty"`

	// Locations An array of location IDs to be applied to this user.
	Locations *[]int `json:"locations,omitempty"`

	// LoginId Unique identifier for the login belonging to the user.
	LoginId *int `json:"login_id,omitempty"`

	// Notes Notes about this user. Visible only to supervisors+.
	Notes *string `json:"notes,omitempty"`

	// PhoneNumber The phone number of this user.
	PhoneNumber *string `json:"phone_number,omitempty"`

	// Positions An array of position IDs to be assigned to this user.
	Positions *[]int `json:"positions,omitempty"`

	// Role The user's role.
	// - '1 = Admin'
	// - '2 = Manager'
	// - '3 = Employee (Default)'
	// - '4 = Lead (Unused)'
	// - '5 = Supervisor'
	Role *UserRole `json:"role,omitempty"`

	// Type A bitwise flag representing additional wage options.
	Type *UserType `json:"type,omitempty"`
}

User defines model for User.

type UserRequest

type UserRequest struct {
	// AccountId ID of the primary account for this user.
	AccountId *int `json:"account_id,omitempty"`

	// Activated Whether the manager has activated this user.
	Activated *bool `json:"activated,omitempty"`

	// Email The email address of this user.
	Email *openapi_types.Email `json:"email,omitempty"`

	// EmployeeCode The user's employee code. This code can be used to clock in instead of the user's email address, or it can be used to help map users in When I Work to other services.
	EmployeeCode *string `json:"employee_code,omitempty"`

	// FirstName The first name of this user.
	FirstName *string `json:"first_name,omitempty"`

	// HourlyRate The base hourly rate for this user. The user can have additional wages based on the position they are working at the time. There is no currency attached, so customers are expected to input correct values for their currency or do their own conversion from USD.
	HourlyRate *float32 `json:"hourly_rate,omitempty"`

	// HoursMax The max hours that this user prefers to work. A manager may still schedule the user beyond this value.
	HoursMax *float32 `json:"hours_max,omitempty"`

	// HoursPreferred The preferred number of hours for this user to work.
	HoursPreferred *float32 `json:"hours_preferred,omitempty"`

	// Id Unique identifier for the user.
	Id *int `json:"id,omitempty"`

	// Invite Whether an invite should be sent upon user creation. When missing or not false, an invite is sent by default
	Invite *bool `json:"invite,omitempty"`

	// IsDeleted Whether the user has been deleted.
	IsDeleted *bool `json:"is_deleted,omitempty"`

	// LastLogin The date and time when this user last logged in.
	LastLogin *WIWTime `json:"last_login,omitempty"`

	// LastName The last name of this user.
	LastName *string `json:"last_name,omitempty"`

	// Locations An array of location IDs to be applied to this user.
	Locations *[]int `json:"locations,omitempty"`

	// LoginId Unique identifier for the login belonging to the user.
	LoginId *int `json:"login_id,omitempty"`

	// Notes Notes about this user. Visible only to supervisors+.
	Notes *string `json:"notes,omitempty"`

	// PhoneNumber The phone number of this user.
	PhoneNumber *string `json:"phone_number,omitempty"`

	// Positions An array of position IDs to be assigned to this user.
	Positions *[]int `json:"positions,omitempty"`

	// Role The user's role.
	// - '1 = Admin'
	// - '2 = Manager'
	// - '3 = Employee (Default)'
	// - '4 = Lead (Unused)'
	// - '5 = Supervisor'
	Role *UserRequestRole `json:"role,omitempty"`

	// Type A bitwise flag representing additional wage options.
	Type *UserRequestType `json:"type,omitempty"`
}

UserRequest defines model for UserRequest.

type UserRequestRole

type UserRequestRole int

UserRequestRole The user's role. - '1 = Admin' - '2 = Manager' - '3 = Employee (Default)' - '4 = Lead (Unused)' - '5 = Supervisor'

const (
	UserRequestRoleN1 UserRequestRole = 1
	UserRequestRoleN2 UserRequestRole = 2
	UserRequestRoleN3 UserRequestRole = 3
	UserRequestRoleN4 UserRequestRole = 4
	UserRequestRoleN5 UserRequestRole = 5
)

Defines values for UserRequestRole.

type UserRequestType

type UserRequestType int

UserRequestType A bitwise flag representing additional wage options.

const (
	UserRequestTypeN1 UserRequestType = 1
	UserRequestTypeN2 UserRequestType = 2
	UserRequestTypeN3 UserRequestType = 3
)

Defines values for UserRequestType.

type UserRole

type UserRole int

UserRole The user's role. - '1 = Admin' - '2 = Manager' - '3 = Employee (Default)' - '4 = Lead (Unused)' - '5 = Supervisor'

const (
	UserRoleN1 UserRole = 1
	UserRoleN2 UserRole = 2
	UserRoleN3 UserRole = 3
	UserRoleN4 UserRole = 4
	UserRoleN5 UserRole = 5
)

Defines values for UserRole.

type UserType

type UserType int

UserType A bitwise flag representing additional wage options.

const (
	UserTypeN1 UserType = 1
	UserTypeN2 UserType = 2
	UserTypeN3 UserType = 3
)

Defines values for UserType.

type WIWTime added in v0.5.0

type WIWTime time.Time

func (WIWTime) MarshalJSON added in v0.5.0

func (t WIWTime) MarshalJSON() ([]byte, error)

func (*WIWTime) UnmarshalJSON added in v0.5.0

func (t *WIWTime) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

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