labor

Documentation

Index

• type BreakTypesDeleteRequest
• type BreakTypesGetRequest
• type BreakTypesListRequest
• type CreateBreakTypeRequest
• type CreateShiftRequest
• type EmployeeWagesGetRequest
• type EmployeeWagesListRequest
• type SearchShiftsRequest
• type ShiftsDeleteRequest
• type ShiftsGetRequest
• type TeamMemberWagesGetRequest
• type TeamMemberWagesListRequest
• type UpdateBreakTypeRequest
• type UpdateShiftRequest
• type UpdateWorkweekConfigRequest
• type WorkweekConfigsListRequest

Types

type BreakTypesDeleteRequest

type BreakTypesDeleteRequest struct {
	// The UUID for the `BreakType` being deleted.
	ID string `json:"-" url:"-"`
}

type BreakTypesGetRequest

type BreakTypesGetRequest struct {
	// The UUID for the `BreakType` being retrieved.
	ID string `json:"-" url:"-"`
}

type BreakTypesListRequest

type BreakTypesListRequest struct {
	// Filter the returned `BreakType` results to only those that are associated with the
	// specified location.
	LocationID *string `json:"-" url:"location_id,omitempty"`
	// The maximum number of `BreakType` results to return per page. The number can range between 1
	// and 200. The default is 200.
	Limit *int `json:"-" url:"limit,omitempty"`
	// A pointer to the next page of `BreakType` results to fetch.
	Cursor *string `json:"-" url:"cursor,omitempty"`
}

type CreateBreakTypeRequest

type CreateBreakTypeRequest struct {
	// A unique string value to ensure the idempotency of the operation.
	IdempotencyKey *string `json:"idempotency_key,omitempty" url:"-"`
	// The `BreakType` to be created.
	BreakType *squaregosdk.BreakType `json:"break_type,omitempty" url:"-"`
}

type CreateShiftRequest

type CreateShiftRequest struct {
	// A unique string value to ensure the idempotency of the operation.
	IdempotencyKey *string `json:"idempotency_key,omitempty" url:"-"`
	// The `Shift` to be created.
	Shift *squaregosdk.Shift `json:"shift,omitempty" url:"-"`
}

type EmployeeWagesGetRequest

type EmployeeWagesGetRequest struct {
	// The UUID for the `EmployeeWage` being retrieved.
	ID string `json:"-" url:"-"`
}

type EmployeeWagesListRequest

type EmployeeWagesListRequest struct {
	// Filter the returned wages to only those that are associated with the specified employee.
	EmployeeID *string `json:"-" url:"employee_id,omitempty"`
	// The maximum number of `EmployeeWage` results to return per page. The number can range between
	// 1 and 200. The default is 200.
	Limit *int `json:"-" url:"limit,omitempty"`
	// A pointer to the next page of `EmployeeWage` results to fetch.
	Cursor *string `json:"-" url:"cursor,omitempty"`
}

type SearchShiftsRequest

type SearchShiftsRequest struct {
	// Query filters.
	Query *squaregosdk.ShiftQuery `json:"query,omitempty" url:"-"`
	// The number of resources in a page (200 by default).
	Limit *int `json:"limit,omitempty" url:"-"`
	// An opaque cursor for fetching the next page.
	Cursor *string `json:"cursor,omitempty" url:"-"`
}

type ShiftsDeleteRequest

type ShiftsDeleteRequest struct {
	// The UUID for the `Shift` being deleted.
	ID string `json:"-" url:"-"`
}

type ShiftsGetRequest

type ShiftsGetRequest struct {
	// The UUID for the `Shift` being retrieved.
	ID string `json:"-" url:"-"`
}

type TeamMemberWagesGetRequest

type TeamMemberWagesGetRequest struct {
	// The UUID for the `TeamMemberWage` being retrieved.
	ID string `json:"-" url:"-"`
}

type TeamMemberWagesListRequest

type TeamMemberWagesListRequest struct {
	// Filter the returned wages to only those that are associated with the
	// specified team member.
	TeamMemberID *string `json:"-" url:"team_member_id,omitempty"`
	// The maximum number of `TeamMemberWage` results to return per page. The number can range between
	// 1 and 200. The default is 200.
	Limit *int `json:"-" url:"limit,omitempty"`
	// A pointer to the next page of `EmployeeWage` results to fetch.
	Cursor *string `json:"-" url:"cursor,omitempty"`
}

type UpdateBreakTypeRequest

type UpdateBreakTypeRequest struct {
	// The UUID for the `BreakType` being updated.
	ID string `json:"-" url:"-"`
	// The updated `BreakType`.
	BreakType *squaregosdk.BreakType `json:"break_type,omitempty" url:"-"`
}

type UpdateShiftRequest

type UpdateShiftRequest struct {
	// The ID of the object being updated.
	ID string `json:"-" url:"-"`
	// The updated `Shift` object.
	Shift *squaregosdk.Shift `json:"shift,omitempty" url:"-"`
}

type UpdateWorkweekConfigRequest

type UpdateWorkweekConfigRequest struct {
	// The UUID for the `WorkweekConfig` object being updated.
	ID string `json:"-" url:"-"`
	// The updated `WorkweekConfig` object.
	WorkweekConfig *squaregosdk.WorkweekConfig `json:"workweek_config,omitempty" url:"-"`
}

type WorkweekConfigsListRequest

type WorkweekConfigsListRequest struct {
	// The maximum number of `WorkweekConfigs` results to return per page.
	Limit *int `json:"-" url:"limit,omitempty"`
	// A pointer to the next page of `WorkweekConfig` results to fetch.
	Cursor *string `json:"-" url:"cursor,omitempty"`
}