tuix-projects-service-client 0.0.1

package/docs/PaginatedGlobalTimesheets.md

@@ -0,0 +1,42 @@
+
+# PaginatedGlobalTimesheets
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GlobalTimesheetDTO>](GlobalTimesheetDTO.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PaginatedGlobalTimesheets } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+} satisfies PaginatedGlobalTimesheets
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedGlobalTimesheets
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PaginatedHolidaysDTO.md

@@ -0,0 +1,42 @@
+
+# PaginatedHolidaysDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<HolidayDTO>](HolidayDTO.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PaginatedHolidaysDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+} satisfies PaginatedHolidaysDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedHolidaysDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PaginatedProjects.md

@@ -0,0 +1,42 @@
+
+# PaginatedProjects
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ProjectDTO>](ProjectDTO.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PaginatedProjects } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+} satisfies PaginatedProjects
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedProjects
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PaginatedTimesheets.md

@@ -0,0 +1,42 @@
+
+# PaginatedTimesheets
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<TimesheetDTO>](TimesheetDTO.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PaginatedTimesheets } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+} satisfies PaginatedTimesheets
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedTimesheets
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PaginatedUsers.md

@@ -0,0 +1,42 @@
+
+# PaginatedUsers
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<UserEnrollDTO>](UserEnrollDTO.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PaginatedUsers } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+} satisfies PaginatedUsers
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedUsers
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProjectDTO.md

@@ -0,0 +1,78 @@
+
+# ProjectDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`city` | string
+`clientId` | string
+`closed` | boolean
+`companyContactPerson` | string
+`contactEmail` | string
+`contactName` | string
+`contactPhoneNumber` | string
+`createdAt` | string
+`description` | string
+`endDate` | string
+`gitPrefix` | string
+`githubOrganization` | string
+`hourlyRate` | number
+`houseNumber` | string
+`id` | string
+`jiraOrganization` | string
+`jiraPrefix` | string
+`paymentMonthDay` | number
+`postalCode` | string
+`projectName` | string
+`startDate` | string
+`street` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ProjectDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "city": New York,
+  "clientId": null,
+  "closed": false,
+  "companyContactPerson": Jane Doe,
+  "contactEmail": john.doe@example.com,
+  "contactName": John Doe,
+  "contactPhoneNumber": +1234567890,
+  "createdAt": null,
+  "description": This is a project description.,
+  "endDate": 2024-12-31T23:59:59Z,
+  "gitPrefix": PROJECT,
+  "githubOrganization": github-org,
+  "hourlyRate": 50,
+  "houseNumber": Apt 101,
+  "id": null,
+  "jiraOrganization": jira-org,
+  "jiraPrefix": PROJECT,
+  "paymentMonthDay": 15,
+  "postalCode": 12345,
+  "projectName": Project X,
+  "startDate": 2024-01-01T00:00:00Z,
+  "street": 123 Main St,
+  "updatedAt": null,
+} satisfies ProjectDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProjectDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProjectInputDTO.md

