@digital8/lighting-illusions-ts-sdk 0.0.2359 → 0.0.2361

package/docs/SearchAdminUsersRequest.md

@@ -1,54 +0,0 @@
-
-# SearchAdminUsersRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`beforeCreatedAt` | Date
-`afterCreatedAt` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`roleIds` | Array<number>
-
-## Example
-
-```typescript
-import type { SearchAdminUsersRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "beforeCreatedAt": null,
-  "afterCreatedAt": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "roleIds": null,
-} satisfies SearchAdminUsersRequest
-
-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 SearchAdminUsersRequest
-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/SearchAllAdminUsersRequest.md

@@ -1,46 +0,0 @@
-
-# SearchAllAdminUsersRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`roleIds` | Array<number>
-
-## Example
-
-```typescript
-import type { SearchAllAdminUsersRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "roleIds": null,
-} satisfies SearchAllAdminUsersRequest
-
-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 SearchAllAdminUsersRequest
-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/SearchAllCustomersRequest.md

@@ -1,50 +0,0 @@
-
-# SearchAllCustomersRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`siteId` | Array<string>
-`type` | Array<string>
-`signUpType` | Array<string>
-
-## Example
-
-```typescript
-import type { SearchAllCustomersRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "siteId": null,
-  "type": null,
-  "signUpType": null,
-} satisfies SearchAllCustomersRequest
-
-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 SearchAllCustomersRequest
-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/SearchAllPermissionsRequest.md

@@ -1,46 +0,0 @@
-
-# SearchAllPermissionsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`roleIds` | Array<number>
-
-## Example
-
-```typescript
-import type { SearchAllPermissionsRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "roleIds": null,
-} satisfies SearchAllPermissionsRequest
-
-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 SearchAllPermissionsRequest
-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/SearchAllRolesRequest.md

@@ -1,48 +0,0 @@
-
-# SearchAllRolesRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`isLocked` | Array<string>
-`permissionIds` | Array<number>
-
-## Example
-
-```typescript
-import type { SearchAllRolesRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "isLocked": null,
-  "permissionIds": null,
-} satisfies SearchAllRolesRequest
-
-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 SearchAllRolesRequest
-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/SearchPermissionsRequest.md

@@ -1,50 +0,0 @@
-
-# SearchPermissionsRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`roleIds` | Array<number>
-
-## Example
-
-```typescript
-import type { SearchPermissionsRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "roleIds": null,
-} satisfies SearchPermissionsRequest
-
-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 SearchPermissionsRequest
-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/SearchRolesRequest.md

@@ -1,52 +0,0 @@
-
-# SearchRolesRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`isLocked` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`permissionIds` | Array<number>
-
-## Example
-
-```typescript
-import type { SearchRolesRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "isLocked": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "permissionIds": null,
-} satisfies SearchRolesRequest
-
-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 SearchRolesRequest
-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/SignUpType.md

@@ -1,32 +0,0 @@
-
-# SignUpType
-
-
-## Properties
-
-Name | Type
------------- | -------------
-
-## Example
-
-```typescript
-import type { SignUpType } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-} satisfies SignUpType
-
-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 SignUpType
-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/SocialProvider.md

@@ -1,32 +0,0 @@
-
-# SocialProvider
-
-
-## Properties
-
-Name | Type
------------- | -------------
-
-## Example
-
-```typescript
-import type { SocialProvider } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-} satisfies SocialProvider
-
-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 SocialProvider
-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/UpdateAdminUserRequest.md

@@ -1,42 +0,0 @@
-
-# UpdateAdminUserRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`firstName` | string
-`lastName` | string
-`phone` | string
-`password` | string
-`email` | string
-
-## Example
-
-```typescript
-import type { UpdateAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "firstName": null,
-  "lastName": null,
-  "phone": null,
-  "password": null,
-  "email": null,
-} satisfies UpdateAdminUserRequest
-
-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 UpdateAdminUserRequest
-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/UpdateCustomerAddressRequest.md

@@ -1,50 +0,0 @@
-
-# UpdateCustomerAddressRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`addresseeName` | string
-`company` | string
-`line1` | string
-`line2` | string
-`suburb` | string
-`state` | string
-`postcode` | string
-`country` | string
-`type` | string
-
-## Example
-
-```typescript
-import type { UpdateCustomerAddressRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "addresseeName": null,
-  "company": null,
-  "line1": null,
-  "line2": null,
-  "suburb": null,
-  "state": null,
-  "postcode": null,
-  "country": null,
-  "type": null,
-} satisfies UpdateCustomerAddressRequest
-
-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 UpdateCustomerAddressRequest
-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/UpdateCustomerRequest.md

@@ -1,46 +0,0 @@
-
-# UpdateCustomerRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`firstName` | string
-`lastName` | string
-`phone` | string
-`password` | string
-`email` | string
-`subscribedToNewsletter` | boolean
-`netsuiteId` | number
-
-## Example
-
-```typescript
-import type { UpdateCustomerRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "firstName": null,
-  "lastName": null,
-  "phone": null,
-  "password": null,
-  "email": null,
-  "subscribedToNewsletter": null,
-  "netsuiteId": null,
-} satisfies UpdateCustomerRequest
-
-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 UpdateCustomerRequest
-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/UpdateRoleRequest.md

@@ -1,36 +0,0 @@
-
-# UpdateRoleRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`permissionIds` | Array<number>
-
-## Example
-
-```typescript
-import type { UpdateRoleRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "permissionIds": null,
-} satisfies UpdateRoleRequest
-
-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 UpdateRoleRequest
-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/UserLiteResource.md

@@ -1,44 +0,0 @@
-
-# UserLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`firstName` | string
-`lastName` | string
-`email` | string
-`phone` | string
-`fullName` | string
-
-## Example
-
-```typescript
-import type { UserLiteResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "firstName": null,
-  "lastName": null,
-  "email": null,
-  "phone": null,
-  "fullName": null,
-} satisfies UserLiteResource
-
-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 UserLiteResource
-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/UserLiteResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# UserLiteResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<UserLiteResource>](UserLiteResource.md)
-
-## Example
-
-```typescript
-import type { UserLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies UserLiteResourceArrayResponse
-
-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 UserLiteResourceArrayResponse
-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)
-
-