> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/coaching/coaches.md).

# Coaches

Coach profiles, tiers, availability, and lesson bookings.

## GET /coaches/tiers

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachTierCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachTierDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"priority":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"hourlyRate":{"type":"number"},"payout":{"type":"string","enum":["DISABLED","CHARGE_AND_TRANSFER"]},"feeAmountCents":{"type":"number"},"feePercentage":{"type":"number"},"cancellationPolicy":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierCancellationPolicyDto"}},"coaches":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","priority","name","description","hourlyRate","payout","feeAmountCents","feePercentage","cancellationPolicy","coaches","status","errors","_links"]},"CoachTierCancellationPolicyDto":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"timeRange":{"$ref":"#/components/schemas/CoachTierCancellationPolicyTimeRangeDto"},"charge":{"type":"number"}},"required":["id","label","timeRange","charge"]},"CoachTierCancellationPolicyTimeRangeDto":{"type":"object","properties":{}},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/coaches/tiers":{"get":{"operationId":"CoachesTiersController_findAll","parameters":[],"responses":{"200":{"description":"Returns a collection of `CoachTierDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierCollectionDto"}}}}},"tags":["Coaches"]}}}}
```

## POST /coaches/tiers

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachTierDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"priority":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"hourlyRate":{"type":"number"},"payout":{"type":"string","enum":["DISABLED","CHARGE_AND_TRANSFER"]},"feeAmountCents":{"type":"number"},"feePercentage":{"type":"number"},"cancellationPolicy":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierCancellationPolicyDto"}},"coaches":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","priority","name","description","hourlyRate","payout","feeAmountCents","feePercentage","cancellationPolicy","coaches","status","errors","_links"]},"CoachTierCancellationPolicyDto":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"timeRange":{"$ref":"#/components/schemas/CoachTierCancellationPolicyTimeRangeDto"},"charge":{"type":"number"}},"required":["id","label","timeRange","charge"]},"CoachTierCancellationPolicyTimeRangeDto":{"type":"object","properties":{}},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/coaches/tiers":{"post":{"operationId":"CoachesTiersController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierDto"}}}},"responses":{"200":{"description":"Returns the newly added `CoachTierDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/tiers/{tierId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachTierDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"priority":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"hourlyRate":{"type":"number"},"payout":{"type":"string","enum":["DISABLED","CHARGE_AND_TRANSFER"]},"feeAmountCents":{"type":"number"},"feePercentage":{"type":"number"},"cancellationPolicy":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierCancellationPolicyDto"}},"coaches":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","priority","name","description","hourlyRate","payout","feeAmountCents","feePercentage","cancellationPolicy","coaches","status","errors","_links"]},"CoachTierCancellationPolicyDto":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"timeRange":{"$ref":"#/components/schemas/CoachTierCancellationPolicyTimeRangeDto"},"charge":{"type":"number"}},"required":["id","label","timeRange","charge"]},"CoachTierCancellationPolicyTimeRangeDto":{"type":"object","properties":{}},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/coaches/tiers/{tierId}":{"get":{"operationId":"CoachesTiersController_findById","parameters":[{"name":"tierId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `CoachTierDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierDto"}}}},"404":{"description":"The provided tier id does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierDto"}}}}},"tags":["Coaches"]}}}}
```

## DELETE /coaches/tiers/{tierId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachTierDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"priority":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"hourlyRate":{"type":"number"},"payout":{"type":"string","enum":["DISABLED","CHARGE_AND_TRANSFER"]},"feeAmountCents":{"type":"number"},"feePercentage":{"type":"number"},"cancellationPolicy":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierCancellationPolicyDto"}},"coaches":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","priority","name","description","hourlyRate","payout","feeAmountCents","feePercentage","cancellationPolicy","coaches","status","errors","_links"]},"CoachTierCancellationPolicyDto":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"timeRange":{"$ref":"#/components/schemas/CoachTierCancellationPolicyTimeRangeDto"},"charge":{"type":"number"}},"required":["id","label","timeRange","charge"]},"CoachTierCancellationPolicyTimeRangeDto":{"type":"object","properties":{}},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/coaches/tiers/{tierId}":{"delete":{"operationId":"CoachesTiersController_delete","parameters":[{"name":"tierId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the deleted `CoachTierDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierDto"}}}},"403":{"description":"User lacks permissions"},"404":{"description":"The provided tier id does not exist"},"409":{"description":"Tier is in use by coaches"}},"tags":["Coaches"]}}}}
```

## PATCH /coaches/tiers/{tierId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachTierPatchableDto":{"type":"object","properties":{"priority":{"type":"number"},"name":{"type":"string"},"payout":{"type":"string","enum":["DISABLED","CHARGE_AND_TRANSFER"]},"feeAmountCents":{"type":"number"},"feePercentage":{"type":"number"},"cancellationPolicy":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierCancellationPolicyDto"}}},"required":["priority","name","payout","feeAmountCents","feePercentage","cancellationPolicy"]},"CoachTierCancellationPolicyDto":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"timeRange":{"$ref":"#/components/schemas/CoachTierCancellationPolicyTimeRangeDto"},"charge":{"type":"number"}},"required":["id","label","timeRange","charge"]},"CoachTierCancellationPolicyTimeRangeDto":{"type":"object","properties":{}},"CoachTierDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"priority":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"hourlyRate":{"type":"number"},"payout":{"type":"string","enum":["DISABLED","CHARGE_AND_TRANSFER"]},"feeAmountCents":{"type":"number"},"feePercentage":{"type":"number"},"cancellationPolicy":{"type":"array","items":{"$ref":"#/components/schemas/CoachTierCancellationPolicyDto"}},"coaches":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","priority","name","description","hourlyRate","payout","feeAmountCents","feePercentage","cancellationPolicy","coaches","status","errors","_links"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/coaches/tiers/{tierId}":{"patch":{"operationId":"CoachesTiersController_update","parameters":[{"name":"tierId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierPatchableDto"}}}},"responses":{"200":{"description":"Returns the updated `CoachTierDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTierDto"}}}},"404":{"description":"The provided tier id does not exist"}},"tags":["Coaches"]}}}}
```

## GET /coaches

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaginatedCoachProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachProfileDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_total","_links"]},"CoachProfileDto":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/components/schemas/ItemRefDto"},"type":{"type":"string","enum":["REGULAR","GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER","COACH"],"readOnly":true},"membershipArea":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"gender":{"type":"string","readOnly":true},"birthday":{"format":"date-time","type":"string","readOnly":true},"initials":{"type":"string","readOnly":true},"description":{"type":"string"},"picture":{"type":"object","readOnly":true,"nullable":true},"usattRating":{"type":"number","readOnly":true,"nullable":true},"duprProfileUrl":{"type":"string","readOnly":true,"nullable":true},"memberSince":{"format":"date-time","type":"string","readOnly":true},"membershipSubscription":{"type":"object","nullable":true,"readOnly":true,"deprecated":true},"membershipEnrollment":{"type":"object","nullable":true,"readOnly":true},"kids":{"type":"object","nullable":true,"readOnly":true},"_links":{"type":"object"},"tier":{"type":"string","readOnly":true,"deprecated":true},"rate":{"type":"number","deprecated":true},"settings":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"tierSettings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rateSettings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CoachRateDto"}]},"fullName":{"type":"string"},"students":{"$ref":"#/components/schemas/CollectionRefDto"},"slug":{"type":"string"},"coachType":{"type":"string","enum":["ROBOT","HUMAN"]}},"required":["id","user","type","description","memberSince","kids","_links","tier","rate","settings","tierSettings","rateSettings","fullName","students","slug","coachType"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachRateDto":{"type":"object","properties":{"guests":{"type":"number"},"hourlyRate":{"type":"number"}},"required":["guests","hourlyRate"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/coaches":{"get":{"operationId":"CoachesController_find","parameters":[{"name":"active","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"tier","required":false,"in":"query","schema":{"type":"string"}},{"name":"slug","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"type","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns a `CoachProfile`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCoachProfileCollectionDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachProfileDto":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/components/schemas/ItemRefDto"},"type":{"type":"string","enum":["REGULAR","GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER","COACH"],"readOnly":true},"membershipArea":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"gender":{"type":"string","readOnly":true},"birthday":{"format":"date-time","type":"string","readOnly":true},"initials":{"type":"string","readOnly":true},"description":{"type":"string"},"picture":{"type":"object","readOnly":true,"nullable":true},"usattRating":{"type":"number","readOnly":true,"nullable":true},"duprProfileUrl":{"type":"string","readOnly":true,"nullable":true},"memberSince":{"format":"date-time","type":"string","readOnly":true},"membershipSubscription":{"type":"object","nullable":true,"readOnly":true,"deprecated":true},"membershipEnrollment":{"type":"object","nullable":true,"readOnly":true},"kids":{"type":"object","nullable":true,"readOnly":true},"_links":{"type":"object"},"tier":{"type":"string","readOnly":true,"deprecated":true},"rate":{"type":"number","deprecated":true},"settings":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"tierSettings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rateSettings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CoachRateDto"}]},"fullName":{"type":"string"},"students":{"$ref":"#/components/schemas/CollectionRefDto"},"slug":{"type":"string"},"coachType":{"type":"string","enum":["ROBOT","HUMAN"]}},"required":["id","user","type","description","memberSince","kids","_links","tier","rate","settings","tierSettings","rateSettings","fullName","students","slug","coachType"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachRateDto":{"type":"object","properties":{"guests":{"type":"number"},"hourlyRate":{"type":"number"}},"required":["guests","hourlyRate"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}}}},"paths":{"/coaches/{coachId}":{"get":{"operationId":"CoachesController_findById","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `CoachProfile`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachProfileDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}/settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsDto":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"tier":{"type":"string","readOnly":true},"tierSettings":{"$ref":"#/components/schemas/ItemRefDto"},"rateSettings":{"$ref":"#/components/schemas/ItemRefDto"},"hourlyRate":{"type":"number","nullable":true,"deprecated":true,"description":"Kept for backwards compatibility. Use `rateSettings` instead"},"displayName":{"type":"string","readOnly":true},"displayNameShort":{"type":"string"},"description":{"type":"string"},"picture":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"switchCushion":{"$ref":"#/components/schemas/CoachSettingsSwitchCushionDto"},"availabilityWeeklyPlanSessions":{"description":"Each number refers to the Nth 30' slot session number starting on Sunday at 00:00:00.","type":"array","items":{"type":"number","maximum":336,"minimum":0}},"areas":{"$ref":"#/components/schemas/CollectionRefDto"},"studentsList":{"$ref":"#/components/schemas/CoachSettingsStudentsListDto"},"paymentsAccount":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"slug":{"type":"string"},"type":{"type":"string","enum":["ROBOT","HUMAN"],"nullable":true},"_links":{"type":"object"}},"required":["status","tier","tierSettings","rateSettings","hourlyRate","displayName","displayNameShort","description","switchCushion","availabilityWeeklyPlanSessions","areas","studentsList","paymentsAccount","slug","type","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachSettingsSwitchCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"CoachSettingsStudentsListDto":{"type":"object","properties":{"status":{"type":"string","enum":["ENABLED","DISABLED"]}},"required":["status"]}}},"paths":{"/coaches/{coachId}/settings":{"get":{"operationId":"CoachesController_getSettingsById","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `CoachSettings`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsDto"}}}}},"tags":["Coaches"]}}}}
```