@@ -0,0 +1,72 @@
+
+# ProjectInputDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`city` | string
+`clientId` | string
+`closed` | boolean
+`companyContactPerson` | string
+`contactEmail` | string
+`contactName` | string
+`contactPhoneNumber` | string
+`description` | string
+`endDate` | string
+`gitPrefix` | string
+`githubOrganization` | string
+`hourlyRate` | number
+`houseNumber` | string
+`jiraOrganization` | string
+`jiraPrefix` | string
+`paymentMonthDay` | number
+`postalCode` | string
+`projectName` | string
+`startDate` | string
+`street` | string
+
+## Example
+
+```typescript
+import type { ProjectInputDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "city": New York,
+  "clientId": 123e4567-e89b-12d3-a456-426614174000,
+  "closed": false,
+  "companyContactPerson": Jane Doe,
+  "contactEmail": john.doe@example.com,
+  "contactName": John Doe,
+  "contactPhoneNumber": +1234567890,
+  "description": This is a project description.,
+  "endDate": 2024-12-31T23:59:59Z,
+  "gitPrefix": PROJECT,
+  "githubOrganization": github-org,
+  "hourlyRate": 50,
+  "houseNumber": Apt 101,
+  "jiraOrganization": jira-org,
+  "jiraPrefix": PROJECT,
+  "paymentMonthDay": 15,
+  "postalCode": 12345,
+  "projectName": Project X,
+  "startDate": 2024-01-01T00:00:00Z,
+  "street": 123 Main St,
+} satisfies ProjectInputDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProjectInputDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProjectUpdateDTO.md

@@ -0,0 +1,72 @@
+
+# ProjectUpdateDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`city` | string
+`clientId` | string
+`closed` | boolean
+`companyContactPerson` | string
+`contactEmail` | string
+`contactName` | string
+`contactPhoneNumber` | string
+`description` | string
+`endDate` | string
+`gitPrefix` | string
+`githubOrganization` | string
+`hourlyRate` | number
+`houseNumber` | string
+`jiraOrganization` | string
+`jiraPrefix` | string
+`paymentMonthDay` | number
+`postalCode` | string
+`projectName` | string
+`startDate` | string
+`street` | string
+
+## Example
+
+```typescript
+import type { ProjectUpdateDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "city": Los Angeles,
+  "clientId": 550e8400-e29b-41d4-a716-446655440000,
+  "closed": true,
+  "companyContactPerson": Jane Doe,
+  "contactEmail": jane.doe@example.com,
+  "contactName": Jane Doe,
+  "contactPhoneNumber": +10987654321,
+  "description": Updated project description.,
+  "endDate": 2024-09-30T23:59:59Z,
+  "gitPrefix": PROJECT,
+  "githubOrganization": updated-github-org,
+  "hourlyRate": 55,
+  "houseNumber": Suite 200,
+  "jiraOrganization": updated-jira-org,
+  "jiraPrefix": PROJECT,
+  "paymentMonthDay": 16,
+  "postalCode": 54321,
+  "projectName": Updated Project,
+  "startDate": 2024-04-01T00:00:00Z,
+  "street": 456 Elm St,
+} satisfies ProjectUpdateDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProjectUpdateDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TeamUpdateDTO.md

@@ -0,0 +1,34 @@
+
+# TeamUpdateDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`team` | [Array<UserEnrollDTO>](UserEnrollDTO.md)
+
+## Example
+
+```typescript
+import type { TeamUpdateDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "team": null,
+} satisfies TeamUpdateDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TeamUpdateDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimesheetDTO.md

@@ -0,0 +1,48 @@
+
+# TimesheetDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`employeeData` | [TimesheetEmployeeInfo](TimesheetEmployeeInfo.md)
+`employeeID` | string
+`expectedHours` | number
+`id` | string
+`month` | string
+`projectID` | string
+`status` | string
+`timesheetEntries` | [Array<TimesheetEntryDTO>](TimesheetEntryDTO.md)
+
+## Example
+
+```typescript
+import type { TimesheetDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "employeeData": null,
+  "employeeID": null,
+  "expectedHours": null,
+  "id": null,
+  "month": null,
+  "projectID": null,
+  "status": null,
+  "timesheetEntries": null,
+} satisfies TimesheetDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TimesheetDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimesheetEmployeeInfo.md

@@ -0,0 +1,36 @@
+
+# TimesheetEmployeeInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { TimesheetEmployeeInfo } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+} satisfies TimesheetEmployeeInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TimesheetEmployeeInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimesheetEntryDTO.md

@@ -0,0 +1,48 @@
+
+# TimesheetEntryDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkIn` | string
+`checkOut` | string
+`comments` | string
+`day` | number
+`id` | string
+`isEmployeeHoliday` | boolean
+`isHoliday` | boolean
+`pause` | number
+
+## Example
+
+```typescript
+import type { TimesheetEntryDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkIn": null,
+  "checkOut": null,
+  "comments": null,
+  "day": null,
+  "id": null,
+  "isEmployeeHoliday": null,
+  "isHoliday": null,
+  "pause": null,
+} satisfies TimesheetEntryDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TimesheetEntryDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimesheetEntryUpdateDTO.md

@@ -0,0 +1,40 @@
+
+# TimesheetEntryUpdateDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkIn` | string
+`checkOut` | string
+`comments` | string
+`pause` | number
+
+## Example
+
+```typescript
+import type { TimesheetEntryUpdateDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkIn": null,
+  "checkOut": null,
+  "comments": null,
+  "pause": null,
+} satisfies TimesheetEntryUpdateDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TimesheetEntryUpdateDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UserEnrollDTO.md

@@ -0,0 +1,38 @@
+
+# UserEnrollDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { UserEnrollDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "id": null,
+  "updatedAt": null,
+} satisfies UserEnrollDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UserEnrollDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+