## PATCH /coaches/{coachId}/settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsDto":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"tier":{"type":"string","readOnly":true},"tierSettings":{"$ref":"#/components/schemas/ItemRefDto"},"rateSettings":{"$ref":"#/components/schemas/ItemRefDto"},"hourlyRate":{"type":"number","nullable":true,"deprecated":true,"description":"Kept for backwards compatibility. Use `rateSettings` instead"},"displayName":{"type":"string","readOnly":true},"displayNameShort":{"type":"string"},"description":{"type":"string"},"picture":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"switchCushion":{"$ref":"#/components/schemas/CoachSettingsSwitchCushionDto"},"availabilityWeeklyPlanSessions":{"description":"Each number refers to the Nth 30' slot session number starting on Sunday at 00:00:00.","type":"array","items":{"type":"number","maximum":336,"minimum":0}},"areas":{"$ref":"#/components/schemas/CollectionRefDto"},"studentsList":{"$ref":"#/components/schemas/CoachSettingsStudentsListDto"},"paymentsAccount":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"slug":{"type":"string"},"type":{"type":"string","enum":["ROBOT","HUMAN"],"nullable":true},"_links":{"type":"object"}},"required":["status","tier","tierSettings","rateSettings","hourlyRate","displayName","displayNameShort","description","switchCushion","availabilityWeeklyPlanSessions","areas","studentsList","paymentsAccount","slug","type","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachSettingsSwitchCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"CoachSettingsStudentsListDto":{"type":"object","properties":{"status":{"type":"string","enum":["ENABLED","DISABLED"]}},"required":["status"]}}},"paths":{"/coaches/{coachId}/settings":{"patch":{"operationId":"CoachesController_updateSettingsById","parameters":[{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsDto"}}}},"responses":{"200":{"description":"Returns a `CoachSettings`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}/settings/areas

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsAreaCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachSettingsAreaDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachSettingsAreaDto":{"type":"object","properties":{"id":{"type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"distance":{"type":"string","enum":["NEARBY","FARAWAY"]},"noticeCushion":{"$ref":"#/components/schemas/CoachSettingsAreaNoticeCushionDto"},"availability":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityCollectionDto"},"_links":{"type":"object"}},"required":["id","area","distance","noticeCushion","availability","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachSettingsAreaNoticeCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]},"CoachSettingsAreaAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/coaches/{coachId}/settings/areas":{"get":{"operationId":"CoachesController_getSettingsAreasById","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `CoachSettingsAreaCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaCollectionDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}/settings/areas/{coachSettingsAreaId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsAreaDto":{"type":"object","properties":{"id":{"type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"distance":{"type":"string","enum":["NEARBY","FARAWAY"]},"noticeCushion":{"$ref":"#/components/schemas/CoachSettingsAreaNoticeCushionDto"},"availability":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityCollectionDto"},"_links":{"type":"object"}},"required":["id","area","distance","noticeCushion","availability","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachSettingsAreaNoticeCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]},"CoachSettingsAreaAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/coaches/{coachId}/settings/areas/{coachSettingsAreaId}":{"get":{"operationId":"CoachesController_getSettingsAreaById","parameters":[{"name":"coachSettingsAreaId","required":true,"in":"path","schema":{"type":"string"}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `CoachSettingsArea`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaDto"}}}}},"tags":["Coaches"]}}}}
```

## PATCH /coaches/{coachId}/settings/areas/{coachSettingsAreaId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsAreaPatchableDto":{"type":"object","properties":{"distance":{"type":"string","enum":["NEARBY","FARAWAY"]},"noticeCushion":{"$ref":"#/components/schemas/CoachSettingsAreaNoticeCushionDto"}},"required":["distance","noticeCushion"]},"CoachSettingsAreaNoticeCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]},"CoachSettingsAreaDto":{"type":"object","properties":{"id":{"type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"distance":{"type":"string","enum":["NEARBY","FARAWAY"]},"noticeCushion":{"$ref":"#/components/schemas/CoachSettingsAreaNoticeCushionDto"},"availability":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityCollectionDto"},"_links":{"type":"object"}},"required":["id","area","distance","noticeCushion","availability","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachSettingsAreaAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/coaches/{coachId}/settings/areas/{coachSettingsAreaId}":{"patch":{"operationId":"CoachesController_patchSettingsAreaById","parameters":[{"name":"coachSettingsAreaId","required":true,"in":"path","schema":{"type":"string"}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaPatchableDto"}}}},"responses":{"200":{"description":"Returns a `CoachSettingsArea`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}/settings/areas/{coachSettingsAreaId}/availability

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsAreaAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/coaches/{coachId}/settings/areas/{coachSettingsAreaId}/availability":{"get":{"operationId":"CoachesController_getSettingsAreaAvailabilityById","parameters":[{"name":"coachSettingsAreaId","required":true,"in":"path","schema":{"type":"string"}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `CoachSettingsAreaAvailabilityCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityCollectionDto"}}}}},"tags":["Coaches"]}}}}
```

## POST /coaches/{coachId}/settings/areas/{coachSettingsAreaId}/availability

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]}}},"paths":{"/coaches/{coachId}/settings/areas/{coachSettingsAreaId}/availability":{"post":{"operationId":"CoachesController_createSettingsAreaAvailabilityById","parameters":[{"name":"coachSettingsAreaId","required":true,"in":"path","schema":{"type":"string"}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}}}},"responses":{"200":{"description":"Returns a `CoachSettingsAreaAvailability`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}}}}},"tags":["Coaches"]}}}}
```

## PATCH /coaches/{coachId}/settings/areas/{coachSettingsAreaId}/availability

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachSettingsAreaAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/coaches/{coachId}/settings/areas/{coachSettingsAreaId}/availability":{"patch":{"operationId":"CoachesController_replaceSettingsAreaAvailabilityById","parameters":[{"name":"coachSettingsAreaId","required":true,"in":"path","schema":{"type":"string"}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityCollectionDto"}}}},"responses":{"200":{"description":"Returns a `CoachSettingsAreaAvailabilityCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachSettingsAreaAvailabilityCollectionDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}/students

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UserCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"UserDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"email":{"type":"string","format":"email","readOnly":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"description":{"type":"string"},"notes":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"phoneNumberPreview":{"type":"string","readOnly":true},"phoneNumber":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"roles":{"type":"array","readOnly":false,"items":{"type":"string","enum":["ADMIN","PODPLAY_ADMIN","OWNER","CLUB_OWNER","KIOSK","SECURITY","COACH","MANAGER","STAFF","BETA_TESTER"]}},"rolesAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipType":{"type":"string","enum":["NONE","GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"],"readOnly":true,"deprecated":true},"membershipArea":{"readOnly":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipBookingHorizonDays":{"type":"number","readOnly":true,"deprecated":true},"flags":{"type":"array","items":{"type":"string","enum":["NEW","BLOCKED","VACCINATED","ANONYMOUS","HAS_REPLAYS","HAS_RESERVATIONS","HAS_NOTES","HAS_ADMIN_DASHBOARD_ACCESS","JOINED_CHAT","ACTIVE_DAY_PASS"]}},"paymentMethod":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"paymentElements":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"freeQuickReplays":{"type":"number"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"favoriteReplays":{"type":"object","readOnly":true},"profile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"coachProfile":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"qrCode":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipEnrollment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscription":{"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscriptionHistory":{"readOnly":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"ratings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"securityPicture":{"$ref":"#/components/schemas/ItemRefDto"},"chat":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"segmentation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","email","description","rolesAreas","membershipType","flags","favoriteReplays","coachProfile","membershipEnrollment","membershipSubscription","membershipSubscriptionHistory","ratings","chat","segmentation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}},"paths":{"/coaches/{coachId}/students":{"get":{"operationId":"CoachesController_getStudentsById","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `UserProfileCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCollectionDto"}}}}},"tags":["Coaches"]}}}}
```

## POST /coaches/{coachId}/students

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"UserDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"email":{"type":"string","format":"email","readOnly":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"description":{"type":"string"},"notes":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"phoneNumberPreview":{"type":"string","readOnly":true},"phoneNumber":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"roles":{"type":"array","readOnly":false,"items":{"type":"string","enum":["ADMIN","PODPLAY_ADMIN","OWNER","CLUB_OWNER","KIOSK","SECURITY","COACH","MANAGER","STAFF","BETA_TESTER"]}},"rolesAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipType":{"type":"string","enum":["NONE","GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"],"readOnly":true,"deprecated":true},"membershipArea":{"readOnly":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipBookingHorizonDays":{"type":"number","readOnly":true,"deprecated":true},"flags":{"type":"array","items":{"type":"string","enum":["NEW","BLOCKED","VACCINATED","ANONYMOUS","HAS_REPLAYS","HAS_RESERVATIONS","HAS_NOTES","HAS_ADMIN_DASHBOARD_ACCESS","JOINED_CHAT","ACTIVE_DAY_PASS"]}},"paymentMethod":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"paymentElements":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"freeQuickReplays":{"type":"number"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"favoriteReplays":{"type":"object","readOnly":true},"profile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"coachProfile":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"qrCode":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipEnrollment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscription":{"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscriptionHistory":{"readOnly":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"ratings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"securityPicture":{"$ref":"#/components/schemas/ItemRefDto"},"chat":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"segmentation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","email","description","rolesAreas","membershipType","flags","favoriteReplays","coachProfile","membershipEnrollment","membershipSubscription","membershipSubscriptionHistory","ratings","chat","segmentation","_links"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}}}},"paths":{"/coaches/{coachId}/students":{"post":{"operationId":"CoachesController_addStudentById","parameters":[{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemRefDto"}}}},"responses":{"201":{"description":"Returns a `User`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDto"}}}}},"tags":["Coaches"]}}}}
```

## DELETE /coaches/{coachId}/students/{userId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UserDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"email":{"type":"string","format":"email","readOnly":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"description":{"type":"string"},"notes":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"phoneNumberPreview":{"type":"string","readOnly":true},"phoneNumber":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"roles":{"type":"array","readOnly":false,"items":{"type":"string","enum":["ADMIN","PODPLAY_ADMIN","OWNER","CLUB_OWNER","KIOSK","SECURITY","COACH","MANAGER","STAFF","BETA_TESTER"]}},"rolesAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipType":{"type":"string","enum":["NONE","GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"],"readOnly":true,"deprecated":true},"membershipArea":{"readOnly":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipBookingHorizonDays":{"type":"number","readOnly":true,"deprecated":true},"flags":{"type":"array","items":{"type":"string","enum":["NEW","BLOCKED","VACCINATED","ANONYMOUS","HAS_REPLAYS","HAS_RESERVATIONS","HAS_NOTES","HAS_ADMIN_DASHBOARD_ACCESS","JOINED_CHAT","ACTIVE_DAY_PASS"]}},"paymentMethod":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"paymentElements":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"freeQuickReplays":{"type":"number"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"favoriteReplays":{"type":"object","readOnly":true},"profile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"coachProfile":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"qrCode":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipEnrollment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscription":{"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscriptionHistory":{"readOnly":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"ratings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"securityPicture":{"$ref":"#/components/schemas/ItemRefDto"},"chat":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"segmentation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","email","description","rolesAreas","membershipType","flags","favoriteReplays","coachProfile","membershipEnrollment","membershipSubscription","membershipSubscriptionHistory","ratings","chat","segmentation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}}}},"paths":{"/coaches/{coachId}/students/{userId}":{"delete":{"operationId":"CoachesController_removeStudentByIds","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}},{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `User`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDto"}}}}},"tags":["Coaches"]}}}}
```

## GET /coaches/{coachId}/settings/payments-account

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaymentsAccountDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"userId":{"type":"string","readOnly":true},"stripeAccountId":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ENABLED","PENDING","DISABLED"],"readOnly":true},"accountLinkUrl":{"type":"string","readOnly":true},"loginLinkUrl":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","userId","stripeAccountId","status","accountLinkUrl","loginLinkUrl","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}},"paths":{"/coaches/{coachId}/settings/payments-account":{"get":{"operationId":"CoachesController_getCoachSettingsPayments","parameters":[{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `PaymentsAccountDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsAccountDto"}}}}},"tags":["Coaches"]}}}}
```

## POST /coaches/{coachId}/settings/payments-account

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaymentsAccountDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"userId":{"type":"string","readOnly":true},"stripeAccountId":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ENABLED","PENDING","DISABLED"],"readOnly":true},"accountLinkUrl":{"type":"string","readOnly":true},"loginLinkUrl":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","userId","stripeAccountId","status","accountLinkUrl","loginLinkUrl","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}},"paths":{"/coaches/{coachId}/settings/payments-account":{"post":{"operationId":"CoachesController_createCoachSettingsPayments","parameters":[{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsAccountDto"}}}},"responses":{"201":{"description":"Returns a `PaymentsAccountDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsAccountDto"}}}}},"tags":["Coaches"]}}}}
```

## DELETE /coaches/{coachId}/settings/payments-account

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaymentsAccountDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"userId":{"type":"string","readOnly":true},"stripeAccountId":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ENABLED","PENDING","DISABLED"],"readOnly":true},"accountLinkUrl":{"type":"string","readOnly":true},"loginLinkUrl":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","userId","stripeAccountId","status","accountLinkUrl","loginLinkUrl","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}},"paths":{"/coaches/{coachId}/settings/payments-account":{"delete":{"operationId":"CoachesController_deleteCoachSettingsPaymentsAccount","parameters":[{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `PaymentsAccountDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsAccountDto"}}}}},"tags":["Coaches"]}}}}
```

## PATCH /coaches/{coachId}/settings/payments-account

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaymentsAccountDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"userId":{"type":"string","readOnly":true},"stripeAccountId":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ENABLED","PENDING","DISABLED"],"readOnly":true},"accountLinkUrl":{"type":"string","readOnly":true},"loginLinkUrl":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","userId","stripeAccountId","status","accountLinkUrl","loginLinkUrl","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}},"paths":{"/coaches/{coachId}/settings/payments-account":{"patch":{"operationId":"CoachesController_updateCoachSettingsPaymentsAccount","parameters":[{"name":"coachId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsAccountDto"}}}},"responses":{"200":{"description":"Returns a `PaymentsAccountDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsAccountDto"}}}}},"tags":["Coaches"]}}}}
```

## POST /coaches/{coachId}/orders

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Coaches","description":"Coach profiles, tiers, availability, and lesson bookings."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CoachTransferDto":{"type":"object","properties":{"amount":{"type":"number","writeOnly":true},"description":{"type":"string","writeOnly":true},"event":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["amount","description","event"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"OrderDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"settlingDate":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","INVALID","PENDING","CONFIRMED","CANCELED","PARTIALLY_CANCELED","CHARGE_FAILED","REFUNDED","PARTIALLY_REFUNDED","REQUIRES_AUTHENTICATION","PROCESSING"]},"source":{"type":"string","enum":["BOOKING","COACHING","EVENT_SIGNUP","SERIES_SIGNUP","CHECK_IN","REPLAY","POD_SHOP","VENDING_MACHINE","CUSTOMER_SERVICE","MEMBERSHIP","RESCHEDULE","INVITATION"],"readOnly":true},"paymentMethod":{"type":"string","enum":["CASH","CARD","POS"]},"currency":{"type":"string","readOnly":true,"description":"A three letter code in upper case as described in https://www.iso.org/iso-4217-currency-codes.html"},"subtotal":{"type":"number","readOnly":true},"tax":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TaxDto"}]},"fee":{"type":"number","readOnly":true},"fees":{"type":"number","readOnly":true},"discount":{"type":"number","readOnly":true},"virtualCredits":{"type":"number"},"taxExempt":{"type":"boolean","default":false},"total":{"type":"number","readOnly":true},"capturedTotal":{"type":"number","readOnly":true},"vendingMachineOrderId":{"type":"string"},"items":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/OrderItemDto"}},"creator":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"areas":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"pod":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"event":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"payments":{"type":"object","readOnly":true},"transfers":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TransferCollectionDto"}]},"cancellations":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrderItemCancellationCollectionDto"}]},"products":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/DeprecatedProductCollectionDto"}]},"events":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventCollectionDto"}]},"replays":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventCollectionDto"}]},"coupon":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"passes":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"virtualCreditsTransactions":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/VirtualCreditsTransactionsPaginatedCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","code","createdDate","settlingDate","type","source","paymentMethod","currency","subtotal","tax","taxes","fee","fees","discount","total","capturedTotal","items","creator","user","areas","pod","event","payments","transfers","cancellations","products","events","replays","coupon","passes","virtualCreditsTransactions","errors","_links"]},"TaxDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true,"description":"Amount (in $) corresponding to this tax item"},"percentage":{"type":"number","readOnly":true,"description":"Tax percentage that was applied to a subtotal amount, used to display the tax rate. eg: {TaxName}: 9%"}},"required":["name","amount","percentage"]},"OrderItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SPOT","SERIES_SIGNUP","PRODUCT","PADDLE_RENTAL","MEMBERSHIP","GIFT_CARD","CLUB_COACHING_SESSION","KIDS_AND_BEGINNERS_COACHING_SESSION","NATIONAL_COACHING_SESSION","NATIONAL_PLUS_COACHING_SESSION","CAMP","PODLINGS","PODSTERS","PRIVATE_EVENT","CONVENIENCE_FEE","INFRACTION_FINE","GUESTS","REPLAY","VARIOUS","COACHING_SESSION","KIDS_CLASS","RESCHEDULE","COURT_SWITCH","DAY_PASS","SHOP"]},"name":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255},"quantity":{"type":"number"},"price":{"type":"number"},"subtotal":{"type":"number","readOnly":true},"tax":{"type":"number","readOnly":true},"fee":{"type":"number","readOnly":true},"discount":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"productOffering":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"posProductOffering":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"product":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"event":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"replay":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["id","type","name","description","quantity","price","subtotal","tax","fee","discount","total","productOffering","posProductOffering","product","event","replay"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"TransferCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TransferDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TransferDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true},"reversedAmount":{"type":"number","readOnly":true,"nullable":true},"reversedDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"currency":{"type":"string","readOnly":true},"status":{"type":"string","enum":["PENDING","FAILED","TRANSFERRED","REVERSED"],"readOnly":true},"transferDate":{"format":"date-time","type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"payment":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"reversedByUser":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","amount","reversedAmount","reversedDate","currency","status","transferDate","stripe","payment","user","reversedByUser","_links"]},"OrderItemCancellationCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemCancellationDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"OrderItemCancellationDto":{"type":"object","properties":{"id":{"type":"string"},"event":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrderItemCancellationSummaryDto"}]},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["id","event","summary","_links"]},"OrderItemCancellationSummaryDto":{"type":"object","properties":{"policy":{"type":"string","enum":["FREE_OF_CHARGE","10MIN_GRACE","PLUS_6HS_IN_ADVANCE","PLUS_12HS_IN_ADVANCE","PLUS_24HS_IN_ADVANCE","BETWEEN_12HS_TO_2HS_IN_ADVANCE","24HS_OR_LESS_IN_ADVANCE","2HS_OR_LESS_IN_ADVANCE","FULL_REFUND_VIRTUAL_CREDITS","FULL_REFUND","NO_REFUND","CANCELED_BY_ADMIN","TENANT_CUSTOM"],"readOnly":true},"policySubtype":{"type":"object","readOnly":true},"policyDescription":{"type":"object","readOnly":true},"extensionId":{"type":"object","readOnly":true},"cancellingUser":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"cancellationTime":{"format":"date-time","type":"string","readOnly":true},"validUntilTime":{"format":"date-time","type":"string","readOnly":true},"cancellationFee":{"type":"number","readOnly":true},"refund":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventCancellationSummaryRefundDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["policy","policySubtype","policyDescription","extensionId","cancellingUser","cancellationTime","validUntilTime","cancellationFee","refund","errors"]},"UserProfileDto":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/components/schemas/ItemRefDto"},"type":{"type":"string","enum":["REGULAR","GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER","COACH"],"readOnly":true},"membershipArea":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"gender":{"type":"string","readOnly":true},"birthday":{"format":"date-time","type":"string","readOnly":true},"initials":{"type":"string","readOnly":true},"description":{"type":"string"},"picture":{"type":"object","readOnly":true,"nullable":true},"usattRating":{"type":"number","readOnly":true,"nullable":true},"duprProfileUrl":{"type":"string","readOnly":true,"nullable":true},"memberSince":{"format":"date-time","type":"string","readOnly":true},"membershipSubscription":{"type":"object","nullable":true,"readOnly":true,"deprecated":true},"membershipEnrollment":{"type":"object","nullable":true,"readOnly":true},"kids":{"type":"object","nullable":true,"readOnly":true},"_links":{"type":"object"}},"required":["id","user","type","description","memberSince","kids","_links"]},"EventCancellationSummaryRefundDto":{"type":"object","properties":{"reimbursement":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"passes":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]}},"required":["reimbursement","virtualCredits","passes"]},"OrderPassCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderPassDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"OrderPassDto":{"type":"object","properties":{"id":{"type":"object"},"available":{"type":"number","readOnly":true,"description":"Either for applicable or refundable passes this represents potential but not the actual number to be applied/refunded"},"quantity":{"type":"number","readOnly":true,"description":"Either for applicable or refundable passes this represents actual number to be applied/refunded"},"displayName":{"type":"string","readOnly":true},"displayNamePlural":{"type":"string","readOnly":true},"rate":{"type":"number","readOnly":true}},"required":["id","available","quantity","displayName","displayNamePlural","rate"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"DeprecatedProductCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeprecatedProductDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"DeprecatedProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"sku":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["LIFESTYLE","MERCHANDISE","EQUIPMENT","SNACK","FOOD","DRINKS","CUSTOM_REPLAY","QUICK_REPLAY","ENHANCED_REPLAY","MEMBERSHIP","BOOKING","EVENT_SIGNUP","SERIES_SIGNUP","VENDING_MACHINE","OTHER","APPAREL","CAMP","PODLINGS","PODSTERS","GIFT_CARD","PRIVATE_EVENT","CONVENIENCE_FEE","INFRACTION_FINE","GUEST_SPOT","PADDLE_RENTAL","CLUB_COACHING_SESSION","KIDS_AND_BEGINNERS_COACHING_SESSION","NATIONAL_COACHING_SESSION","NATIONAL_PLUS_COACHING_SESSION","OLYMPIC_COACHING_SESSION","HITTING_PARTNER_COACHING_SESSION","COACHING_SESSION","RESCHEDULE","COURT_SWITCH","TABLE","GUESTS","GENERIC","WATER","ALCOHOL","SHOP"]},"images":{"readOnly":true,"deprecated":true,"type":"array","items":{"type":"string"}},"picture":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/DeprecatedProductPictureDto"}]},"price":{"type":"number"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"_links":{"type":"object"}},"required":["id","sku","name","description","type","images","picture","price","areas","_links"]},"DeprecatedProductPictureDto":{"type":"object","properties":{"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"}},"required":["small","medium","large"]},"EventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventDto"}},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["REGULAR","CLASS","EVENT","INTERNAL"],"readOnly":true},"subtype":{"type":"string","enum":["OPERATIONS","PRIVATE","COACHING","KIDS_CLASS","ADULT_CLASS","OPEN_PLAY","LEAGUE_NIGHT","TOURNAMENT","PARTY","PRIVATE_EVENT"]},"customType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"pods":{"$ref":"#/components/schemas/PodCollectionDto"},"tables":{"$ref":"#/components/schemas/EventTableCollectionDto"},"access":{"$ref":"#/components/schemas/AccessDto"},"guests":{"$ref":"#/components/schemas/GuestsDto"},"reservations":{"$ref":"#/components/schemas/ReservationCollectionDto"},"bookingMode":{"type":"string","enum":["USER_BOOKED","FREE_OF_CHARGE"],"readOnly":true},"paymentMethod":{"type":"string","enum":["CASH","CARD","POS"],"readOnly":true},"bookedBy":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"totalTeams":{"type":"number"},"teamSize":{"type":"number"},"admission":{"type":"string","enum":["OPEN","MEMBERS_ONLY","CLOSED"]},"admissionRating":{"$ref":"#/components/schemas/EventAdmissionRatingDto"},"admissionRate":{"$ref":"#/components/schemas/EventAdmissionRateDto"},"admissionDate":{"$ref":"#/components/schemas/EventAdmissionDateDto"},"admissionKids":{"type":"string","enum":["OPEN","CLOSED"]},"allowedMemberships":{"type":"object"},"coachRate":{"type":"number"},"freeSignupCancellationHorizonHours":{"type":"number"},"tags":{"type":"array","items":{"type":"string"}},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"visibility":{"type":"string","enum":["LISTED","UNLISTED"]},"invitations":{"type":"object"},"payments":{"type":"object"},"completeInvitations":{"type":"integer","minimum":0,"maximum":10,"deprecated":true},"replays":{"type":"object"},"cancellation":{"type":"object"},"notes":{"type":"object"},"openInvitations":{"type":"object"},"signups":{"type":"object"},"waitlist":{"type":"object"},"features":{"type":"array","nullable":true,"items":{"type":"string","enum":["WAITLIST","PUBLIC_ATTENDEE_LIST","QUICK_REPLAYS","CUSTOM_REPLAYS","ENHANCED_REPLAYS","SUBMIT_MATCHES_RESULTS","SHOW_SPOTS_LEFT"]}},"stats":{"type":"object"},"series":{"$ref":"#/components/schemas/ItemRefDto"},"suspension":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"status":{"type":"string","enum":["INVALID","DRAFT","CONFIRMED","PUBLISHED"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"tournamentDivision":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TournamentDivisionDto"}]},"visibilitySchedules":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventVisibilityScheduleCollectionDto"}]},"recurrence":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"teams":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventTeamCollectionDto"}]},"_links":{"type":"object"}},"required":["id","type","subtype","customType","name","description","startTime","endTime","pods","tables","access","guests","reservations","bookingMode","paymentMethod","bookedBy","totalTeams","teamSize","admission","admissionRating","admissionRate","admissionDate","admissionKids","allowedMemberships","coachRate","freeSignupCancellationHorizonHours","tags","visibility","invitations","payments","completeInvitations","replays","cancellation","notes","openInvitations","signups","waitlist","features","stats","status","errors","tournamentDivision","visibilitySchedules","recurrence","teams","_links"]},"PodCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PodDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PodDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"description":{"type":"string"},"address":{"$ref":"#/components/schemas/PodAddressDto"},"timezone":{"type":"string"},"type":{"type":"string","enum":["PRIVATE","MULTI_TABLE","ROBOT"]},"status":{"type":"string","enum":["NOT_AVAILABLE","AVAILABLE","TEMPORARILY_CLOSED","COMING_SOON"]},"sport":{"type":"string","enum":["PICKLEBALL","TABLE_TENNIS","POOL","TENNIS","PADDLE","SQUASH","SOCCER","GOLF","RACING_SIMULATOR","CRICKET","BASEBALL","HOCKEY","PETS","CORN_HOLE","SWIMMING"]},"area":{"type":"object"},"tables":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TableCollectionDto"}]},"openTime":{"$ref":"#/components/schemas/TimeDto"},"closeTime":{"$ref":"#/components/schemas/TimeDto"},"closedTimeOverrides":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PodClosedTimeOverrideCollectionDto"}]},"guests":{"$ref":"#/components/schemas/PodGuestsDto"},"rates":{"type":"object"},"settings":{"$ref":"#/components/schemas/PodSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","description","address","timezone","type","status","sport","area","tables","openTime","closeTime","closedTimeOverrides","guests","rates","settings","errors","_links"]},"PodAddressDto":{"type":"object","properties":{"street":{"type":"string"},"floor":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"displayName":{"type":"string"}},"required":["street","floor","city","zip","displayName"]},"TableCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TableDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TableDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["STANDARD","PREMIUM"]},"status":{"type":"string","enum":["AVAILABLE","NOT_AVAILABLE"]},"features":{"type":"array","items":{"type":"string","enum":["REPLAYS","QUICK_REPLAYS","CUSTOM_REPLAYS","ENHANCED_REPLAYS","SCOREBOARD","ROBOT","PRIVATE"]}},"pod":{"type":"object"},"settings":{"$ref":"#/components/schemas/CourtSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","description","type","status","features","pod","settings","errors","_links"]},"CourtSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CourtSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CourtSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"TimeDto":{"type":"object","properties":{"hours":{"type":"number","minimum":0,"maximum":23},"minutes":{"type":"number","minimum":0,"maximum":59}},"required":["hours","minutes"]},"PodClosedTimeOverrideCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PodClosedTimeOverrideDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PodClosedTimeOverrideDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"days":{"type":"array","items":{"type":"number","maximum":6,"minimum":0}},"from":{"$ref":"#/components/schemas/TimeDto"},"to":{"$ref":"#/components/schemas/TimeDto"}},"required":["id","days","from","to"]},"PodGuestsDto":{"type":"object","properties":{"private":{"$ref":"#/components/schemas/ExtraGuestsDto"},"coach":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ExtraGuestsDto"}]}},"required":["private","coach"]},"ExtraGuestsDto":{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}},"required":["min","max"]},"PodSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PodSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PodSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"EventTableCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventTableDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventTableDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["FIXED_TABLE","AUTO"]},"table":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string","readOnly":true},"endTime":{"format":"date-time","type":"string","readOnly":true},"features":{"type":"array","items":{"type":"string","enum":["REPLAYS","QUICK_REPLAYS","CUSTOM_REPLAYS","ENHANCED_REPLAYS","SCOREBOARD","ROBOT","PRIVATE"]}},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["id","type","table","startTime","endTime","features","status","errors","_links"]},"AccessDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["OPEN","RESTRICTED"],"readOnly":true},"startTime":{"format":"date-time","type":"string","readOnly":true},"endTime":{"format":"date-time","type":"string","readOnly":true}},"required":["id","type","startTime","endTime"]},"GuestsDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number","nullable":true}},"required":["displayName","displayNameShort","max"]},"ReservationCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReservationDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ReservationDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"tableAssignment":{"type":"string","enum":["PENDING","LOCKED_BY_SYSTEM","LOCKED_BY_USER","LOCKED_BY_ADMIN","CANCELED_BY_USER","CANCELED_BY_ADMIN"]},"sessions":{"$ref":"#/components/schemas/ReservationSessionCollectionDto"},"pod":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"table":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"coach":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"guests":{"type":"number","nullable":true},"charges":{"$ref":"#/components/schemas/CollectionRefDto"},"quickReplays":{"$ref":"#/components/schemas/CollectionRefDto"},"customReplays":{"$ref":"#/components/schemas/CollectionRefDto"},"_links":{"type":"object"}},"required":["id","startTime","endTime","tableAssignment","sessions","pod","table","coach","guests","charges","quickReplays","customReplays","_links"]},"ReservationSessionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReservationSessionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ReservationSessionDto":{"type":"object","properties":{"id":{"type":"string"},"session":{"$ref":"#/components/schemas/ItemRefDto"},"coupon":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"charge":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","session","coupon","charge","_links"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"EventAdmissionRatingDto":{"type":"object","properties":{"minRating":{"type":"number"},"maxRating":{"type":"number"},"type":{"type":"string","enum":["SINGLES","DOUBLES"]}},"required":["minRating","maxRating","type"]},"EventAdmissionRateDto":{"type":"object","properties":{"regular":{"type":"number"},"member":{"type":"number","readOnly":true},"membersDefault":{"type":"number"},"dayPass":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PodPassRateDto"}]},"memberships":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventAdmissionRateMembershipCollectionDto"}]},"chargingStrategy":{"type":"string","enum":["spot+","court+"],"nullable":true},"_links":{"type":"object"}},"required":["regular","member","membersDefault","dayPass","memberships","chargingStrategy","_links"]},"PodPassRateDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"rate":{"type":"number"}},"required":["id","displayName","rate"]},"EventAdmissionRateMembershipCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventAdmissionRateMembershipDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventAdmissionRateMembershipDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number"}},"required":["membership","rate"]},"EventAdmissionDateDto":{"type":"object","properties":{"regular":{"format":"date-time","type":"string","nullable":true},"member":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"membersDefault":{"format":"date-time","type":"string","nullable":true},"memberships":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventAdmissionDateMembershipCollectionDto"}]},"_links":{"type":"object"}},"required":["regular","member","membersDefault","memberships","_links"]},"EventAdmissionDateMembershipCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventAdmissionDateMembershipDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventAdmissionDateMembershipDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"date":{"format":"date-time","type":"string"}},"required":["date"]},"TournamentDivisionDto":{"type":"object","properties":{"id":{"type":"string","description":"Tournament Division ID","readOnly":true},"tournament":{"description":"Tournament ID","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"provider":{"type":"string","enum":["SWISH","PODPLAY"]},"swish":{"description":"Tournament data specific to Swish","allOf":[{"$ref":"#/components/schemas/SwishDto"}]},"podplay":{"description":"Tournament data specific to PodPlay","allOf":[{"$ref":"#/components/schemas/PodPlayTournamentDto"}]},"status":{"type":"string","enum":["DRAFT","SUCCESS","FAILED"],"description":"Current status of the tournament","readOnly":true},"createdAt":{"format":"date-time","type":"string","description":"When the tournament was created","readOnly":true},"event":{"description":"ID of the event the tournament is associated with","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSyncedAt":{"format":"date-time","type":"string","description":"Last time the tournament was synced with the provider"},"visibility":{"type":"string","enum":["HIDDEN","VISIBLE"],"description":"Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null"},"_links":{"type":"object","readOnly":true}},"required":["id","tournament","provider","event","_links"]},"SwishDto":{"type":"object","properties":{"eventFormat":{"type":"string","enum":["regular_play","rotating_partners_round_robin","set_partners_round_robin","mixed_gender_round_robin","custom_team_format","minor_league_pickleball_round_robin","king_of_the_court","league-rotating_partners_round_robin","league-set_partners_round_robin","league-mixed_gender_round_robin","ladder-league-rotating_partners_round_robin","league-king_of_the_court","league-custom_team_format","league-minor_league_pickleball_round_robin"]},"gameId":{"type":"string"},"editPlayersPath":{"type":"string"}},"required":["eventFormat","editPlayersPath"]},"PodPlayTournamentDto":{"type":"object","properties":{"eventFormat":{"type":"string","description":"The event format for PodPlay tournaments"},"gameId":{"type":"string","description":"Game ID from PodPlay provider"},"url":{"type":"string","description":"URL to the tournament in PodPlay provider"}},"required":["eventFormat","url"]},"EventVisibilityScheduleCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventVisibilityScheduleDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventVisibilityScheduleDto":{"type":"object","properties":{"id":{"type":"string","nullable":true},"event":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"listDaysBefore":{"type":"number"},"membersOnly":{"type":"boolean","nullable":true},"executed":{"type":"boolean","readOnly":true,"nullable":true},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","event","listDaysBefore","membersOnly","executed","status","errors","_links"]},"EventTeamCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventTeamDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventTeamDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"teamLeader":{"$ref":"#/components/schemas/UserProfileDto"},"teamMembers":{"$ref":"#/components/schemas/UserProfileCollectionDto"},"teamMemberCount":{"type":"number"}},"required":["id","teamLeader","teamMembers","teamMemberCount"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"VirtualCreditsTransactionsPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCreditsTransactionDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_total","_links"]},"VirtualCreditsTransactionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"amountType":{"type":"string","enum":["INCOME","OUTCOME"]},"amount":{"type":"number"},"balance":{"type":"number","readOnly":true},"source":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","SYSTEM","CANCELLATION","RESCHEDULE","REFUND","CUSTOMER_SERVICE","INVITATION","SQUARE_GIFT_CARD"],"readOnly":true},"reason":{"type":"string"},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","order","user","createdAt","amountType","amount","balance","source","updatedBy","_links"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/coaches/{coachId}/orders":{"post":{"operationId":"CoachesOrdersController_create","parameters":[{"name":"coachId","required":true,"in":"path","description":"The ID of the coach","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoachTransferDto"}}}},"responses":{"201":{"description":"Returns an `Order`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"}}}},"400":{"description":"Returns an `ErrorDto` in case of missing or incorrect request parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Coaches"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/coaching/coaches.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.