> 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/models.md). # Models ## The UserMembershipSubscriptionSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserMembershipSubscriptionSummaryDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"type":"object","readOnly":true},"amount":{"type":"number","readOnly":true},"_links":{"type":"object","readOnly":true}},"required":["id","user","amount","_links"]}}}} ``` ## The LinkDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}} ``` ## The LinksDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The UserMembershipSubscriptionSummaryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserMembershipSubscriptionSummaryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserMembershipSubscriptionSummaryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"UserMembershipSubscriptionSummaryDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"type":"object","readOnly":true},"amount":{"type":"number","readOnly":true},"_links":{"type":"object","readOnly":true}},"required":["id","user","amount","_links"]},"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"]}}}} ``` ## The MembershipJobCaptureDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipJobCaptureDto":{"type":"object","properties":{"type":{"type":"string","writeOnly":true},"date":{"format":"date-time","type":"string"},"job":{"type":"object","readOnly":true},"users":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserMembershipSubscriptionSummaryCollectionDto"}]},"_links":{"type":"object"}},"required":["type","job","users","_links"]},"UserMembershipSubscriptionSummaryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserMembershipSubscriptionSummaryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"UserMembershipSubscriptionSummaryDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"type":"object","readOnly":true},"amount":{"type":"number","readOnly":true},"_links":{"type":"object","readOnly":true}},"required":["id","user","amount","_links"]},"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"]}}}} ``` ## The ItemRefDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The MembershipSubscriptionPauseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSubscriptionPauseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Unique identifier for the pause record"},"pauseStartDate":{"format":"date-time","type":"string","readOnly":true,"description":"The date when the pause started"},"pauseEndDate":{"format":"date-time","type":"string","readOnly":true,"description":"The date when the pause is scheduled to end"},"pauseDurationWeeks":{"type":"number","readOnly":true,"description":"Duration of the pause in weeks"},"pauseFeePaid":{"type":"number","readOnly":true,"nullable":true,"description":"The fee that was paid for the pause"},"status":{"type":"string","enum":["PENDING","ACTIVE","COMPLETED"],"readOnly":true,"description":"Current status of the pause (derived from dates)"},"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"When the pause record was created"},"membershipSubscription":{"readOnly":true,"description":"Reference to the membership subscription","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","pauseStartDate","pauseEndDate","pauseDurationWeeks","pauseFeePaid","status","createdAt","membershipSubscription","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The TaxDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The FeeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"FeeDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee (e.g., \"Credit Card Fee\", \"Processing Fee\")"},"percentage":{"type":"number","description":"The percentage rate of the fee","minimum":0,"maximum":100},"amount":{"type":"number","description":"The amount of the fee"}},"required":["name","percentage","amount"]}}}} ``` ## The ValidationErrorDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The MessageDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipSubscriptionSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSubscriptionSummaryDto":{"type":"object","properties":{"total":{"type":"number","description":"Total amount including taxes and fees"},"membershipPrice":{"type":"number","description":"Membership base price"},"taxes":{"description":"Tax breakdown details","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"fees":{"description":"Fee breakdown details","type":"array","items":{"$ref":"#/components/schemas/FeeDto"}},"messages":{"description":"Confirmation messages for the subscription","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"billingCycleStart":{"format":"date-time","type":"string","nullable":true,"description":"Billing cycle start date for recurring subscriptions"},"endDate":{"format":"date-time","type":"string","nullable":true,"description":"End date for non-recurring subscriptions"},"initiationFee":{"type":"number","nullable":true,"description":"Initiation fee if applicable"},"chargeType":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"],"description":"Type of charge for the subscription"}},"required":["total","membershipPrice","taxes","fees","messages","billingCycleStart","endDate","initiationFee","chargeType"]},"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"]},"FeeDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee (e.g., \"Credit Card Fee\", \"Processing Fee\")"},"percentage":{"type":"number","description":"The percentage rate of the fee","minimum":0,"maximum":100},"amount":{"type":"number","description":"The amount of the fee"}},"required":["name","percentage","amount"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipSubscriptionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSubscriptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"status":{"type":"string","enum":["DRAFT","CHARGE_FAILED","REQUIRES_AUTHENTICATION","CONFIRMED"]},"extendedStatus":{"type":"string","enum":["ACTIVE","PENDING_CANCEL","CANCELLED","VALID","GRACE","HOLD","PAUSED","PENDING_PAUSE"]},"mode":{"type":"string","enum":["PREVIEW","ORDER"]},"condition":{"type":"string","enum":["VALID","GRACE","HOLD"],"readOnly":true},"conditionUpdatedDate":{"format":"date-time","type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"cancellationRequestDate":{"format":"date-time","type":"string"},"lastChargeDate":{"format":"date-time","type":"string"},"nextChargeDate":{"format":"date-time","type":"string"},"lastGrantDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true,"description":"The last time the membership perks were granted to the user"},"nextGrantDate":{"format":"date-time","type":"string"},"billingCycleStart":{"format":"date-time","type":"string"},"billingCycleEnd":{"format":"date-time","type":"string"},"activePause":{"nullable":true,"description":"The current active or pending pause for this subscription","allOf":[{"$ref":"#/components/schemas/MembershipSubscriptionPauseDto"}]},"timezone":{"type":"string","description":"The timezone used to display and calculate charge and grant dates for the subscription."},"price":{"type":"number","nullable":true},"initiationFee":{"type":"number","nullable":true},"durationDays":{"type":"number","nullable":true,"description":"The number of days the membership will be active for if the charge type is non-recurring"},"oneTimeOption":{"nullable":true,"description":"The one-time price option ID for non-recurring memberships","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"total":{"type":"number","nullable":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"fees":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/FeeDto"}},"additionalMemberFee":{"type":"number","nullable":true},"chargeType":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"]},"member":{"$ref":"#/components/schemas/ItemRefDto"},"membership":{"$ref":"#/components/schemas/ItemRefDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"order":{"$ref":"#/components/schemas/ItemRefDto"},"summary":{"readOnly":true,"nullable":true,"description":"Only available if the mode is PREVIEW","allOf":[{"$ref":"#/components/schemas/MembershipSubscriptionSummaryDto"}]},"_links":{"type":"object"}},"required":["id","displayName","type","status","extendedStatus","mode","condition","conditionUpdatedDate","createdDate","startDate","endDate","cancellationRequestDate","lastChargeDate","nextChargeDate","lastGrantDate","nextGrantDate","billingCycleStart","billingCycleEnd","activePause","timezone","price","initiationFee","durationDays","oneTimeOption","total","taxes","fees","additionalMemberFee","chargeType","member","membership","errors","order","summary","_links"]},"MembershipSubscriptionPauseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Unique identifier for the pause record"},"pauseStartDate":{"format":"date-time","type":"string","readOnly":true,"description":"The date when the pause started"},"pauseEndDate":{"format":"date-time","type":"string","readOnly":true,"description":"The date when the pause is scheduled to end"},"pauseDurationWeeks":{"type":"number","readOnly":true,"description":"Duration of the pause in weeks"},"pauseFeePaid":{"type":"number","readOnly":true,"nullable":true,"description":"The fee that was paid for the pause"},"status":{"type":"string","enum":["PENDING","ACTIVE","COMPLETED"],"readOnly":true,"description":"Current status of the pause (derived from dates)"},"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"When the pause record was created"},"membershipSubscription":{"readOnly":true,"description":"Reference to the membership subscription","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","pauseStartDate","pauseEndDate","pauseDurationWeeks","pauseFeePaid","status","createdAt","membershipSubscription","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"FeeDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee (e.g., \"Credit Card Fee\", \"Processing Fee\")"},"percentage":{"type":"number","description":"The percentage rate of the fee","minimum":0,"maximum":100},"amount":{"type":"number","description":"The amount of the fee"}},"required":["name","percentage","amount"]},"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"]},"MembershipSubscriptionSummaryDto":{"type":"object","properties":{"total":{"type":"number","description":"Total amount including taxes and fees"},"membershipPrice":{"type":"number","description":"Membership base price"},"taxes":{"description":"Tax breakdown details","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"fees":{"description":"Fee breakdown details","type":"array","items":{"$ref":"#/components/schemas/FeeDto"}},"messages":{"description":"Confirmation messages for the subscription","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"billingCycleStart":{"format":"date-time","type":"string","nullable":true,"description":"Billing cycle start date for recurring subscriptions"},"endDate":{"format":"date-time","type":"string","nullable":true,"description":"End date for non-recurring subscriptions"},"initiationFee":{"type":"number","nullable":true,"description":"Initiation fee if applicable"},"chargeType":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"],"description":"Type of charge for the subscription"}},"required":["total","membershipPrice","taxes","fees","messages","billingCycleStart","endDate","initiationFee","chargeType"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipSubscriptionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSubscriptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSubscriptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSubscriptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"status":{"type":"string","enum":["DRAFT","CHARGE_FAILED","REQUIRES_AUTHENTICATION","CONFIRMED"]},"extendedStatus":{"type":"string","enum":["ACTIVE","PENDING_CANCEL","CANCELLED","VALID","GRACE","HOLD","PAUSED","PENDING_PAUSE"]},"mode":{"type":"string","enum":["PREVIEW","ORDER"]},"condition":{"type":"string","enum":["VALID","GRACE","HOLD"],"readOnly":true},"conditionUpdatedDate":{"format":"date-time","type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"cancellationRequestDate":{"format":"date-time","type":"string"},"lastChargeDate":{"format":"date-time","type":"string"},"nextChargeDate":{"format":"date-time","type":"string"},"lastGrantDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true,"description":"The last time the membership perks were granted to the user"},"nextGrantDate":{"format":"date-time","type":"string"},"billingCycleStart":{"format":"date-time","type":"string"},"billingCycleEnd":{"format":"date-time","type":"string"},"activePause":{"nullable":true,"description":"The current active or pending pause for this subscription","allOf":[{"$ref":"#/components/schemas/MembershipSubscriptionPauseDto"}]},"timezone":{"type":"string","description":"The timezone used to display and calculate charge and grant dates for the subscription."},"price":{"type":"number","nullable":true},"initiationFee":{"type":"number","nullable":true},"durationDays":{"type":"number","nullable":true,"description":"The number of days the membership will be active for if the charge type is non-recurring"},"oneTimeOption":{"nullable":true,"description":"The one-time price option ID for non-recurring memberships","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"total":{"type":"number","nullable":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"fees":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/FeeDto"}},"additionalMemberFee":{"type":"number","nullable":true},"chargeType":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"]},"member":{"$ref":"#/components/schemas/ItemRefDto"},"membership":{"$ref":"#/components/schemas/ItemRefDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"order":{"$ref":"#/components/schemas/ItemRefDto"},"summary":{"readOnly":true,"nullable":true,"description":"Only available if the mode is PREVIEW","allOf":[{"$ref":"#/components/schemas/MembershipSubscriptionSummaryDto"}]},"_links":{"type":"object"}},"required":["id","displayName","type","status","extendedStatus","mode","condition","conditionUpdatedDate","createdDate","startDate","endDate","cancellationRequestDate","lastChargeDate","nextChargeDate","lastGrantDate","nextGrantDate","billingCycleStart","billingCycleEnd","activePause","timezone","price","initiationFee","durationDays","oneTimeOption","total","taxes","fees","additionalMemberFee","chargeType","member","membership","errors","order","summary","_links"]},"MembershipSubscriptionPauseDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Unique identifier for the pause record"},"pauseStartDate":{"format":"date-time","type":"string","readOnly":true,"description":"The date when the pause started"},"pauseEndDate":{"format":"date-time","type":"string","readOnly":true,"description":"The date when the pause is scheduled to end"},"pauseDurationWeeks":{"type":"number","readOnly":true,"description":"Duration of the pause in weeks"},"pauseFeePaid":{"type":"number","readOnly":true,"nullable":true,"description":"The fee that was paid for the pause"},"status":{"type":"string","enum":["PENDING","ACTIVE","COMPLETED"],"readOnly":true,"description":"Current status of the pause (derived from dates)"},"createdAt":{"format":"date-time","type":"string","readOnly":true,"description":"When the pause record was created"},"membershipSubscription":{"readOnly":true,"description":"Reference to the membership subscription","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","pauseStartDate","pauseEndDate","pauseDurationWeeks","pauseFeePaid","status","createdAt","membershipSubscription","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"FeeDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee (e.g., \"Credit Card Fee\", \"Processing Fee\")"},"percentage":{"type":"number","description":"The percentage rate of the fee","minimum":0,"maximum":100},"amount":{"type":"number","description":"The amount of the fee"}},"required":["name","percentage","amount"]},"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"]},"MembershipSubscriptionSummaryDto":{"type":"object","properties":{"total":{"type":"number","description":"Total amount including taxes and fees"},"membershipPrice":{"type":"number","description":"Membership base price"},"taxes":{"description":"Tax breakdown details","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"fees":{"description":"Fee breakdown details","type":"array","items":{"$ref":"#/components/schemas/FeeDto"}},"messages":{"description":"Confirmation messages for the subscription","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"billingCycleStart":{"format":"date-time","type":"string","nullable":true,"description":"Billing cycle start date for recurring subscriptions"},"endDate":{"format":"date-time","type":"string","nullable":true,"description":"End date for non-recurring subscriptions"},"initiationFee":{"type":"number","nullable":true,"description":"Initiation fee if applicable"},"chargeType":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"],"description":"Type of charge for the subscription"}},"required":["total","membershipPrice","taxes","fees","messages","billingCycleStart","endDate","initiationFee","chargeType"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]},"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"]}}}} ``` ## The PackageItemConstraintsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]}}}} ``` ## The PackageItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"},"remainingItems":{"type":"number","readOnly":true}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints","remainingItems"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]}}}} ``` ## The PackageItemCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"},"remainingItems":{"type":"number","readOnly":true}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints","remainingItems"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]}}}} ``` ## The PackageItemRedemptionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageItemRedemptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"redemptionDate":{"format":"date-time","type":"string","readOnly":true},"item":{"type":"number","enum":[],"readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orderItem":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"cancelationDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","redemptionDate","item","user","order","orderItem","cancelationDate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The PackageItemRedemptionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageItemRedemptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemRedemptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemRedemptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"redemptionDate":{"format":"date-time","type":"string","readOnly":true},"item":{"type":"number","enum":[],"readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orderItem":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"cancelationDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","redemptionDate","item","user","order","orderItem","cancelationDate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The PackageDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","EXHAUSTED","EXPIRED","CANCELED"],"readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"expirationDate":{"format":"date-time","type":"string"},"items":{"$ref":"#/components/schemas/PackageItemCollectionDto"},"redemptions":{"$ref":"#/components/schemas/PackageItemRedemptionCollectionDto"},"template":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","displayName","displayNamePlural","status","createdDate","expirationDate","items","redemptions","template","order","_links"]},"PackageItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"},"remainingItems":{"type":"number","readOnly":true}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints","remainingItems"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]},"PackageItemRedemptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemRedemptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemRedemptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"redemptionDate":{"format":"date-time","type":"string","readOnly":true},"item":{"type":"number","enum":[],"readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orderItem":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"cancelationDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","redemptionDate","item","user","order","orderItem","cancelationDate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The PackageCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","EXHAUSTED","EXPIRED","CANCELED"],"readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"expirationDate":{"format":"date-time","type":"string"},"items":{"$ref":"#/components/schemas/PackageItemCollectionDto"},"redemptions":{"$ref":"#/components/schemas/PackageItemRedemptionCollectionDto"},"template":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","displayName","displayNamePlural","status","createdDate","expirationDate","items","redemptions","template","order","_links"]},"PackageItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"},"remainingItems":{"type":"number","readOnly":true}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints","remainingItems"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]},"PackageItemRedemptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemRedemptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemRedemptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"redemptionDate":{"format":"date-time","type":"string","readOnly":true},"item":{"type":"number","enum":[],"readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orderItem":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"cancelationDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","redemptionDate","item","user","order","orderItem","cancelationDate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The MembershipSubscriptionPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSubscriptionPatchableDto":{"type":"object","properties":{"lastChargeDate":{"format":"date-time","type":"string"},"nextChargeDate":{"format":"date-time","type":"string"},"nextGrantDate":{"format":"date-time","type":"string"},"timezone":{"type":"string","description":"The timezone used to display and calculate charge and grant dates for the subscription."},"price":{"type":"number","nullable":true}},"required":["lastChargeDate","nextChargeDate","nextGrantDate","timezone","price"]}}}} ``` ## The ErrorDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}}} ``` ## The MembershipEnrollmentDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string","readOnly":true},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"],"readOnly":true},"user":{"$ref":"#/components/schemas/ItemRefDto"},"creatorUser":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membership":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscription":{"$ref":"#/components/schemas/ItemRefDto"},"isOwner":{"type":"boolean","readOnly":true,"nullable":true},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"customFee":{"type":"number","nullable":false,"default":0},"_links":{"type":"object"}},"required":["id","displayName","type","user","creatorUser","membership","membershipSubscription","isOwner","errors","customFee","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The MembershipEnrollmentCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipEnrollmentDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"MembershipEnrollmentDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string","readOnly":true},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"],"readOnly":true},"user":{"$ref":"#/components/schemas/ItemRefDto"},"creatorUser":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membership":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscription":{"$ref":"#/components/schemas/ItemRefDto"},"isOwner":{"type":"boolean","readOnly":true,"nullable":true},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"customFee":{"type":"number","nullable":false,"default":0},"_links":{"type":"object"}},"required":["id","displayName","type","user","creatorUser","membership","membershipSubscription","isOwner","errors","customFee","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The MembershipEnrollmentInvitationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentInvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"acceptedDate":{"format":"date-time","type":"string","readOnly":true},"declinedDate":{"format":"date-time","type":"string","readOnly":true},"membershipSubscription":{"type":"object","readOnly":true},"membership":{"type":"object","readOnly":true},"inviteeEmail":{"type":"string"},"inviter":{"type":"object","readOnly":true},"invitee":{"type":"object","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","status","createdDate","acceptedDate","declinedDate","membershipSubscription","membership","inviteeEmail","inviter","invitee","_links"]},"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"]}}}} ``` ## The MembershipEnrollmentInvitationCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentInvitationCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipEnrollmentInvitationDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"MembershipEnrollmentInvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"acceptedDate":{"format":"date-time","type":"string","readOnly":true},"declinedDate":{"format":"date-time","type":"string","readOnly":true},"membershipSubscription":{"type":"object","readOnly":true},"membership":{"type":"object","readOnly":true},"inviteeEmail":{"type":"string"},"inviter":{"type":"object","readOnly":true},"invitee":{"type":"object","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","status","createdDate","acceptedDate","declinedDate","membershipSubscription","membership","inviteeEmail","inviter","invitee","_links"]},"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"]}}}} ``` ## The MembershipEnrollmentReactivationSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentReactivationSummaryDto":{"type":"object","properties":{"policy":{"type":"string","enum":["FREE_OF_CHARGE","REACTIVATED_BY_ADMIN"],"readOnly":true},"reactivationTime":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["policy","reactivationTime"]},"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"]}}}} ``` ## The MembershipEnrollmentReactivationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentReactivationDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"reason":{"type":"string"},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MembershipEnrollmentReactivationSummaryDto"}]}},"required":["type","reason","summary"]},"MembershipEnrollmentReactivationSummaryDto":{"type":"object","properties":{"policy":{"type":"string","enum":["FREE_OF_CHARGE","REACTIVATED_BY_ADMIN"],"readOnly":true},"reactivationTime":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["policy","reactivationTime"]},"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"]}}}} ``` ## The MembershipEnrollmentCancellationSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentCancellationSummaryDto":{"type":"object","properties":{"policy":{"type":"string","enum":["FREE_OF_CHARGE","CANCELED_BY_ADMIN"],"readOnly":true},"cancellationTime":{"format":"date-time","type":"string","readOnly":true},"validUntilTime":{"format":"date-time","type":"string","readOnly":true},"cancellationFee":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when accepting an invitation. Valid codes are: UMS010, UMS011, UMS012, UMS013","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["policy","cancellationTime","validUntilTime","cancellationFee"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipEnrollmentCancellationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentCancellationDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","FAILED","PENDING","CONFIRMED"],"readOnly":true},"reason":{"type":"string"},"extraMemberFee":{"type":"number"},"immediately":{"type":"boolean"},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MembershipEnrollmentCancellationSummaryDto"}]}},"required":["type","status","reason","extraMemberFee","immediately","summary"]},"MembershipEnrollmentCancellationSummaryDto":{"type":"object","properties":{"policy":{"type":"string","enum":["FREE_OF_CHARGE","CANCELED_BY_ADMIN"],"readOnly":true},"cancellationTime":{"format":"date-time","type":"string","readOnly":true},"validUntilTime":{"format":"date-time","type":"string","readOnly":true},"cancellationFee":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when accepting an invitation. Valid codes are: UMS010, UMS011, UMS012, UMS013","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["policy","cancellationTime","validUntilTime","cancellationFee"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipEnrollmentPauseSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentPauseSummaryDto":{"type":"object","properties":{"pauseStartDate":{"format":"date-time","type":"string","readOnly":true},"pauseEndDate":{"format":"date-time","type":"string","readOnly":true},"pauseDurationWeeks":{"type":"number","readOnly":true},"pauseFee":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["pauseStartDate","pauseEndDate","pauseDurationWeeks","pauseFee"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipEnrollmentPauseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentPauseDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","FAILED","PENDING","CONFIRMED"],"readOnly":true},"durationWeeks":{"type":"number","description":"Duration of pause in weeks"},"pauseFee":{"type":"number"},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MembershipEnrollmentPauseSummaryDto"}]}},"required":["type","status","durationWeeks","pauseFee","summary"]},"MembershipEnrollmentPauseSummaryDto":{"type":"object","properties":{"pauseStartDate":{"format":"date-time","type":"string","readOnly":true},"pauseEndDate":{"format":"date-time","type":"string","readOnly":true},"pauseDurationWeeks":{"type":"number","readOnly":true},"pauseFee":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["pauseStartDate","pauseEndDate","pauseDurationWeeks","pauseFee"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The MembershipEnrollmentUnpauseSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentUnpauseSummaryDto":{"type":"object","properties":{"unpauseTime":{"format":"date-time","type":"string","readOnly":true},"actualPauseDurationWeeks":{"type":"number","readOnly":true},"nextChargeDate":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["unpauseTime","actualPauseDurationWeeks","nextChargeDate"]},"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"]}}}} ``` ## The MembershipEnrollmentUnpauseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipEnrollmentUnpauseDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/MembershipEnrollmentUnpauseSummaryDto"}]}},"required":["type","summary"]},"MembershipEnrollmentUnpauseSummaryDto":{"type":"object","properties":{"unpauseTime":{"format":"date-time","type":"string","readOnly":true},"actualPauseDurationWeeks":{"type":"number","readOnly":true},"nextChargeDate":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["unpauseTime","actualPauseDurationWeeks","nextChargeDate"]},"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"]}}}} ``` ## The ItemRefCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The UserSignupDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserSignupDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"email":{"type":"string","format":"email"},"password":{"type":"string","description":"Minimum requirements: 6 characters long, at least 1 number."},"firstName":{"type":"string"},"lastName":{"type":"string"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"emailMarketingOptIn":{"type":"boolean"},"smsMarketingOptIn":{"type":"boolean"},"requiredAgreements":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"acceptedAgreements":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"phoneVerificationSessionId":{"type":"string","description":"Phone verification session ID from the signup phone verification flow. Required when the tenant has phone number verification enabled on signup."},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","email","errors"]},"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"]}}}} ``` ## The CollectionRefDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}}}}} ``` ## The UserDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"}}}}}} ``` ## The PaginationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The UserCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The UserPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPatchableDto":{"type":"object","properties":{"email":{"type":"string","format":"email","readOnly":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"description":{"type":"string"},"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"}]},"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"]}},"freeQuickReplays":{"type":"number"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"securityPicture":{"$ref":"#/components/schemas/ItemRefDto"}},"required":["email","description","rolesAreas","membershipType","flags"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventReplayPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventReplayPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_total","_links"]},"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"]}}}} ``` ## The UserContactDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserContactDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["EMAIL","PHONE_NUMBER"],"readOnly":true},"email":{"type":"string","readOnly":true},"phoneNumber":{"type":"string","readOnly":true}},"required":["id","type","email","phoneNumber"]}}}} ``` ## The UserContactCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserContactCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserContactDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"UserContactDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["EMAIL","PHONE_NUMBER"],"readOnly":true},"email":{"type":"string","readOnly":true},"phoneNumber":{"type":"string","readOnly":true}},"required":["id","type","email","phoneNumber"]},"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"]}}}} ``` ## The VirtualCreditsTransactionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The VirtualCreditsTransactionsPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The UserPreferencesPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPreferencesPatchableDto":{"type":"object","properties":{"showUserNameOnEvents":{"type":"boolean"},"showUserRatingOnEvents":{"type":"boolean"},"chatOptIn":{"type":"boolean"},"emailMarketingOptIn":{"type":"boolean"},"smsMarketingOptIn":{"type":"boolean"}},"required":["showUserNameOnEvents","showUserRatingOnEvents","chatOptIn","emailMarketingOptIn","smsMarketingOptIn"]}}}} ``` ## The FrontChatDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"FrontChatDto":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"]}}}} ``` ## The ImageDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]}}}} ``` ## The UserChatDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserChatDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["INACTIVE","SETUP_PENDING","OPTED_OUT","ACTIVE"]},"handle":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true},"unreadMessages":{"type":"number","readOnly":true},"avatar":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ImageDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","status","handle","displayName","unreadMessages","avatar","errors"]},"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]}}}} ``` ## The UserChatPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserChatPatchableDto":{"type":"object","properties":{"status":{"type":"string","enum":["INACTIVE","SETUP_PENDING","OPTED_OUT","ACTIVE"]},"termsAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Terms\" along with the chat activation request."}},"required":["status","termsAgreed"]}}}} ``` ## The UserQuotasBookingAreaDailyDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserQuotasBookingAreaDailyDto":{"type":"object","properties":{"isoDate":{"type":"string"},"remainingRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate.","deprecated":true},"remainingPrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate."}},"required":["isoDate","remainingRegularReservations","remainingPrivateReservations"]}}}} ``` ## The UserQuotasBookingAreaDailyCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserQuotasBookingAreaDailyCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyDto"}}},"required":["items"]},"UserQuotasBookingAreaDailyDto":{"type":"object","properties":{"isoDate":{"type":"string"},"remainingRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate.","deprecated":true},"remainingPrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate."}},"required":["isoDate","remainingRegularReservations","remainingPrivateReservations"]}}}} ``` ## The UserQuotasBookingAreaDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserQuotasBookingAreaDto":{"type":"object","properties":{"selectableUnit":{"type":"string","enum":["HOUR","HALF_HOUR"]},"allowMultiReservationBooking":{"type":"boolean"},"minDurationHours":{"type":"number","enum":[0.5,1],"nullable":false,"description":"The default duration is 0.5."},"maxDurationHours":{"type":"number","nullable":true,"description":"`null` means no limit."},"maxFreeOffPeakHours":{"type":"number","nullable":false,"description":"The default limit is 12."},"maxFutureRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit.","deprecated":true},"remainingFutureRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate.","deprecated":true},"remainingRegularReservationsByDay":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyCollectionDto"}]},"maxFuturePrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit."},"remainingFuturePrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate."},"remainingPrivateReservationsByDay":{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyCollectionDto"}},"required":["selectableUnit","allowMultiReservationBooking","minDurationHours","maxDurationHours","maxFreeOffPeakHours","maxFutureRegularReservations","remainingFutureRegularReservations","remainingRegularReservationsByDay","maxFuturePrivateReservations","remainingFuturePrivateReservations","remainingPrivateReservationsByDay"]},"UserQuotasBookingAreaDailyCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyDto"}}},"required":["items"]},"UserQuotasBookingAreaDailyDto":{"type":"object","properties":{"isoDate":{"type":"string"},"remainingRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate.","deprecated":true},"remainingPrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate."}},"required":["isoDate","remainingRegularReservations","remainingPrivateReservations"]}}}} ``` ## The UserBookingSettingsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserBookingSettingsDto":{"type":"object","properties":{"strategy":{"type":"string","enum":["spot+","court+"]},"quotas":{"$ref":"#/components/schemas/UserQuotasBookingAreaDto"}},"required":["strategy","quotas"]},"UserQuotasBookingAreaDto":{"type":"object","properties":{"selectableUnit":{"type":"string","enum":["HOUR","HALF_HOUR"]},"allowMultiReservationBooking":{"type":"boolean"},"minDurationHours":{"type":"number","enum":[0.5,1],"nullable":false,"description":"The default duration is 0.5."},"maxDurationHours":{"type":"number","nullable":true,"description":"`null` means no limit."},"maxFreeOffPeakHours":{"type":"number","nullable":false,"description":"The default limit is 12."},"maxFutureRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit.","deprecated":true},"remainingFutureRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate.","deprecated":true},"remainingRegularReservationsByDay":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyCollectionDto"}]},"maxFuturePrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit."},"remainingFuturePrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate."},"remainingPrivateReservationsByDay":{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyCollectionDto"}},"required":["selectableUnit","allowMultiReservationBooking","minDurationHours","maxDurationHours","maxFreeOffPeakHours","maxFutureRegularReservations","remainingFutureRegularReservations","remainingRegularReservationsByDay","maxFuturePrivateReservations","remainingFuturePrivateReservations","remainingPrivateReservationsByDay"]},"UserQuotasBookingAreaDailyCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserQuotasBookingAreaDailyDto"}}},"required":["items"]},"UserQuotasBookingAreaDailyDto":{"type":"object","properties":{"isoDate":{"type":"string"},"remainingRegularReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate.","deprecated":true},"remainingPrivateReservations":{"type":"number","nullable":true,"description":"`null` means no limit, so no remaining value is possuble to calculate."}},"required":["isoDate","remainingRegularReservations","remainingPrivateReservations"]}}}} ``` ## The UserKidDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserKidDto":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/components/schemas/ItemRefDto"},"firstName":{"type":"string"},"lastName":{"type":"string"},"emergencyContactName":{"type":"string"},"emergencyContactPhoneNumber":{"type":"string"},"selfDismissal":{"type":"boolean"},"pickupAuthorization":{"type":"string"},"allergies":{"type":"string"},"specialInstructions":{"type":"string"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"waiverAccepted":{"type":"boolean","nullable":true,"deprecated":true},"requiredAgreements":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"acceptedAgreements":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","user","firstName","lastName","waiverAccepted","errors"]},"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"]},"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"]}}}} ``` ## The UserKidCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserKidCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserKidDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"UserKidDto":{"type":"object","properties":{"id":{"type":"string"},"user":{"$ref":"#/components/schemas/ItemRefDto"},"firstName":{"type":"string"},"lastName":{"type":"string"},"emergencyContactName":{"type":"string"},"emergencyContactPhoneNumber":{"type":"string"},"selfDismissal":{"type":"boolean"},"pickupAuthorization":{"type":"string"},"allergies":{"type":"string"},"specialInstructions":{"type":"string"},"gender":{"type":"string"},"birthday":{"format":"date-time","type":"string"},"waiverAccepted":{"type":"boolean","nullable":true,"deprecated":true},"requiredAgreements":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"acceptedAgreements":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","user","firstName","lastName","waiverAccepted","errors"]},"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"]},"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"]}}}} ``` ## The EventInvitationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventInvitationDto":{"type":"object","properties":{"id":{"type":"string"},"event":{"$ref":"#/components/schemas/ItemRefDto"},"invitation":{"$ref":"#/components/schemas/ItemRefDto"},"messages":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"_links":{"type":"object"}},"required":["id","event","invitation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The EventInvitationCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventInvitationCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventInvitationDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventInvitationDto":{"type":"object","properties":{"id":{"type":"string"},"event":{"$ref":"#/components/schemas/ItemRefDto"},"invitation":{"$ref":"#/components/schemas/ItemRefDto"},"messages":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"_links":{"type":"object"}},"required":["id","event","invitation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]},"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"]}}}} ``` ## The UserAgreementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserAgreementDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["TERMS_OF_SERVICE","PRIVACY_POLICY","COVID_19_GUIDELINES","POD_RULES","LIABILITY_WAIVER","AREA_LIABILITY_WAIVER","KIDS_WAIVER","AREA_KIDS_WAIVER"]},"status":{"type":"string","enum":["PENDING","AGREED"]},"agreementReleaseTime":{"format":"date-time","type":"string","readOnly":true},"agreementTime":{"format":"date-time","type":"string","readOnly":true},"agreedBy":{"type":"object","readOnly":true},"area":{"type":"object"},"agreement":{"type":"object","readOnly":true},"kid":{"type":"object"},"_links":{"type":"object"}},"required":["id","type","status","agreementReleaseTime","agreementTime","agreedBy","area","agreement","kid","_links"]}}}} ``` ## The UserAgreementCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserAgreementCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserAgreementDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"UserAgreementDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["TERMS_OF_SERVICE","PRIVACY_POLICY","COVID_19_GUIDELINES","POD_RULES","LIABILITY_WAIVER","AREA_LIABILITY_WAIVER","KIDS_WAIVER","AREA_KIDS_WAIVER"]},"status":{"type":"string","enum":["PENDING","AGREED"]},"agreementReleaseTime":{"format":"date-time","type":"string","readOnly":true},"agreementTime":{"format":"date-time","type":"string","readOnly":true},"agreedBy":{"type":"object","readOnly":true},"area":{"type":"object"},"agreement":{"type":"object","readOnly":true},"kid":{"type":"object"},"_links":{"type":"object"}},"required":["id","type","status","agreementReleaseTime","agreementTime","agreedBy","area","agreement","kid","_links"]},"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"]}}}} ``` ## The FeatureFlagDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"FeatureFlagDto":{"type":"object","properties":{"id":{"type":"string"},"enabled":{"type":"boolean"},"config":{"type":"object"}},"required":["id","enabled"]}}}} ``` ## The FeatureFlagsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"FeatureFlagsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FeatureFlagDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"FeatureFlagDto":{"type":"object","properties":{"id":{"type":"string"},"enabled":{"type":"boolean"},"config":{"type":"object"}},"required":["id","enabled"]},"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"]}}}} ``` ## The UserPhoneNumberDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPhoneNumberDto":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verificationCode":{"type":"string","writeOnly":true},"recaptchaToken":{"type":"string","writeOnly":true},"verificationId":{"type":"string","writeOnly":true},"verificationCodeExpiration":{"format":"date-time","type":"string","readOnly":true},"status":{"type":"string","enum":["VERIFIED","UNVERIFIED","MISSING","INVALID"],"readOnly":true},"smsMarketingOptIn":{"type":"boolean"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["phoneNumber","status","errors","_links"]},"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"]},"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"]}}}} ``` ## The PaymentMethodStripeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentMethodStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"userId":{"type":"string"}}}}}} ``` ## The PaymentCardStripeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]}}}} ``` ## The PaymentCardDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentCardDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardStripeDto"}]},"brand":{"type":"string","readOnly":true},"numberPreview":{"type":"string","readOnly":true},"expirationMonth":{"type":"number","readOnly":true},"expirationYear":{"type":"number","readOnly":true},"funding":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","status","stripe","brand","numberPreview","expirationMonth","expirationYear","funding","_links"]},"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]},"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"]}}}} ``` ## The PaymentBankAccountDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentBankAccountDto":{"type":"object","properties":{"id":{"type":"string"},"bankName":{"type":"string"},"accountHolderType":{"type":"string"},"last4":{"type":"string"}},"required":["id","bankName","accountHolderType","last4"]}}}} ``` ## The PaymentMethodDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentMethodDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["STRIPE","STRIPE_APPLE_PAY"]},"stripe":{"$ref":"#/components/schemas/PaymentMethodStripeDto"},"preferredCard":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardDto"}]},"preferredBankAccount":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentBankAccountDto"}]},"virtualCredits":{"type":"number"},"paymentElement":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","paymentElement","_links"]},"PaymentMethodStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"userId":{"type":"string"}}},"PaymentCardDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardStripeDto"}]},"brand":{"type":"string","readOnly":true},"numberPreview":{"type":"string","readOnly":true},"expirationMonth":{"type":"number","readOnly":true},"expirationYear":{"type":"number","readOnly":true},"funding":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","status","stripe","brand","numberPreview","expirationMonth","expirationYear","funding","_links"]},"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]},"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"]},"PaymentBankAccountDto":{"type":"object","properties":{"id":{"type":"string"},"bankName":{"type":"string"},"accountHolderType":{"type":"string"},"last4":{"type":"string"}},"required":["id","bankName","accountHolderType","last4"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The PaymentMethodStripeEphemeralKeyDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentMethodStripeEphemeralKeyDto":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string"},"associated_objects":{"type":"array","items":{"type":"string"}},"created":{"type":"number"},"expires":{"type":"number"},"livemode":{"type":"boolean"},"secret":{"type":"string"}},"required":["id","object","associated_objects","created","expires","livemode","secret"]}}}} ``` ## The PaymentMethodStripeSetupIntentDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentMethodStripeSetupIntentDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"terminal":{"type":"object"},"tokenId":{"type":"string"},"context":{"type":"string","enum":["booking","memberships"],"nullable":true},"ipAddress":{"type":"string","readOnly":true},"userAgent":{"type":"string","readOnly":true},"object":{"type":"string","readOnly":true},"created":{"type":"number","readOnly":true},"clientSecret":{"type":"string","readOnly":true}},"required":["id","tokenId","ipAddress","userAgent","object","created","clientSecret"]}}}} ``` ## The UserPaymentMethodDeletionWrapperDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPaymentMethodDeletionWrapperDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["STRIPE","STRIPE_APPLE_PAY"]},"stripe":{"$ref":"#/components/schemas/PaymentMethodStripeDto"},"preferredCard":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardDto"}]},"preferredBankAccount":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentBankAccountDto"}]},"virtualCredits":{"type":"number"},"paymentElement":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","type","paymentElement","_links","errors"]},"PaymentMethodStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"userId":{"type":"string"}}},"PaymentCardDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardStripeDto"}]},"brand":{"type":"string","readOnly":true},"numberPreview":{"type":"string","readOnly":true},"expirationMonth":{"type":"number","readOnly":true},"expirationYear":{"type":"number","readOnly":true},"funding":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","status","stripe","brand","numberPreview","expirationMonth","expirationYear","funding","_links"]},"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]},"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"]},"PaymentBankAccountDto":{"type":"object","properties":{"id":{"type":"string"},"bankName":{"type":"string"},"accountHolderType":{"type":"string"},"last4":{"type":"string"}},"required":["id","bankName","accountHolderType","last4"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The UserProfileDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The DeviceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DeviceDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"token":{"type":"string"},"name":{"type":"string"},"user":{"type":"object"},"bundle":{"type":"string","writeOnly":true},"platform":{"type":"string","writeOnly":true},"_links":{"type":"object"}},"required":["id","token","user","_links"]}}}} ``` ## The UserRatingsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserRatingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["DUPR","CUSTOM"],"readOnly":true},"singles":{"type":"number","readOnly":true},"doubles":{"type":"number","readOnly":true},"lastUpdated":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","type","singles","doubles","lastUpdated","errors"]},"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"]}}}} ``` ## The UserRatingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserRatingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserRatingsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"UserRatingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["DUPR","CUSTOM"],"readOnly":true},"singles":{"type":"number","readOnly":true},"doubles":{"type":"number","readOnly":true},"lastUpdated":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","type","singles","doubles","lastUpdated","errors"]},"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"]},"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"]}}}} ``` ## The UserNotesDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserNotesDto":{"type":"object","properties":{"notes":{"type":"string"}},"required":["notes"]}}}} ``` ## The AgreementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AgreementDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true},"type":{"type":"string","enum":["TERMS_OF_SERVICE","PRIVACY_POLICY","COVID_19_GUIDELINES","POD_RULES","LIABILITY_WAIVER","AREA_LIABILITY_WAIVER","KIDS_WAIVER","AREA_KIDS_WAIVER"]},"area":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"content":{"type":"string"},"releasedAt":{"format":"date-time","type":"string","readOnly":true},"contentType":{"type":"string","enum":["URL","MARKDOWN"]},"status":{"type":"string","enum":["DRAFT","RELEASED"]},"complianceType":{"type":"string","enum":["MANDATORY","OPTIONAL"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"releasedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","displayName","type","area","content","releasedAt","contentType","status","complianceType","errors","releasedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The AgreementCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AgreementCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AgreementDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AgreementDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true},"type":{"type":"string","enum":["TERMS_OF_SERVICE","PRIVACY_POLICY","COVID_19_GUIDELINES","POD_RULES","LIABILITY_WAIVER","AREA_LIABILITY_WAIVER","KIDS_WAIVER","AREA_KIDS_WAIVER"]},"area":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"content":{"type":"string"},"releasedAt":{"format":"date-time","type":"string","readOnly":true},"contentType":{"type":"string","enum":["URL","MARKDOWN"]},"status":{"type":"string","enum":["DRAFT","RELEASED"]},"complianceType":{"type":"string","enum":["MANDATORY","OPTIONAL"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"releasedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","displayName","type","area","content","releasedAt","contentType","status","complianceType","errors","releasedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The AssetUploadDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AssetUploadDto":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}} ``` ## The AssetDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AssetDto":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string","readOnly":true},"originalName":{"type":"string","readOnly":true},"mime":{"type":"string","readOnly":true},"size":{"type":"number","readOnly":true},"url":{"type":"string","readOnly":true}},"required":["id","createdAt","originalName","mime","size","url"]}}}} ``` ## The TenantReleaseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantReleaseDto":{"type":"object","properties":{"version":{"type":"string","readOnly":true}},"required":["version"]}}}} ``` ## The TenantDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"release":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TenantReleaseDto"}]},"settings":{"$ref":"#/components/schemas/CollectionRefDto"},"taxonomies":{"$ref":"#/components/schemas/CollectionRefDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","displayNameShort","release","settings","taxonomies","errors","_links"]},"TenantReleaseDto":{"type":"object","properties":{"version":{"type":"string","readOnly":true}},"required":["version"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"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"]}}}} ``` ## The TenantSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","value","errors"]},"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"]}}}} ``` ## The TenantSettingCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantSettingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TenantSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","value","errors"]},"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"]},"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"]}}}} ``` ## The TaxonomyNodeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"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"]}}}} ``` ## The TenantTaxonomyDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantTaxonomyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"required":["id","value"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"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"]}}}} ``` ## The TenantPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantPatchableDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNameShort":{"type":"string"}},"required":["displayName","displayNameShort"]}}}} ``` ## The TenantBranchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantBranchDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","pattern":"^s{2}$"},"countryDisplayName":{"type":"string"},"city":{"type":"string"},"description":{"type":"string"},"baseUrl":{"type":"string"},"isDefault":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","countryCode","countryDisplayName","city","description","baseUrl","isDefault","_links"]},"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"]}}}} ``` ## The TenantBranchCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TenantBranchCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantBranchDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TenantBranchDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","pattern":"^s{2}$"},"countryDisplayName":{"type":"string"},"city":{"type":"string"},"description":{"type":"string"},"baseUrl":{"type":"string"},"isDefault":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","countryCode","countryDisplayName","city","description","baseUrl","isDefault","_links"]},"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"]}}}} ``` ## The EventTagsNodeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventTagsNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"color":{"type":"string"},"priority":{"type":"number"},"isListed":{"type":"boolean"}},"required":["id","displayName","value","type","_links","color","priority","isListed"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"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"]}}}} ``` ## The AppMenuNodeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AppMenuNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"isActive":{"type":"boolean","description":"Whether the menu item is active/visible. Defaults to true if not specified."}},"required":["id","displayName","value","type","_links"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"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"]}}}} ``` ## The AdminAppMenuNodeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AdminAppMenuNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"priority":{"type":"number"}},"required":["id","displayName","value","type","_links","priority"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"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"]}}}} ``` ## The AdminAppMenuNodeCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AdminAppMenuNodeCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAppMenuNodeDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AdminAppMenuNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"},"priority":{"type":"number"}},"required":["id","displayName","value","type","_links","priority"]},"TaxonomyNodeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyNodeDto"}},"config":{"type":"object"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","value","type","_links"]},"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"]}}}} ``` ## The PodAddressDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The CourtSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CourtSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The CourtSettingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The TableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The TableCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The TimeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TimeDto":{"type":"object","properties":{"hours":{"type":"number","minimum":0,"maximum":23},"minutes":{"type":"number","minimum":0,"maximum":59}},"required":["hours","minutes"]}}}} ``` ## The PodClosedTimeOverrideDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"TimeDto":{"type":"object","properties":{"hours":{"type":"number","minimum":0,"maximum":23},"minutes":{"type":"number","minimum":0,"maximum":59}},"required":["hours","minutes"]}}}} ``` ## The PodClosedTimeOverrideCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"TimeDto":{"type":"object","properties":{"hours":{"type":"number","minimum":0,"maximum":23},"minutes":{"type":"number","minimum":0,"maximum":59}},"required":["hours","minutes"]},"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"]}}}} ``` ## The ExtraGuestsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ExtraGuestsDto":{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}},"required":["min","max"]}}}} ``` ## The PodGuestsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The PodSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The PodSettingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The PodDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]}}}} ``` ## The PodCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]}}}} ``` ## The PdkDeviceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PdkDeviceDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string"},"cloudNodeId":{"type":"string"},"cloudNodeName":{"type":"string"}},"required":["id","name","cloudNodeId","cloudNodeName"]}}}} ``` ## The PdkDeviceCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PdkDeviceCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PdkDeviceDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PdkDeviceDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string"},"cloudNodeId":{"type":"string"},"cloudNodeName":{"type":"string"}},"required":["id","name","cloudNodeId","cloudNodeName"]},"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"]}}}} ``` ## The PodRatesDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodRatesDto":{"type":"object","properties":{"passes":{"type":"array","items":{"type":"string"}},"extraGuests":{"$ref":"#/components/schemas/PodGuestsDto"},"defaultRate":{"type":"object"},"specialRates":{"type":"array","items":{"type":"string"}},"membershipOverrides":{"type":"object"},"holidayDates":{"type":"array","items":{"type":"string"}},"holidaysPeakPercentageIncreaseByDate":{"type":"object"},"holidaysOffPeakPercentageIncreaseByDate":{"type":"object"}},"required":["passes","extraGuests","defaultRate","specialRates","membershipOverrides","holidayDates","holidaysPeakPercentageIncreaseByDate","holidaysOffPeakPercentageIncreaseByDate"]},"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"]}}}} ``` ## The CourtRefWithPriorityDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CourtRefWithPriorityDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"priority":{"type":"number","description":"Priority position (0-indexed)."}},"required":["id","priority"]}}}} ``` ## The CourtRefWithPriorityCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CourtRefWithPriorityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CourtRefWithPriorityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CourtRefWithPriorityDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"priority":{"type":"number","description":"Priority position (0-indexed)."}},"required":["id","priority"]},"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"]}}}} ``` ## The CourtPodMigrationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CourtPodMigrationDto":{"type":"object","properties":{"destinationPod":{"$ref":"#/components/schemas/ItemRefDto"},"courts":{"$ref":"#/components/schemas/CourtRefWithPriorityCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["destinationPod","courts","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CourtRefWithPriorityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CourtRefWithPriorityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"CourtRefWithPriorityDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"priority":{"type":"number","description":"Priority position (0-indexed)."}},"required":["id","priority"]},"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"]}}}} ``` ## The AreaAddressCoordinatesDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaAddressCoordinatesDto":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]}}}} ``` ## The AreaAddressDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaAddressDto":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"borough":{"type":"string"},"zip":{"type":"string"},"displayName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/AreaAddressCoordinatesDto"}},"required":["street","city","borough","zip","displayName"]},"AreaAddressCoordinatesDto":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]}}}} ``` ## The CoachRateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachRateDto":{"type":"object","properties":{"guests":{"type":"number"},"hourlyRate":{"type":"number"}},"required":["guests","hourlyRate"]}}}} ``` ## The CoachProfileDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"}}}}}} ``` ## The AreaCoachAvailabilityDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaCoachAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE_EXPIRED","UNAVAILABLE_NOTICE_CUSHION","UNAVAILABLE_SWITCH_CUSHION"]},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"coach":{"$ref":"#/components/schemas/CoachProfileDto"},"_links":{"type":"object"}},"required":["id","status","startTime","endTime","area","coach","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"}}}}}} ``` ## The AreaCoachAvailabilityCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaCoachAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaCoachAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaCoachAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE_EXPIRED","UNAVAILABLE_NOTICE_CUSHION","UNAVAILABLE_SWITCH_CUSHION"]},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"coach":{"$ref":"#/components/schemas/CoachProfileDto"},"_links":{"type":"object"}},"required":["id","status","startTime","endTime","area","coach","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"}}},"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"]}}}} ``` ## The RegionSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The RegionSettingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RegionSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionSettingDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The RegionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RegionDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"taxSettings":{"type":"array","items":{"type":"string"}},"settings":{"$ref":"#/components/schemas/RegionSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","taxSettings","settings","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"RegionSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionSettingDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"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"]}}}} ``` ## The AreaSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.timezone","area.onPremiseApiURL","area.onPremiseLocalApiURL","area.onPremiseReplaysEnabled","area.priority","area.stripeAccountId","area.pictureAssetId","area.duprClubId","area.taxSettings","area.membersInvitationCopy","area.membershipDefaultMinTenancyDays","area.membershipDefaultMinCancellationNoticeDaysMonthly","area.membershipDefaultMinCancellationNoticeDaysYearly","feature.showSpotsLeft","feature.allowCreditsForCoaching","area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The AreaSettingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.timezone","area.onPremiseApiURL","area.onPremiseLocalApiURL","area.onPremiseReplaysEnabled","area.priority","area.stripeAccountId","area.pictureAssetId","area.duprClubId","area.taxSettings","area.membersInvitationCopy","area.membershipDefaultMinTenancyDays","area.membershipDefaultMinCancellationNoticeDaysMonthly","area.membershipDefaultMinCancellationNoticeDaysYearly","feature.showSpotsLeft","feature.allowCreditsForCoaching","area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]},"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"]}}}} ``` ## The ReplayPricingQuickReplayDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayPricingQuickReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether quick replays are enabled"},"lengthSeconds":{"type":"number","description":"Length in seconds"},"price":{"type":"number","description":"Price in dollars"},"initialFree":{"type":"number","description":"Number of initial free quick replays"}}}}}} ``` ## The ReplayPricingIntervalDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayPricingIntervalDto":{"type":"object","properties":{"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds (inclusive)"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds (exclusive). If null, applies to all durations above minDurationSeconds"},"price":{"type":"number","description":"Price in dollars for this interval"}},"required":["minDurationSeconds","price"]}}}} ``` ## The ReplayPricingCustomReplayDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayPricingCustomReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether custom replays are enabled"},"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds for custom replays"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds for custom replays"},"maxDaysToRequest":{"type":"number","description":"Number of days in the past users can request replays from"},"pricingIntervals":{"description":"Interval-based pricing. Each interval defines a price for a duration range. Takes precedence over pricePerMinute.","type":"array","items":{"$ref":"#/components/schemas/ReplayPricingIntervalDto"}},"pricePerMinute":{"type":"number","description":"Price per minute in dollars (legacy, used when pricingIntervals is not defined)"}}},"ReplayPricingIntervalDto":{"type":"object","properties":{"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds (inclusive)"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds (exclusive). If null, applies to all durations above minDurationSeconds"},"price":{"type":"number","description":"Price in dollars for this interval"}},"required":["minDurationSeconds","price"]}}}} ``` ## The ReplayPricingEnhancedReplayDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayPricingEnhancedReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether enhanced replays are enabled"},"pricePerMinute":{"type":"number","description":"Price per minute in dollars for new enhanced replays"}}}}}} ``` ## The ReplayPricingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayPricingDto":{"type":"object","properties":{"quickReplay":{"$ref":"#/components/schemas/ReplayPricingQuickReplayDto"},"customReplay":{"$ref":"#/components/schemas/ReplayPricingCustomReplayDto"},"enhancedReplay":{"$ref":"#/components/schemas/ReplayPricingEnhancedReplayDto"}}},"ReplayPricingQuickReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether quick replays are enabled"},"lengthSeconds":{"type":"number","description":"Length in seconds"},"price":{"type":"number","description":"Price in dollars"},"initialFree":{"type":"number","description":"Number of initial free quick replays"}}},"ReplayPricingCustomReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether custom replays are enabled"},"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds for custom replays"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds for custom replays"},"maxDaysToRequest":{"type":"number","description":"Number of days in the past users can request replays from"},"pricingIntervals":{"description":"Interval-based pricing. Each interval defines a price for a duration range. Takes precedence over pricePerMinute.","type":"array","items":{"$ref":"#/components/schemas/ReplayPricingIntervalDto"}},"pricePerMinute":{"type":"number","description":"Price per minute in dollars (legacy, used when pricingIntervals is not defined)"}}},"ReplayPricingIntervalDto":{"type":"object","properties":{"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds (inclusive)"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds (exclusive). If null, applies to all durations above minDurationSeconds"},"price":{"type":"number","description":"Price in dollars for this interval"}},"required":["minDurationSeconds","price"]},"ReplayPricingEnhancedReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether enhanced replays are enabled"},"pricePerMinute":{"type":"number","description":"Price per minute in dollars for new enhanced replays"}}}}}} ``` ## The AreaDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"status":{"type":"string","enum":["NOT_AVAILABLE","AVAILABLE","TEMPORARILY_CLOSED","COMING_SOON"]},"comingSoonText":{"type":"string","description":"Custom text to display when status is COMING_SOON (max 40 chars)"},"address":{"$ref":"#/components/schemas/AreaAddressDto"},"pods":{"$ref":"#/components/schemas/PodCollectionDto"},"availableCoaches":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/AreaCoachAvailabilityCollectionDto"}]},"picture":{"$ref":"#/components/schemas/ImageDto"},"region":{"$ref":"#/components/schemas/RegionDto"},"settings":{"$ref":"#/components/schemas/AreaSettingsCollectionDto"},"replaysPricing":{"description":"Replay pricing configuration (admin only, expandable)","allOf":[{"$ref":"#/components/schemas/ReplayPricingDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","status","address","picture","region","settings","errors","_links"]},"AreaAddressDto":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"borough":{"type":"string"},"zip":{"type":"string"},"displayName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/AreaAddressCoordinatesDto"}},"required":["street","city","borough","zip","displayName"]},"AreaAddressCoordinatesDto":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]},"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"]},"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"]},"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"]},"AreaCoachAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaCoachAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaCoachAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE_EXPIRED","UNAVAILABLE_NOTICE_CUSHION","UNAVAILABLE_SWITCH_CUSHION"]},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"coach":{"$ref":"#/components/schemas/CoachProfileDto"},"_links":{"type":"object"}},"required":["id","status","startTime","endTime","area","coach","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"}}},"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"RegionDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"taxSettings":{"type":"array","items":{"type":"string"}},"settings":{"$ref":"#/components/schemas/RegionSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","taxSettings","settings","errors","_links"]},"RegionSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionSettingDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"AreaSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.timezone","area.onPremiseApiURL","area.onPremiseLocalApiURL","area.onPremiseReplaysEnabled","area.priority","area.stripeAccountId","area.pictureAssetId","area.duprClubId","area.taxSettings","area.membersInvitationCopy","area.membershipDefaultMinTenancyDays","area.membershipDefaultMinCancellationNoticeDaysMonthly","area.membershipDefaultMinCancellationNoticeDaysYearly","feature.showSpotsLeft","feature.allowCreditsForCoaching","area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]},"ReplayPricingDto":{"type":"object","properties":{"quickReplay":{"$ref":"#/components/schemas/ReplayPricingQuickReplayDto"},"customReplay":{"$ref":"#/components/schemas/ReplayPricingCustomReplayDto"},"enhancedReplay":{"$ref":"#/components/schemas/ReplayPricingEnhancedReplayDto"}}},"ReplayPricingQuickReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether quick replays are enabled"},"lengthSeconds":{"type":"number","description":"Length in seconds"},"price":{"type":"number","description":"Price in dollars"},"initialFree":{"type":"number","description":"Number of initial free quick replays"}}},"ReplayPricingCustomReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether custom replays are enabled"},"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds for custom replays"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds for custom replays"},"maxDaysToRequest":{"type":"number","description":"Number of days in the past users can request replays from"},"pricingIntervals":{"description":"Interval-based pricing. Each interval defines a price for a duration range. Takes precedence over pricePerMinute.","type":"array","items":{"$ref":"#/components/schemas/ReplayPricingIntervalDto"}},"pricePerMinute":{"type":"number","description":"Price per minute in dollars (legacy, used when pricingIntervals is not defined)"}}},"ReplayPricingIntervalDto":{"type":"object","properties":{"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds (inclusive)"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds (exclusive). If null, applies to all durations above minDurationSeconds"},"price":{"type":"number","description":"Price in dollars for this interval"}},"required":["minDurationSeconds","price"]},"ReplayPricingEnhancedReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether enhanced replays are enabled"},"pricePerMinute":{"type":"number","description":"Price per minute in dollars for new enhanced replays"}}}}}} ``` ## The AreaCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"status":{"type":"string","enum":["NOT_AVAILABLE","AVAILABLE","TEMPORARILY_CLOSED","COMING_SOON"]},"comingSoonText":{"type":"string","description":"Custom text to display when status is COMING_SOON (max 40 chars)"},"address":{"$ref":"#/components/schemas/AreaAddressDto"},"pods":{"$ref":"#/components/schemas/PodCollectionDto"},"availableCoaches":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/AreaCoachAvailabilityCollectionDto"}]},"picture":{"$ref":"#/components/schemas/ImageDto"},"region":{"$ref":"#/components/schemas/RegionDto"},"settings":{"$ref":"#/components/schemas/AreaSettingsCollectionDto"},"replaysPricing":{"description":"Replay pricing configuration (admin only, expandable)","allOf":[{"$ref":"#/components/schemas/ReplayPricingDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","status","address","picture","region","settings","errors","_links"]},"AreaAddressDto":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"borough":{"type":"string"},"zip":{"type":"string"},"displayName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/AreaAddressCoordinatesDto"}},"required":["street","city","borough","zip","displayName"]},"AreaAddressCoordinatesDto":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]},"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"]},"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"]},"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"]},"AreaCoachAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaCoachAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaCoachAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE_EXPIRED","UNAVAILABLE_NOTICE_CUSHION","UNAVAILABLE_SWITCH_CUSHION"]},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"coach":{"$ref":"#/components/schemas/CoachProfileDto"},"_links":{"type":"object"}},"required":["id","status","startTime","endTime","area","coach","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"}}},"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"RegionDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"taxSettings":{"type":"array","items":{"type":"string"}},"settings":{"$ref":"#/components/schemas/RegionSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","taxSettings","settings","errors","_links"]},"RegionSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionSettingDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"AreaSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.timezone","area.onPremiseApiURL","area.onPremiseLocalApiURL","area.onPremiseReplaysEnabled","area.priority","area.stripeAccountId","area.pictureAssetId","area.duprClubId","area.taxSettings","area.membersInvitationCopy","area.membershipDefaultMinTenancyDays","area.membershipDefaultMinCancellationNoticeDaysMonthly","area.membershipDefaultMinCancellationNoticeDaysYearly","feature.showSpotsLeft","feature.allowCreditsForCoaching","area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]},"ReplayPricingDto":{"type":"object","properties":{"quickReplay":{"$ref":"#/components/schemas/ReplayPricingQuickReplayDto"},"customReplay":{"$ref":"#/components/schemas/ReplayPricingCustomReplayDto"},"enhancedReplay":{"$ref":"#/components/schemas/ReplayPricingEnhancedReplayDto"}}},"ReplayPricingQuickReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether quick replays are enabled"},"lengthSeconds":{"type":"number","description":"Length in seconds"},"price":{"type":"number","description":"Price in dollars"},"initialFree":{"type":"number","description":"Number of initial free quick replays"}}},"ReplayPricingCustomReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether custom replays are enabled"},"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds for custom replays"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds for custom replays"},"maxDaysToRequest":{"type":"number","description":"Number of days in the past users can request replays from"},"pricingIntervals":{"description":"Interval-based pricing. Each interval defines a price for a duration range. Takes precedence over pricePerMinute.","type":"array","items":{"$ref":"#/components/schemas/ReplayPricingIntervalDto"}},"pricePerMinute":{"type":"number","description":"Price per minute in dollars (legacy, used when pricingIntervals is not defined)"}}},"ReplayPricingIntervalDto":{"type":"object","properties":{"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds (inclusive)"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds (exclusive). If null, applies to all durations above minDurationSeconds"},"price":{"type":"number","description":"Price in dollars for this interval"}},"required":["minDurationSeconds","price"]},"ReplayPricingEnhancedReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether enhanced replays are enabled"},"pricePerMinute":{"type":"number","description":"Price per minute in dollars for new enhanced replays"}}}}}} ``` ## The AreaBrandingSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaBrandingSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The AreaBrandingSettingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AreaBrandingSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaBrandingSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaBrandingSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]},"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"]}}}} ``` ## The AccessDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The LockerRoomDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"LockerRoomDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"description":{"type":"string"},"area":{"type":"object"},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","description","area","_links"]}}}} ``` ## The LockerRoomCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"LockerRoomCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LockerRoomDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"LockerRoomDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"description":{"type":"string"},"area":{"type":"object"},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","description","area","_links"]}}}} ``` ## The CoachTierCancellationPolicyTimeRangeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachTierCancellationPolicyTimeRangeDto":{"type":"object","properties":{}}}}} ``` ## The CoachTierCancellationPolicyDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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":{}}}}} ``` ## The CoachTierDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachTierCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachTierPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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":{}}}}} ``` ## The PaginatedCoachProfileCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachSettingsSwitchCushionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachSettingsSwitchCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]}}}} ``` ## The CoachSettingsStudentsListDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachSettingsStudentsListDto":{"type":"object","properties":{"status":{"type":"string","enum":["ENABLED","DISABLED"]}},"required":["status"]}}}} ``` ## The CoachSettingsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachSettingsAreaNoticeCushionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachSettingsAreaNoticeCushionDto":{"type":"object","properties":{"minutes":{"type":"number"}},"required":["minutes"]}}}} ``` ## The CoachSettingsAreaAvailabilityDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachSettingsAreaAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["id","startTime","endTime"]}}}} ``` ## The CoachSettingsAreaAvailabilityCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachSettingsAreaDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachSettingsAreaCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CoachSettingsAreaPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The PaymentsAccountDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The PaymentStripeOutcomeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentStripeOutcomeDto":{"type":"object","properties":{"status":{"type":"string"},"networkStatus":{"type":"string"},"reason":{"type":"string"},"riskLevel":{"type":"string"},"sellerMessage":{"type":"string"},"type":{"type":"string"}},"required":["status","networkStatus","reason","riskLevel","sellerMessage","type"]}}}} ``` ## The PaymentStripeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentStripeDto":{"type":"object","properties":{"id":{"type":"string"},"paymentId":{"type":"string"},"failureCode":{"type":"string"},"failureMessage":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"amount":{"type":"number"},"description":{"type":"string"},"statementDescriptor":{"type":"string"},"status":{"type":"string"},"outcome":{"$ref":"#/components/schemas/PaymentStripeOutcomeDto"},"card":{"$ref":"#/components/schemas/PaymentCardDto"},"bankAccount":{"$ref":"#/components/schemas/PaymentBankAccountDto"},"paymentElement":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","paymentId","failureCode","failureMessage","createdAt","amount","description","statementDescriptor","status","outcome","card","bankAccount","paymentElement","_links"]},"PaymentStripeOutcomeDto":{"type":"object","properties":{"status":{"type":"string"},"networkStatus":{"type":"string"},"reason":{"type":"string"},"riskLevel":{"type":"string"},"sellerMessage":{"type":"string"},"type":{"type":"string"}},"required":["status","networkStatus","reason","riskLevel","sellerMessage","type"]},"PaymentCardDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardStripeDto"}]},"brand":{"type":"string","readOnly":true},"numberPreview":{"type":"string","readOnly":true},"expirationMonth":{"type":"number","readOnly":true},"expirationYear":{"type":"number","readOnly":true},"funding":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","status","stripe","brand","numberPreview","expirationMonth","expirationYear","funding","_links"]},"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]},"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"]},"PaymentBankAccountDto":{"type":"object","properties":{"id":{"type":"string"},"bankName":{"type":"string"},"accountHolderType":{"type":"string"},"last4":{"type":"string"}},"required":["id","bankName","accountHolderType","last4"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The PaymentDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["CASH","CARD","POS"],"readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentStripeDto"}]},"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"},"authorizedAmount":{"type":"number","readOnly":true},"capturedAmount":{"type":"number","readOnly":true},"refundAmount":{"type":"number","readOnly":true},"refundVirtualCredits":{"type":"number","readOnly":true},"status":{"type":"string","enum":["CAPTURED","AUTHORIZED","CANCELED","REFUNDED","REQUIRES_AUTHENTICATION","FAILED","EXPIRED","DISPUTED","PROCESSING"],"readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"captureDate":{"format":"date-time","type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","stripe","currency","authorizedAmount","capturedAmount","refundAmount","refundVirtualCredits","status","createdDate","captureDate","user","_links"]},"PaymentStripeDto":{"type":"object","properties":{"id":{"type":"string"},"paymentId":{"type":"string"},"failureCode":{"type":"string"},"failureMessage":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"amount":{"type":"number"},"description":{"type":"string"},"statementDescriptor":{"type":"string"},"status":{"type":"string"},"outcome":{"$ref":"#/components/schemas/PaymentStripeOutcomeDto"},"card":{"$ref":"#/components/schemas/PaymentCardDto"},"bankAccount":{"$ref":"#/components/schemas/PaymentBankAccountDto"},"paymentElement":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","paymentId","failureCode","failureMessage","createdAt","amount","description","statementDescriptor","status","outcome","card","bankAccount","paymentElement","_links"]},"PaymentStripeOutcomeDto":{"type":"object","properties":{"status":{"type":"string"},"networkStatus":{"type":"string"},"reason":{"type":"string"},"riskLevel":{"type":"string"},"sellerMessage":{"type":"string"},"type":{"type":"string"}},"required":["status","networkStatus","reason","riskLevel","sellerMessage","type"]},"PaymentCardDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardStripeDto"}]},"brand":{"type":"string","readOnly":true},"numberPreview":{"type":"string","readOnly":true},"expirationMonth":{"type":"number","readOnly":true},"expirationYear":{"type":"number","readOnly":true},"funding":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","status","stripe","brand","numberPreview","expirationMonth","expirationYear","funding","_links"]},"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]},"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"]},"PaymentBankAccountDto":{"type":"object","properties":{"id":{"type":"string"},"bankName":{"type":"string"},"accountHolderType":{"type":"string"},"last4":{"type":"string"}},"required":["id","bankName","accountHolderType","last4"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ReverseTransferDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReverseTransferDto":{"type":"object","properties":{"amount":{"type":"number"}},"required":["amount"]}}}} ``` ## The TransferDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The CouponDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CouponDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","INVALID","SCHEDULED","ACTIVE","EXPIRED"],"readOnly":true},"code":{"type":"string"},"description":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"ticketsLeft":{"type":"number"},"ticketsApplied":{"type":"number","readOnly":true},"ticketsUsed":{"type":"number","readOnly":true,"deprecated":true},"active":{"type":"boolean"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"daysOfWeek":{"type":"array","items":{"type":"number"}},"eligibleType":{"type":"string","enum":["BOOKING","EVENT_OPEN_PLAY","EVENT_TOURNAMENT","EVENT_LEAGUE_NIGHT","EVENT_KIDS_CLASS","EVENT_ADULT_CLASS"],"deprecated":true,"description":"Deprecated: Use eligibleTypes array instead"},"eligibleTypes":{"description":"Array of eligible event types. Use \"EVENT_SUBTYPE\" for category (e.g., EVENT_ADULT_CLASS matches all adult classes). Use \"EVENT_SUBTYPE:customType\" for specific type (e.g., EVENT_ADULT_CLASS:Podfit).","type":"array","items":{"type":"string"}},"eligibleUsers":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"eligibleDomains":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string","enum":["SINGLE_USE","FIRST_ONLY","LIMITED","USER_RESTRICTED","DOMAIN_RESTRICTED","TYPE_RESTRICTED"]}},"allowedAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"createdDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"creator":{"readOnly":true,"nullable":true,"description":"The user who created this promo code","allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"_links":{"type":"object"}},"required":["id","status","code","description","discountType","value","ticketsLeft","ticketsApplied","ticketsUsed","active","startDate","endDate","daysOfWeek","eligibleType","eligibleTypes","eligibleUsers","eligibleDomains","tags","allowedAreas","errors","createdDate","creator","_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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The BaseCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BaseCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The CouponCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CouponCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CouponDto"}},"_total":{"type":"number","deprecated":true},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"CouponDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["DRAFT","INVALID","SCHEDULED","ACTIVE","EXPIRED"],"readOnly":true},"code":{"type":"string"},"description":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"ticketsLeft":{"type":"number"},"ticketsApplied":{"type":"number","readOnly":true},"ticketsUsed":{"type":"number","readOnly":true,"deprecated":true},"active":{"type":"boolean"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"daysOfWeek":{"type":"array","items":{"type":"number"}},"eligibleType":{"type":"string","enum":["BOOKING","EVENT_OPEN_PLAY","EVENT_TOURNAMENT","EVENT_LEAGUE_NIGHT","EVENT_KIDS_CLASS","EVENT_ADULT_CLASS"],"deprecated":true,"description":"Deprecated: Use eligibleTypes array instead"},"eligibleTypes":{"description":"Array of eligible event types. Use \"EVENT_SUBTYPE\" for category (e.g., EVENT_ADULT_CLASS matches all adult classes). Use \"EVENT_SUBTYPE:customType\" for specific type (e.g., EVENT_ADULT_CLASS:Podfit).","type":"array","items":{"type":"string"}},"eligibleUsers":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"eligibleDomains":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string","enum":["SINGLE_USE","FIRST_ONLY","LIMITED","USER_RESTRICTED","DOMAIN_RESTRICTED","TYPE_RESTRICTED"]}},"allowedAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"createdDate":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"creator":{"readOnly":true,"nullable":true,"description":"The user who created this promo code","allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"_links":{"type":"object"}},"required":["id","status","code","description","discountType","value","ticketsLeft","ticketsApplied","ticketsUsed","active","startDate","endDate","daysOfWeek","eligibleType","eligibleTypes","eligibleUsers","eligibleDomains","tags","allowedAreas","errors","createdDate","creator","_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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The CouponSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CouponSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","code","discountType","value","_links"]},"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"]}}}} ``` ## The MembershipPlanDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]}}}} ``` ## The MembershipBenefitDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipBenefitDto":{"type":"object","properties":{}}}}} ``` ## The MembershipBenefitsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"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"]}}}} ``` ## The MembershipSettingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]}}}} ``` ## The MembershipSettingsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"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"]}}}} ``` ## The OneTimePriceOptionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]}}}} ``` ## The OneTimePriceOptionsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"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"]}}}} ``` ## The MembershipDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"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"]},"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"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"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"]}}}} ``` ## The MembershipCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"MembershipCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"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"]},"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"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"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"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The RegionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RegionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"RegionDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"taxSettings":{"type":"array","items":{"type":"string"}},"settings":{"$ref":"#/components/schemas/RegionSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","taxSettings","settings","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"RegionSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionSettingDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"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"]}}}} ``` ## The OrderPassDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The OrderPassCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The EventCancellationSummaryRefundDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The EventCancellationSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventCancellationSummaryDto":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventCancellationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventCancellationDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","FAILED","PENDING","CONFIRMED"],"readOnly":true},"reason":{"type":"string","enum":["WEATHER","LOW_TURNOUT","OTHER"],"readOnly":true,"nullable":true},"reasonText":{"type":"string","nullable":true,"description":"Optional free-text reason when reason is OTHER. Max 40 characters."},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventCancellationSummaryDto"}]}},"required":["type","status","summary"]},"EventCancellationSummaryDto":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventNoteDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventNoteDto":{"type":"object","properties":{"id":{"type":"string"},"comment":{"type":"string"}},"required":["id","comment"]}}}} ``` ## The EventNoteCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventNoteCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventNoteDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventNoteDto":{"type":"object","properties":{"id":{"type":"string"},"comment":{"type":"string"}},"required":["id","comment"]},"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"]}}}} ``` ## The OpenInvitationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OpenInvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"owner":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"visibility":{"type":"string","enum":["LISTED","UNLISTED"]},"chargeType":{"type":"string","enum":["FREE","SPLIT_PAYMENT","PAID_BY_INVITER"],"nullable":true},"type":{"type":"string","nullable":true,"enum":["SHARE","SIGNUP"]},"sharingKey":{"type":"string","readOnly":true},"redeemUrl":{"type":"string","readOnly":true},"maxRedeems":{"type":"number","readOnly":true,"nullable":true,"description":"The number of times the invitation can be redeemed. Includes the owner's redemption."},"redeemsRemaining":{"type":"number","readOnly":true},"onBehalfOfEventOwner":{"type":"boolean","writeOnly":true},"_links":{"type":"object","readOnly":true}},"required":["id","owner","visibility","chargeType","type","sharingKey","redeemUrl","maxRedeems","redeemsRemaining","onBehalfOfEventOwner","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The OpenInvitationEmailDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OpenInvitationEmailDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"recipientEmail":{"type":"string"},"openInvitation":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["id","recipientEmail","openInvitation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The OpenInvitationSMSDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OpenInvitationSMSDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"recipientPhoneNumber":{"type":"string"},"openInvitation":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["id","recipientPhoneNumber","openInvitation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventSettlementDetailDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSettlementDetailDto":{"type":"object","properties":{"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"total":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"_links":{"type":"object"}},"required":["user","total","virtualCredits","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventSettlementDetailCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSettlementDetailCollectionDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/EventSettlementDetailDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSettlementDetailDto":{"type":"object","properties":{"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"total":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"_links":{"type":"object"}},"required":["user","total","virtualCredits","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The CoachSettlementDetailDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachSettlementDetailDto":{"type":"object","properties":{"coach":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"readOnly":true},"rate":{"type":"number","readOnly":true},"amount":{"type":"number","readOnly":true},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["coach","rateType","rate","amount"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The CoachSettlementDetailCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachSettlementDetailCollectionDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/CoachSettlementDetailDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"CoachSettlementDetailDto":{"type":"object","properties":{"coach":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"readOnly":true},"rate":{"type":"number","readOnly":true},"amount":{"type":"number","readOnly":true},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["coach","rateType","rate","amount"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventSettlementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSettlementDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["PENDING","SETTLED","INVALID"]},"bookingTotal":{"type":"number","readOnly":true},"eventRevenue":{"type":"number","readOnly":true,"description":"Pre-tax revenue (base for percentage coach calculations)"},"taxesTotal":{"type":"number","readOnly":true,"description":"Total taxes collected"},"signupsTotal":{"type":"number","readOnly":true},"coachingTotal":{"type":"number","readOnly":true},"virtualCreditsTotal":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"currency":{"type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"details":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/EventSettlementDetailCollectionDto"}},"coachingDetails":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CoachSettlementDetailCollectionDto"}]},"messages":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"_links":{"type":"object"}},"required":["type","status","bookingTotal","eventRevenue","taxesTotal","signupsTotal","coachingTotal","virtualCreditsTotal","total","currency","errors","details","_links"]},"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"]},"EventSettlementDetailCollectionDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/EventSettlementDetailDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSettlementDetailDto":{"type":"object","properties":{"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"total":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"_links":{"type":"object"}},"required":["user","total","virtualCredits","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"CoachSettlementDetailCollectionDto":{"type":"object","properties":{"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/CoachSettlementDetailDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"CoachSettlementDetailDto":{"type":"object","properties":{"coach":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"readOnly":true},"rate":{"type":"number","readOnly":true},"amount":{"type":"number","readOnly":true},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["coach","rateType","rate","amount"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The PaymentCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaymentCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PaymentDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["CASH","CARD","POS"],"readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentStripeDto"}]},"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"},"authorizedAmount":{"type":"number","readOnly":true},"capturedAmount":{"type":"number","readOnly":true},"refundAmount":{"type":"number","readOnly":true},"refundVirtualCredits":{"type":"number","readOnly":true},"status":{"type":"string","enum":["CAPTURED","AUTHORIZED","CANCELED","REFUNDED","REQUIRES_AUTHENTICATION","FAILED","EXPIRED","DISPUTED","PROCESSING"],"readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"captureDate":{"format":"date-time","type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","stripe","currency","authorizedAmount","capturedAmount","refundAmount","refundVirtualCredits","status","createdDate","captureDate","user","_links"]},"PaymentStripeDto":{"type":"object","properties":{"id":{"type":"string"},"paymentId":{"type":"string"},"failureCode":{"type":"string"},"failureMessage":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"amount":{"type":"number"},"description":{"type":"string"},"statementDescriptor":{"type":"string"},"status":{"type":"string"},"outcome":{"$ref":"#/components/schemas/PaymentStripeOutcomeDto"},"card":{"$ref":"#/components/schemas/PaymentCardDto"},"bankAccount":{"$ref":"#/components/schemas/PaymentBankAccountDto"},"paymentElement":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","paymentId","failureCode","failureMessage","createdAt","amount","description","statementDescriptor","status","outcome","card","bankAccount","paymentElement","_links"]},"PaymentStripeOutcomeDto":{"type":"object","properties":{"status":{"type":"string"},"networkStatus":{"type":"string"},"reason":{"type":"string"},"riskLevel":{"type":"string"},"sellerMessage":{"type":"string"},"type":{"type":"string"}},"required":["status","networkStatus","reason","riskLevel","sellerMessage","type"]},"PaymentCardDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"stripe":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PaymentCardStripeDto"}]},"brand":{"type":"string","readOnly":true},"numberPreview":{"type":"string","readOnly":true},"expirationMonth":{"type":"number","readOnly":true},"expirationYear":{"type":"number","readOnly":true},"funding":{"type":"string","readOnly":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","status","stripe","brand","numberPreview","expirationMonth","expirationYear","funding","_links"]},"PaymentCardStripeDto":{"type":"object","properties":{"paymentMethodId":{"type":"string","readOnly":true}},"required":["paymentMethodId"]},"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"]},"PaymentBankAccountDto":{"type":"object","properties":{"id":{"type":"string"},"bankName":{"type":"string"},"accountHolderType":{"type":"string"},"last4":{"type":"string"}},"required":["id","bankName","accountHolderType","last4"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventStatsDto":{"type":"object","properties":{"id":{"type":"string"},"tags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["FIRST_USER_BOOKED_EVENT"]}},"revenue":{"$ref":"#/components/schemas/ItemRefDto"},"_links":{"type":"object"}},"required":["id","tags","revenue","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventStatsRevenueProceedsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventStatsRevenueProceedsDto":{"type":"object","properties":{"subtotal":{"type":"number"},"virtualCredits":{"type":"number"},"cash":{"type":"number"},"discount":{"type":"number"},"total":{"type":"number"}},"required":["subtotal","virtualCredits","cash","discount","total"]}}}} ``` ## The EventStatsRevenueDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventStatsRevenueDto":{"type":"object","properties":{"couponCode":{"type":"string","nullable":true},"bookingProceeds":{"$ref":"#/components/schemas/EventStatsRevenueProceedsDto"},"eventSignupProceeds":{"$ref":"#/components/schemas/EventStatsRevenueProceedsDto"},"purchasesProceeds":{"$ref":"#/components/schemas/EventStatsRevenueProceedsDto"},"totalProceeds":{"$ref":"#/components/schemas/EventStatsRevenueProceedsDto"},"orderItems":{"$ref":"#/components/schemas/ItemRefDto"},"_links":{"type":"object"}},"required":["couponCode","bookingProceeds","eventSignupProceeds","purchasesProceeds","totalProceeds","orderItems","_links"]},"EventStatsRevenueProceedsDto":{"type":"object","properties":{"subtotal":{"type":"number"},"virtualCredits":{"type":"number"},"cash":{"type":"number"},"discount":{"type":"number"},"total":{"type":"number"}},"required":["subtotal","virtualCredits","cash","discount","total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The OrderItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The OrderItemCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OrderItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The ReplayVideoDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayVideoDto":{"type":"object","properties":{"low":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"high":{"$ref":"#/components/schemas/LinkDto"},"web":{"$ref":"#/components/schemas/LinkDto"},"hls":{"$ref":"#/components/schemas/LinkDto"}},"required":["low","medium","high","web","hls"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}} ``` ## The ReplayChargeOptionPricingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayChargeOptionPricingDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"}},"required":["subtotal","taxes","total"]},"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"]}}}} ``` ## The ReplayChargeOptionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayChargeOptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Charge strategy identifier","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"]},"label":{"type":"string","readOnly":true,"description":"Human-readable label"},"pricing":{"readOnly":true,"description":"Pricing for this charge option","allOf":[{"$ref":"#/components/schemas/ReplayChargeOptionPricingDto"}]}},"required":["id","label","pricing"]},"ReplayChargeOptionPricingDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"}},"required":["subtotal","taxes","total"]},"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"]}}}} ``` ## The ReplaySummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplaySummaryDto":{"type":"object","properties":{"currency":{"type":"string","readOnly":true,"description":"Currency code (e.g., USD)"},"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"},"chargeOptions":{"readOnly":true,"nullable":true,"description":"Available charge options for enhanced replays (admin only)","type":"array","items":{"$ref":"#/components/schemas/ReplayChargeOptionDto"}},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["currency","subtotal","taxes","total","chargeOptions","errors","messages"]},"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"]},"ReplayChargeOptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Charge strategy identifier","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"]},"label":{"type":"string","readOnly":true,"description":"Human-readable label"},"pricing":{"readOnly":true,"description":"Pricing for this charge option","allOf":[{"$ref":"#/components/schemas/ReplayChargeOptionPricingDto"}]}},"required":["id","label","pricing"]},"ReplayChargeOptionPricingDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"}},"required":["subtotal","taxes","total"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The ReplayDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["QUICK_REPLAY","CUSTOM_REPLAY","ENHANCED_REPLAY"]},"actionType":{"type":"string","enum":["PREVIEW","ORDER"],"description":"Action type: PREVIEW to simulate order, ORDER to create"},"paymentMode":{"type":"string","enum":["PAID","FREE_OF_CHARGE"],"writeOnly":true,"description":"Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers/staff from the dashboard."},"chargeStrategy":{"type":"string","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"],"description":"Charge strategy for enhanced replays (admin only). Determines how costs are split between customer and club."},"billingUser":{"writeOnly":true,"description":"User to bill for this replay (admin only). If not specified, the event booker is charged.","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"status":{"type":"string","enum":["ORDERED","CLIP_FAILED","CHARGE_FAILED","READY","INVALID"],"readOnly":true},"table":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"lengthMilliseconds":{"type":"number","readOnly":true},"video":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ReplayVideoDto"}]},"preview":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ImageDto"}]},"likes":{"type":"object","readOnly":true},"enhancedVideoUrl":{"type":"string","readOnly":true,"description":"URL to the AI-enhanced analysis page"},"flags":{"readOnly":true,"description":"Feature flags for this replay (e.g. \"AUTO_ENHANCE\")","type":"array","items":{"type":"string"}},"summary":{"readOnly":true,"description":"Pricing summary including subtotal, taxes, total, and available charge options","allOf":[{"$ref":"#/components/schemas/ReplaySummaryDto"}]},"user":{"readOnly":true,"description":"User associated with this replay","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","type","status","table","startTime","endTime","lengthMilliseconds","video","preview","likes","enhancedVideoUrl","flags","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayVideoDto":{"type":"object","properties":{"low":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"high":{"$ref":"#/components/schemas/LinkDto"},"web":{"$ref":"#/components/schemas/LinkDto"},"hls":{"$ref":"#/components/schemas/LinkDto"}},"required":["low","medium","high","web","hls"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"ReplaySummaryDto":{"type":"object","properties":{"currency":{"type":"string","readOnly":true,"description":"Currency code (e.g., USD)"},"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"},"chargeOptions":{"readOnly":true,"nullable":true,"description":"Available charge options for enhanced replays (admin only)","type":"array","items":{"$ref":"#/components/schemas/ReplayChargeOptionDto"}},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["currency","subtotal","taxes","total","chargeOptions","errors","messages"]},"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"]},"ReplayChargeOptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Charge strategy identifier","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"]},"label":{"type":"string","readOnly":true,"description":"Human-readable label"},"pricing":{"readOnly":true,"description":"Pricing for this charge option","allOf":[{"$ref":"#/components/schemas/ReplayChargeOptionPricingDto"}]}},"required":["id","label","pricing"]},"ReplayChargeOptionPricingDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"}},"required":["subtotal","taxes","total"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The ReplayCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReplayDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ReplayDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["QUICK_REPLAY","CUSTOM_REPLAY","ENHANCED_REPLAY"]},"actionType":{"type":"string","enum":["PREVIEW","ORDER"],"description":"Action type: PREVIEW to simulate order, ORDER to create"},"paymentMode":{"type":"string","enum":["PAID","FREE_OF_CHARGE"],"writeOnly":true,"description":"Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers/staff from the dashboard."},"chargeStrategy":{"type":"string","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"],"description":"Charge strategy for enhanced replays (admin only). Determines how costs are split between customer and club."},"billingUser":{"writeOnly":true,"description":"User to bill for this replay (admin only). If not specified, the event booker is charged.","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"status":{"type":"string","enum":["ORDERED","CLIP_FAILED","CHARGE_FAILED","READY","INVALID"],"readOnly":true},"table":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"lengthMilliseconds":{"type":"number","readOnly":true},"video":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ReplayVideoDto"}]},"preview":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ImageDto"}]},"likes":{"type":"object","readOnly":true},"enhancedVideoUrl":{"type":"string","readOnly":true,"description":"URL to the AI-enhanced analysis page"},"flags":{"readOnly":true,"description":"Feature flags for this replay (e.g. \"AUTO_ENHANCE\")","type":"array","items":{"type":"string"}},"summary":{"readOnly":true,"description":"Pricing summary including subtotal, taxes, total, and available charge options","allOf":[{"$ref":"#/components/schemas/ReplaySummaryDto"}]},"user":{"readOnly":true,"description":"User associated with this replay","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["id","type","status","table","startTime","endTime","lengthMilliseconds","video","preview","likes","enhancedVideoUrl","flags","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayVideoDto":{"type":"object","properties":{"low":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"high":{"$ref":"#/components/schemas/LinkDto"},"web":{"$ref":"#/components/schemas/LinkDto"},"hls":{"$ref":"#/components/schemas/LinkDto"}},"required":["low","medium","high","web","hls"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"ReplaySummaryDto":{"type":"object","properties":{"currency":{"type":"string","readOnly":true,"description":"Currency code (e.g., USD)"},"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"},"chargeOptions":{"readOnly":true,"nullable":true,"description":"Available charge options for enhanced replays (admin only)","type":"array","items":{"$ref":"#/components/schemas/ReplayChargeOptionDto"}},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["currency","subtotal","taxes","total","chargeOptions","errors","messages"]},"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"]},"ReplayChargeOptionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Charge strategy identifier","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"]},"label":{"type":"string","readOnly":true,"description":"Human-readable label"},"pricing":{"readOnly":true,"description":"Pricing for this charge option","allOf":[{"$ref":"#/components/schemas/ReplayChargeOptionPricingDto"}]}},"required":["id","label","pricing"]},"ReplayChargeOptionPricingDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true,"description":"Subtotal before taxes"},"taxes":{"readOnly":true,"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"total":{"type":"number","readOnly":true,"description":"Total price including taxes"}},"required":["subtotal","taxes","total"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The LikeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"LikeDto":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"user":{"type":"object"},"_links":{"type":"object"}},"required":["id","createdAt","user","_links"]}}}} ``` ## The LikeCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"LikeCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LikeDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"LikeDto":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"user":{"type":"object"},"_links":{"type":"object"}},"required":["id","createdAt","user","_links"]},"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"]}}}} ``` ## The ReservationSessionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ReservationSessionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The ReservationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"}}}}}} ``` ## The ReservationCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"}}}}}} ``` ## The EventTableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The EventTableCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The GuestsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"GuestsDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number","nullable":true}},"required":["displayName","displayNameShort","max"]}}}} ``` ## The EventAdmissionRatingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventAdmissionRatingDto":{"type":"object","properties":{"minRating":{"type":"number"},"maxRating":{"type":"number"},"type":{"type":"string","enum":["SINGLES","DOUBLES"]}},"required":["minRating","maxRating","type"]}}}} ``` ## The PodPassRateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodPassRateDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"rate":{"type":"number"}},"required":["id","displayName","rate"]}}}} ``` ## The EventAdmissionRateMembershipDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventAdmissionRateMembershipDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number"}},"required":["membership","rate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventAdmissionRateMembershipCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventAdmissionRateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventAdmissionDateMembershipDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventAdmissionDateMembershipDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"date":{"format":"date-time","type":"string"}},"required":["date"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventAdmissionDateMembershipCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventAdmissionDateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The SwishDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The PodPlayTournamentDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]}}}} ``` ## The TournamentDivisionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventVisibilityScheduleDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventVisibilityScheduleCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The UserProfileCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventTeamDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The EventTeamCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The EventDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The EventPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The OpenInvitationRedeemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OpenInvitationRedeemDto":{"type":"object","properties":{"sharingKey":{"type":"string","writeOnly":true},"redeemUrl":{"type":"string","writeOnly":true},"owner":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["sharingKey","redeemUrl","owner"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventPatchableDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"guests":{"$ref":"#/components/schemas/GuestsDto"},"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"]},"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"]}},"status":{"type":"string","enum":["INVALID","DRAFT","CONFIRMED","PUBLISHED"]},"tournamentDivision":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TournamentDivisionDto"}]}},"required":["name","description","startTime","endTime","guests","totalTeams","teamSize","admission","admissionRating","admissionRate","admissionDate","admissionKids","allowedMemberships","coachRate","freeSignupCancellationHorizonHours","tags","visibility","features","status","tournamentDivision"]},"GuestsDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number","nullable":true}},"required":["displayName","displayNameShort","max"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The EventTablePatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventTablePatchableDto":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED_TABLE","AUTO"],"writeOnly":true},"table":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"startTime":{"format":"date-time","type":"string","writeOnly":true},"endTime":{"format":"date-time","type":"string","writeOnly":true}},"required":["type","table","startTime","endTime"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventCloneDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventCloneDto":{"type":"object","properties":{"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string","nullable":true},"courts":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"sourceEvent":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"clonedEvent":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"visibility":{"type":"string","enum":["LISTED","UNLISTED"]},"membersOnly":{"type":"boolean"},"visibilitySchedules":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventVisibilityScheduleCollectionDto"}]},"status":{"type":"string","enum":["INVALID","DRAFT","CONFIRMED","PUBLISHED"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["startTime","endTime","courts","sourceEvent","clonedEvent","visibility","membersOnly","visibilitySchedules","status","errors"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The EventChatChannelDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventChatChannelDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string","readOnly":true}},"required":["id","displayName"]}}}} ``` ## The EventSignupGuestsOptionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupGuestsOptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"guests":{"type":"number"},"rate":{"type":"number"}},"required":["id","displayName","guests","rate"]}}}} ``` ## The EventSignupGuestsOptionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupGuestsOptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSignupGuestsOptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSignupGuestsOptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"guests":{"type":"number"},"rate":{"type":"number"}},"required":["id","displayName","guests","rate"]},"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"]}}}} ``` ## The EventSignupSummaryRatesDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupSummaryRatesDto":{"type":"object","properties":{"signup":{"type":"number","readOnly":true},"guests":{"type":"number","readOnly":true},"teamLeader":{"type":"number","readOnly":true},"teamMember":{"type":"number","readOnly":true}},"required":["signup","guests"]}}}} ``` ## The EventSignupSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupSummaryDto":{"type":"object","properties":{"event":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"currency":{"type":"string","readOnly":true},"rates":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryRatesDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"couponDiscount":{"type":"number","readOnly":true},"package":{"readOnly":true,"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"total":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["event","invitation","openInvitation","currency","rates","subtotal","taxes","virtualCredits","couponDiscount","package","passes","total","errors"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"EventSignupSummaryRatesDto":{"type":"object","properties":{"signup":{"type":"number","readOnly":true},"guests":{"type":"number","readOnly":true},"teamLeader":{"type":"number","readOnly":true},"teamMember":{"type":"number","readOnly":true}},"required":["signup","guests"]},"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"]},"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"]}}}} ``` ## The EventSignupDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","INVALID","PENDING","CONFIRMED","CANCELED","REQUIRES_AUTHENTICATION","PROCESSING"],"readOnly":true},"mode":{"type":"string","enum":["USER_BOOKED","FREE_OF_CHARGE"],"writeOnly":true,"nullable":true},"paymentMethod":{"type":"string","enum":["CASH","CARD"],"writeOnly":true,"nullable":true},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true},"couponCode":{"type":"string","writeOnly":true,"nullable":true},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE","USE_ONLY_OWNER","USE_ONLY_GUESTS"],"nullable":true},"termsAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Terms\" along with the signup request."},"liabilityWaiverAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Liability waiver\" along with the signup request."},"availableGuests":{"description":"The additional guests that can be added to the signup.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupGuestsOptionCollectionDto"}]},"guests":{"writeOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"kids":{"writeOnly":false,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"coupon":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/CouponSummaryDto"}]},"summary":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryDto"}]},"owner":{"$ref":"#/components/schemas/ItemRefDto"},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","status","mode","paymentMethod","virtualCredits","couponCode","passesStrategy","termsAgreed","liabilityWaiverAgreed","availableGuests","guests","kids","coupon","summary","owner","order","_links"]},"EventSignupGuestsOptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSignupGuestsOptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSignupGuestsOptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"guests":{"type":"number"},"rate":{"type":"number"}},"required":["id","displayName","guests","rate"]},"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"]},"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"]},"CouponSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","code","discountType","value","_links"]},"EventSignupSummaryDto":{"type":"object","properties":{"event":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"currency":{"type":"string","readOnly":true},"rates":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryRatesDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"couponDiscount":{"type":"number","readOnly":true},"package":{"readOnly":true,"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"total":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["event","invitation","openInvitation","currency","rates","subtotal","taxes","virtualCredits","couponDiscount","package","passes","total","errors"]},"EventSignupSummaryRatesDto":{"type":"object","properties":{"signup":{"type":"number","readOnly":true},"guests":{"type":"number","readOnly":true},"teamLeader":{"type":"number","readOnly":true},"teamMember":{"type":"number","readOnly":true}},"required":["signup","guests"]},"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"]},"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"]}}}} ``` ## The EventSignupCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSignupDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSignupDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","INVALID","PENDING","CONFIRMED","CANCELED","REQUIRES_AUTHENTICATION","PROCESSING"],"readOnly":true},"mode":{"type":"string","enum":["USER_BOOKED","FREE_OF_CHARGE"],"writeOnly":true,"nullable":true},"paymentMethod":{"type":"string","enum":["CASH","CARD"],"writeOnly":true,"nullable":true},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true},"couponCode":{"type":"string","writeOnly":true,"nullable":true},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE","USE_ONLY_OWNER","USE_ONLY_GUESTS"],"nullable":true},"termsAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Terms\" along with the signup request."},"liabilityWaiverAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Liability waiver\" along with the signup request."},"availableGuests":{"description":"The additional guests that can be added to the signup.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupGuestsOptionCollectionDto"}]},"guests":{"writeOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"kids":{"writeOnly":false,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"coupon":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/CouponSummaryDto"}]},"summary":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryDto"}]},"owner":{"$ref":"#/components/schemas/ItemRefDto"},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","status","mode","paymentMethod","virtualCredits","couponCode","passesStrategy","termsAgreed","liabilityWaiverAgreed","availableGuests","guests","kids","coupon","summary","owner","order","_links"]},"EventSignupGuestsOptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSignupGuestsOptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSignupGuestsOptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"guests":{"type":"number"},"rate":{"type":"number"}},"required":["id","displayName","guests","rate"]},"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"]},"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"]},"CouponSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","code","discountType","value","_links"]},"EventSignupSummaryDto":{"type":"object","properties":{"event":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"currency":{"type":"string","readOnly":true},"rates":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryRatesDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"couponDiscount":{"type":"number","readOnly":true},"package":{"readOnly":true,"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"total":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["event","invitation","openInvitation","currency","rates","subtotal","taxes","virtualCredits","couponDiscount","package","passes","total","errors"]},"EventSignupSummaryRatesDto":{"type":"object","properties":{"signup":{"type":"number","readOnly":true},"guests":{"type":"number","readOnly":true},"teamLeader":{"type":"number","readOnly":true},"teamMember":{"type":"number","readOnly":true}},"required":["signup","guests"]},"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"]},"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"]}}}} ``` ## The EventSignupCancellationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventSignupCancellationDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","FAILED","PENDING","CONFIRMED"],"readOnly":true},"reason":{"type":"string","enum":["WEATHER","LOW_TURNOUT","OTHER"],"readOnly":true,"nullable":true},"reasonText":{"type":"string","nullable":true,"description":"Optional free-text reason when reason is OTHER. Max 40 characters."},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventCancellationSummaryDto"}]}},"required":["type","status","summary"]},"EventCancellationSummaryDto":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventAttendeeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventAttendeeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string","readOnly":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["ANONYMOUS","HIDE_RATING"]}},"rating":{"type":"number","readOnly":true},"team":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["id","displayName","flags","rating"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The EventAttendeeCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventAttendeeCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventAttendeeDto"}},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventAttendeeDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string","readOnly":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["ANONYMOUS","HIDE_RATING"]}},"rating":{"type":"number","readOnly":true},"team":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["id","displayName","flags","rating"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The EventRescheduleDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventRescheduleDto":{"type":"object","properties":{"startTime":{"format":"date-time","type":"string","description":"Destination start time for the provided calendar event"},"endTime":{"format":"date-time","type":"string","description":"Destination end time for the provided calendar event"},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["startTime","endTime","status","errors"]},"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"]}}}} ``` ## The CoachProfileCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CoachProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_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"}}},"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"]}}}} ``` ## The CoachAdditionRateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CoachAdditionRateDto":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Rate type: FIXED for absolute amount, PERCENTAGE for revenue share"},"value":{"type":"number","description":"Rate value. For FIXED: amount in dollars. For PERCENTAGE: percentage (0-100)"}},"required":["type","value"]}}}} ``` ## The EventCoachAdditionSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventCoachAdditionSummaryDto":{"type":"object","properties":{"coachRate":{"type":"number","readOnly":true},"effectiveRate":{"type":"number","readOnly":true,"nullable":true},"discount":{"type":"number","readOnly":true,"nullable":true},"errors":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["coachRate","effectiveRate","discount","errors"]},"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"]}}}} ``` ## The InviteeCheckInDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InviteeCheckInDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["NOT_CHECKED_IN","CHECKED_IN"],"readOnly":true},"checkedInBy":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"checkedInAt":{"format":"date-time","type":"string","nullable":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["REQUIRES_DAY_PASS"]}},"_links":{"type":"object","readOnly":true}},"required":["id","status","checkedInBy","checkedInAt","flags","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The InviteeVaccinationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InviteeVaccinationDto":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_CHECKED","PRE_CHECKED","CHECKED","EXPIRED","PRE_CHECK_EXPIRED","PENDING_CHECK","DENIED"]},"expiration":{"format":"date-time","type":"string","nullable":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["status","expiration","_links"]},"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"]}}}} ``` ## The InvitationInviteeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationInviteeDto":{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userId":{"type":"string"}},"required":["fullName","email","phoneNumber","userId"]}}}} ``` ## The InvitationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"lastModifiedDate":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["BOOKING","GUEST","COACH","EVENT_SIGNUP","SERIES_SIGNUP","INTERNAL"],"readOnly":true},"chargeType":{"type":"string","enum":["FREE","SPLIT_PAYMENT","PAID_BY_INVITER"],"nullable":true},"maxChargableAmount":{"type":"number","readOnly":true},"coachRate":{"type":"number","nullable":true},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"nullable":true,"readOnly":true},"status":{"type":"string","enum":["INVITATION_EXTENDED","ACCEPTED","DECLINED","CANCELED","EXPIRED","CHECKED_IN","COMPLETE","INVALID","REQUIRES_AUTHENTICATION","CHARGE_FAILED"],"readOnly":true},"inviterProfile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeProfile":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"checkIn":{"nullable":false,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeCheckInDto"}]},"inviteeVaccination":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeVaccinationDto"}]},"inviteeMetadata":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitee":{"$ref":"#/components/schemas/InvitationInviteeDto"},"kid":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeNotes":{"type":"string","readOnly":true},"acceptUrl":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","createdDate","lastModifiedDate","type","chargeType","maxChargableAmount","coachRate","rateType","status","inviterProfile","inviteeProfile","checkIn","inviteeVaccination","inviteeMetadata","invitee","kid","inviteeNotes","acceptUrl","order","openInvitation","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"InviteeCheckInDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["NOT_CHECKED_IN","CHECKED_IN"],"readOnly":true},"checkedInBy":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"checkedInAt":{"format":"date-time","type":"string","nullable":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["REQUIRES_DAY_PASS"]}},"_links":{"type":"object","readOnly":true}},"required":["id","status","checkedInBy","checkedInAt","flags","_links"]},"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"]},"InviteeVaccinationDto":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_CHECKED","PRE_CHECKED","CHECKED","EXPIRED","PRE_CHECK_EXPIRED","PENDING_CHECK","DENIED"]},"expiration":{"format":"date-time","type":"string","nullable":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["status","expiration","_links"]},"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"]},"InvitationInviteeDto":{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userId":{"type":"string"}},"required":["fullName","email","phoneNumber","userId"]},"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"]}}}} ``` ## The EventCoachAdditionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventCoachAdditionDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"],"description":"PREVIEW to calculate without persisting, ORDER to create and accept the invitation"},"coach":{"description":"Coach reference. Must have an id property","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rate":{"nullable":true,"writeOnly":true,"description":"Optional rate override. If not provided, uses event default or coach tier rate","allOf":[{"$ref":"#/components/schemas/CoachAdditionRateDto"}]},"summary":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventCoachAdditionSummaryDto"}]},"invitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/InvitationDto"}]},"_links":{"type":"object","readOnly":true}},"required":["type","coach","rate","summary","invitation","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CoachAdditionRateDto":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"Rate type: FIXED for absolute amount, PERCENTAGE for revenue share"},"value":{"type":"number","description":"Rate value. For FIXED: amount in dollars. For PERCENTAGE: percentage (0-100)"}},"required":["type","value"]},"EventCoachAdditionSummaryDto":{"type":"object","properties":{"coachRate":{"type":"number","readOnly":true},"effectiveRate":{"type":"number","readOnly":true,"nullable":true},"discount":{"type":"number","readOnly":true,"nullable":true},"errors":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["coachRate","effectiveRate","discount","errors"]},"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"]},"InvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"lastModifiedDate":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["BOOKING","GUEST","COACH","EVENT_SIGNUP","SERIES_SIGNUP","INTERNAL"],"readOnly":true},"chargeType":{"type":"string","enum":["FREE","SPLIT_PAYMENT","PAID_BY_INVITER"],"nullable":true},"maxChargableAmount":{"type":"number","readOnly":true},"coachRate":{"type":"number","nullable":true},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"nullable":true,"readOnly":true},"status":{"type":"string","enum":["INVITATION_EXTENDED","ACCEPTED","DECLINED","CANCELED","EXPIRED","CHECKED_IN","COMPLETE","INVALID","REQUIRES_AUTHENTICATION","CHARGE_FAILED"],"readOnly":true},"inviterProfile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeProfile":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"checkIn":{"nullable":false,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeCheckInDto"}]},"inviteeVaccination":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeVaccinationDto"}]},"inviteeMetadata":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitee":{"$ref":"#/components/schemas/InvitationInviteeDto"},"kid":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeNotes":{"type":"string","readOnly":true},"acceptUrl":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","createdDate","lastModifiedDate","type","chargeType","maxChargableAmount","coachRate","rateType","status","inviterProfile","inviteeProfile","checkIn","inviteeVaccination","inviteeMetadata","invitee","kid","inviteeNotes","acceptUrl","order","openInvitation","errors","_links"]},"InviteeCheckInDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["NOT_CHECKED_IN","CHECKED_IN"],"readOnly":true},"checkedInBy":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"checkedInAt":{"format":"date-time","type":"string","nullable":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["REQUIRES_DAY_PASS"]}},"_links":{"type":"object","readOnly":true}},"required":["id","status","checkedInBy","checkedInAt","flags","_links"]},"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"]},"InviteeVaccinationDto":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_CHECKED","PRE_CHECKED","CHECKED","EXPIRED","PRE_CHECK_EXPIRED","PENDING_CHECK","DENIED"]},"expiration":{"format":"date-time","type":"string","nullable":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["status","expiration","_links"]},"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"]},"InvitationInviteeDto":{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userId":{"type":"string"}},"required":["fullName","email","phoneNumber","userId"]}}}} ``` ## The CreateTournamentDivisionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CreateTournamentDivisionDto":{"type":"object","properties":{"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"}]},"visibility":{"type":"string","enum":["HIDDEN","VISIBLE"],"description":"Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null"}},"required":["provider"]},"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"]}}}} ``` ## The PatchTournamentDivisionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PatchTournamentDivisionDto":{"type":"object","properties":{"swish":{"description":"Tournament data specific to Swish","allOf":[{"$ref":"#/components/schemas/SwishDto"}]},"podplay":{"description":"Tournament data specific to PodPlay","allOf":[{"$ref":"#/components/schemas/PodPlayTournamentDto"}]},"visibility":{"type":"string","enum":["HIDDEN","VISIBLE"],"description":"Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null"}}},"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"]}}}} ``` ## The InvitationCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InvitationDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"InvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"lastModifiedDate":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["BOOKING","GUEST","COACH","EVENT_SIGNUP","SERIES_SIGNUP","INTERNAL"],"readOnly":true},"chargeType":{"type":"string","enum":["FREE","SPLIT_PAYMENT","PAID_BY_INVITER"],"nullable":true},"maxChargableAmount":{"type":"number","readOnly":true},"coachRate":{"type":"number","nullable":true},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"nullable":true,"readOnly":true},"status":{"type":"string","enum":["INVITATION_EXTENDED","ACCEPTED","DECLINED","CANCELED","EXPIRED","CHECKED_IN","COMPLETE","INVALID","REQUIRES_AUTHENTICATION","CHARGE_FAILED"],"readOnly":true},"inviterProfile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeProfile":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"checkIn":{"nullable":false,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeCheckInDto"}]},"inviteeVaccination":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeVaccinationDto"}]},"inviteeMetadata":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitee":{"$ref":"#/components/schemas/InvitationInviteeDto"},"kid":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeNotes":{"type":"string","readOnly":true},"acceptUrl":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","createdDate","lastModifiedDate","type","chargeType","maxChargableAmount","coachRate","rateType","status","inviterProfile","inviteeProfile","checkIn","inviteeVaccination","inviteeMetadata","invitee","kid","inviteeNotes","acceptUrl","order","openInvitation","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"InviteeCheckInDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["NOT_CHECKED_IN","CHECKED_IN"],"readOnly":true},"checkedInBy":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"checkedInAt":{"format":"date-time","type":"string","nullable":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["REQUIRES_DAY_PASS"]}},"_links":{"type":"object","readOnly":true}},"required":["id","status","checkedInBy","checkedInAt","flags","_links"]},"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"]},"InviteeVaccinationDto":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_CHECKED","PRE_CHECKED","CHECKED","EXPIRED","PRE_CHECK_EXPIRED","PENDING_CHECK","DENIED"]},"expiration":{"format":"date-time","type":"string","nullable":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["status","expiration","_links"]},"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"]},"InvitationInviteeDto":{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userId":{"type":"string"}},"required":["fullName","email","phoneNumber","userId"]},"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"]}}}} ``` ## The InvitationInviteePatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationInviteePatchDto":{"type":"object","properties":{"fullName":{"type":"string"}},"required":["fullName"]}}}} ``` ## The InvitationPatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationPatchDto":{"type":"object","properties":{"type":{"type":"string","enum":["COACH"],"writeOnly":true},"status":{"type":"string","enum":["ACCEPTED","CANCELED"],"writeOnly":true},"chargeType":{"type":"string","enum":["FREE","SPLIT_PAYMENT","PAID_BY_INVITER"],"nullable":true,"writeOnly":true},"coachRate":{"type":"number","nullable":true},"invitee":{"$ref":"#/components/schemas/InvitationInviteePatchDto"},"inviteeNotes":{"type":"string","writeOnly":true}},"required":["type","status","chargeType","coachRate","invitee","inviteeNotes"]},"InvitationInviteePatchDto":{"type":"object","properties":{"fullName":{"type":"string"}},"required":["fullName"]}}}} ``` ## The InvitationAcceptanceSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationAcceptanceSummaryDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when accepting an invitation. Valid codes are: DAY_PASS_REQUIRED, PRICE_MAY_VARY, COACHING_CREDITS, CHARGED_IMMEDIATELY, PASSES_APPLIED, COVERED_BY_LEADER","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["subtotal","taxes","virtualCredits","total","passes","errors","messages"]},"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"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The InvitationAcceptanceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InvitationAcceptanceDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"invitationType":{"type":"string","enum":["COACH","PARTICIPANT"],"writeOnly":true,"nullable":true},"coachRate":{"type":"number","writeOnly":true,"nullable":true},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE"],"nullable":true,"writeOnly":true},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InvitationAcceptanceSummaryDto"}]},"invitation":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object","readOnly":true}},"required":["type","invitationType","coachRate","virtualCredits","passesStrategy","summary","invitation","_links"]},"InvitationAcceptanceSummaryDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when accepting an invitation. Valid codes are: DAY_PASS_REQUIRED, PRICE_MAY_VARY, COACHING_CREDITS, CHARGED_IMMEDIATELY, PASSES_APPLIED, COVERED_BY_LEADER","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["subtotal","taxes","virtualCredits","total","passes","errors","messages"]},"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"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The InviteeVaccinationProofDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InviteeVaccinationProofDto":{"type":"object","properties":{"vaccinationProof":{"type":"string","format":"binary"},"customerId":{"type":"string","format":"binary"},"preCheckOptOut":{"type":"boolean"}},"required":["vaccinationProof","customerId","preCheckOptOut"]}}}} ``` ## The InviteeMetadataDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"InviteeMetadataDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"tags":{"type":"array","items":{"type":"string"}},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["id","tags","_links"]},"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"]}}}} ``` ## The BookingParticipantDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingParticipantDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"],"description":"PREVIEW returns calculated costs without creating records. ORDER creates and accepts the invitation."},"invitee":{"description":"Details of the participant being added","allOf":[{"$ref":"#/components/schemas/InvitationInviteeDto"}]},"chargeType":{"type":"string","enum":["SPLIT_PAYMENT","PAID_BY_INVITER"],"description":"How the guest spot will be charged. SPLIT_PAYMENT charges the invitee, PAID_BY_INVITER charges the booking owner."},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true,"description":"Amount of virtual credits to apply to the invitation (in dollars)"},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE"],"nullable":true,"writeOnly":true,"description":"Whether to apply available play passes. Defaults to USE_ALL."},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"invitation":{"readOnly":true,"description":"The created invitation details","allOf":[{"$ref":"#/components/schemas/InvitationDto"}]},"summary":{"readOnly":true,"description":"Cost breakdown and acceptance summary","allOf":[{"$ref":"#/components/schemas/InvitationAcceptanceSummaryDto"}]},"_links":{"type":"object","readOnly":true,"description":"HATEOAS links to related resources"}},"required":["type","invitee","chargeType","virtualCredits","passesStrategy","invitation","summary","_links"]},"InvitationInviteeDto":{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"userId":{"type":"string"}},"required":["fullName","email","phoneNumber","userId"]},"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"]},"InvitationDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"lastModifiedDate":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["BOOKING","GUEST","COACH","EVENT_SIGNUP","SERIES_SIGNUP","INTERNAL"],"readOnly":true},"chargeType":{"type":"string","enum":["FREE","SPLIT_PAYMENT","PAID_BY_INVITER"],"nullable":true},"maxChargableAmount":{"type":"number","readOnly":true},"coachRate":{"type":"number","nullable":true},"rateType":{"type":"string","enum":["FIXED","PERCENTAGE"],"nullable":true,"readOnly":true},"status":{"type":"string","enum":["INVITATION_EXTENDED","ACCEPTED","DECLINED","CANCELED","EXPIRED","CHECKED_IN","COMPLETE","INVALID","REQUIRES_AUTHENTICATION","CHARGE_FAILED"],"readOnly":true},"inviterProfile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeProfile":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"checkIn":{"nullable":false,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeCheckInDto"}]},"inviteeVaccination":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/InviteeVaccinationDto"}]},"inviteeMetadata":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitee":{"$ref":"#/components/schemas/InvitationInviteeDto"},"kid":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"inviteeNotes":{"type":"string","readOnly":true},"acceptUrl":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","createdDate","lastModifiedDate","type","chargeType","maxChargableAmount","coachRate","rateType","status","inviterProfile","inviteeProfile","checkIn","inviteeVaccination","inviteeMetadata","invitee","kid","inviteeNotes","acceptUrl","order","openInvitation","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"InviteeCheckInDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["NOT_CHECKED_IN","CHECKED_IN"],"readOnly":true},"checkedInBy":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/UserProfileDto"}]},"checkedInAt":{"format":"date-time","type":"string","nullable":true},"flags":{"type":"array","readOnly":true,"items":{"type":"string","enum":["REQUIRES_DAY_PASS"]}},"_links":{"type":"object","readOnly":true}},"required":["id","status","checkedInBy","checkedInAt","flags","_links"]},"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"]},"InviteeVaccinationDto":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_CHECKED","PRE_CHECKED","CHECKED","EXPIRED","PRE_CHECK_EXPIRED","PENDING_CHECK","DENIED"]},"expiration":{"format":"date-time","type":"string","nullable":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["status","expiration","_links"]},"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"]},"InvitationAcceptanceSummaryDto":{"type":"object","properties":{"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when accepting an invitation. Valid codes are: DAY_PASS_REQUIRED, PRICE_MAY_VARY, COACHING_CREDITS, CHARGED_IMMEDIATELY, PASSES_APPLIED, COVERED_BY_LEADER","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["subtotal","taxes","virtualCredits","total","passes","errors","messages"]},"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"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The PatchableInAppMessageDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PatchableInAppMessageDto":{"type":"object","properties":{"lastRead":{"format":"date-time","type":"string","nullable":true}},"required":["lastRead"]}}}} ``` ## The AuditLogPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_total","_links"]},"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"]}}}} ``` ## The AuditLogUserDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogUserDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"isAnonymous":{"type":"boolean","readOnly":true}},"required":["id","isAnonymous"]}}}} ``` ## The AuditLogIpAsnDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogIpAsnDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"nullable":true},"organization":{"type":"string","readOnly":true,"nullable":true}},"required":["id","organization"]}}}} ``` ## The AuditLogIpDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogIpDto":{"type":"object","properties":{"address":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","readOnly":true,"nullable":true},"longitude":{"type":"string","readOnly":true,"nullable":true},"continent":{"type":"string","readOnly":true,"nullable":true},"timezone":{"type":"string","readOnly":true,"nullable":true},"asn":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogIpAsnDto"}]}},"required":["address","country","latitude","longitude","continent","timezone","asn"]},"AuditLogIpAsnDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"nullable":true},"organization":{"type":"string","readOnly":true,"nullable":true}},"required":["id","organization"]}}}} ``` ## The AuditLogRequestRouteDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogRequestRouteDto":{"type":"object","properties":{"path":{"type":"string","readOnly":true,"nullable":true},"params":{"type":"object","readOnly":true,"nullable":true}},"required":["path","params"]}}}} ``` ## The AuditLogRequestDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogRequestDto":{"type":"object","properties":{"body":{"type":"object","readOnly":true,"nullable":true},"headers":{"type":"object","readOnly":true,"nullable":true},"method":{"type":"string","enum":["PUT","POST","PATCH","DELETE"],"readOnly":true,"nullable":true},"route":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogRequestRouteDto"}]},"url":{"type":"string","readOnly":true,"nullable":true},"sizeBytes":{"type":"number","readOnly":true,"nullable":true}},"required":["body","headers","method","route","url","sizeBytes"]},"AuditLogRequestRouteDto":{"type":"object","properties":{"path":{"type":"string","readOnly":true,"nullable":true},"params":{"type":"object","readOnly":true,"nullable":true}},"required":["path","params"]}}}} ``` ## The AuditLogResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogResponseDto":{"type":"object","properties":{"body":{"type":"object","readOnly":true,"nullable":true},"headers":{"type":"object","readOnly":true,"nullable":true},"status":{"type":"number","readOnly":true,"nullable":true},"sizeBytes":{"type":"number","readOnly":true,"nullable":true}},"required":["body","headers","status","sizeBytes"]}}}} ``` ## The AuditLogTagCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogTagCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The AuditLogDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AuditLogDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["HTTP_REQ_RES","EVENT","ACCOUNT"],"readOnly":true},"apiVersion":{"type":"string","readOnly":true},"subtype":{"type":"string","enum":["EVENT_SIGNUP","EVENT_SIGNUP_CANCELLATION","EVENT_SERIES_SIGNUP","EVENT_SERIES_SIGNUP_CANCELLATION","EVENT_REPLAYS_SUMMARY","EVENT_COACH_REQUEST_SENT","EVENT_BOOKING_ATTEMPT_FAILURE","EVENT_BOOKING_ATTEMPT_SUCCESS","EVENT_CANCELLATION","EVENT_SUSPENSION","ACCOUNT_DELETION","ACCOUNT_ACTIVATION","ACCOUNT_DEACTIVATION"],"readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/AuditLogUserDto"}]},"processingTimeMs":{"type":"number","readOnly":true},"tenant":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"timestamp":{"format":"date-time","type":"string","readOnly":true},"ip":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/AuditLogIpDto"}]},"request":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogRequestDto"}]},"response":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogResponseDto"}]},"notes":{"type":"string","readOnly":true,"nullable":true},"tags":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogTagCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","type","apiVersion","subtype","user","processingTimeMs","tenant","timestamp","ip","request","response","notes","tags","errors","_links"]},"AuditLogUserDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"isAnonymous":{"type":"boolean","readOnly":true}},"required":["id","isAnonymous"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"AuditLogIpDto":{"type":"object","properties":{"address":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","readOnly":true,"nullable":true},"longitude":{"type":"string","readOnly":true,"nullable":true},"continent":{"type":"string","readOnly":true,"nullable":true},"timezone":{"type":"string","readOnly":true,"nullable":true},"asn":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogIpAsnDto"}]}},"required":["address","country","latitude","longitude","continent","timezone","asn"]},"AuditLogIpAsnDto":{"type":"object","properties":{"id":{"type":"number","readOnly":true,"nullable":true},"organization":{"type":"string","readOnly":true,"nullable":true}},"required":["id","organization"]},"AuditLogRequestDto":{"type":"object","properties":{"body":{"type":"object","readOnly":true,"nullable":true},"headers":{"type":"object","readOnly":true,"nullable":true},"method":{"type":"string","enum":["PUT","POST","PATCH","DELETE"],"readOnly":true,"nullable":true},"route":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/AuditLogRequestRouteDto"}]},"url":{"type":"string","readOnly":true,"nullable":true},"sizeBytes":{"type":"number","readOnly":true,"nullable":true}},"required":["body","headers","method","route","url","sizeBytes"]},"AuditLogRequestRouteDto":{"type":"object","properties":{"path":{"type":"string","readOnly":true,"nullable":true},"params":{"type":"object","readOnly":true,"nullable":true}},"required":["path","params"]},"AuditLogResponseDto":{"type":"object","properties":{"body":{"type":"object","readOnly":true,"nullable":true},"headers":{"type":"object","readOnly":true,"nullable":true},"status":{"type":"number","readOnly":true,"nullable":true},"sizeBytes":{"type":"number","readOnly":true,"nullable":true}},"required":["body","headers","status","sizeBytes"]},"AuditLogTagCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The CameraConfigDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]}}}} ``` ## The ReplayServerConfigDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]}}}} ``` ## The ReplayServerDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayServerDto":{"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"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"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"]}}}} ``` ## The ReplayServerCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayServerCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReplayServerDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"ReplayServerDto":{"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"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"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"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The VersionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"VersionDto":{"type":"object","properties":{"version":{"type":"string","description":"Version string (semver)","readOnly":true}},"required":["version"]}}}} ``` ## The AvailableVersionsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AvailableVersionsResponseDto":{"type":"object","properties":{"versions":{"description":"List of available versions sorted newest first","type":"array","items":{"$ref":"#/components/schemas/VersionDto"}}},"required":["versions"]},"VersionDto":{"type":"object","properties":{"version":{"type":"string","description":"Version string (semver)","readOnly":true}},"required":["version"]}}}} ``` ## The BrandingAssetDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BrandingAssetDto":{"type":"object","properties":{"name":{"type":"string","description":"File name"},"path":{"type":"string","description":"Full path in bucket"},"url":{"type":"string","description":"Signed URL for preview"}},"required":["name","path"]}}}} ``` ## The BrandingAssetsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BrandingAssetsResponseDto":{"type":"object","properties":{"assets":{"description":"List of branding assets","type":"array","items":{"$ref":"#/components/schemas/BrandingAssetDto"}}},"required":["assets"]},"BrandingAssetDto":{"type":"object","properties":{"name":{"type":"string","description":"File name"},"path":{"type":"string","description":"Full path in bucket"},"url":{"type":"string","description":"Signed URL for preview"}},"required":["name","path"]}}}} ``` ## The BrandingAssetUploadDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BrandingAssetUploadDto":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File to upload"}},"required":["file"]}}}} ``` ## The SetTargetVersionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SetTargetVersionDto":{"type":"object","properties":{"version":{"type":"string","description":"Target version for this replay server (empty string or null to clear)"}}}}}} ``` ## The ApproveReplayServerDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApproveReplayServerDto":{"type":"object","properties":{"server":{"description":"The replay server to approve","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"area":{"description":"The area to assign the replay server to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"displayName":{"type":"string","description":"Optional display name for the server"}},"required":["server","area"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The RegisterDeviceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RegisterDeviceDto":{"type":"object","properties":{"deviceId":{"type":"string","description":"Unique device identifier (e.g., Mac mini MAC address or UUID)"},"hostname":{"type":"string","description":"Device hostname for display"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the device (set during first-time setup)"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address of the device"}},"required":["deviceId"]}}}} ``` ## The RegisterDeviceResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RegisterDeviceResponseDto":{"type":"object","properties":{"serverId":{"type":"string","description":"The server ID to use for polling status","readOnly":true},"status":{"type":"string","description":"Current status of the registration","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"pollInterval":{"type":"number","description":"Recommended polling interval in seconds","readOnly":true},"displayName":{"type":"string","description":"Existing display name (if already set)","readOnly":true}},"required":["serverId","status","pollInterval"]}}}} ``` ## The PendingUpdateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PendingUpdateDto":{"type":"object","properties":{"version":{"type":"string","description":"Target version to update to","readOnly":true}},"required":["version"]}}}} ``` ## The DeviceStatusResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DeviceStatusResponseDto":{"type":"object","properties":{"status":{"type":"string","description":"Current status","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"accessToken":{"type":"string","description":"The access token (only when approved)","readOnly":true},"area":{"description":"Area the server is assigned to (only when approved)","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"pendingUpdate":{"description":"Pending update information (only when an update is available)","allOf":[{"$ref":"#/components/schemas/PendingUpdateDto"}]},"config":{"description":"Server configuration to apply","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]}},"required":["status"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"PendingUpdateDto":{"type":"object","properties":{"version":{"type":"string","description":"Target version to update to","readOnly":true}},"required":["version"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]}}}} ``` ## The TransferCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The OrderItemCancellationSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The OrderItemCancellationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The OrderItemCancellationCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The DeprecatedProductPictureDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DeprecatedProductPictureDto":{"type":"object","properties":{"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"}},"required":["small","medium","large"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}}} ``` ## The DeprecatedProductDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"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"]}}}} ``` ## The DeprecatedProductCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"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"]}}}} ``` ## The EventCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The OrderDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"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"]},"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"]},"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"]}}}} ``` ## The OrderCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OrderCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"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"]},"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"]},"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"]}}}} ``` ## The OrderItemCreationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OrderItemCreationDto":{"type":"object","properties":{"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"},"productOffering":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"posProductOffering":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"event":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"replay":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"sku":{"type":"string"},"appliesTo":{"nullable":true,"description":"Users that this order item applies to","allOf":[{"$ref":"#/components/schemas/UserCollectionDto"}]}},"required":["type","name","description","quantity","price","productOffering","posProductOffering","event","replay","sku","appliesTo"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The OrderCreationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OrderCreationDto":{"type":"object","properties":{"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"]},"paymentMethod":{"type":"string","enum":["CASH","CARD","POS"]},"virtualCredits":{"type":"number"},"taxExempt":{"type":"boolean","default":false},"vendingMachineOrderId":{"type":"string"},"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"}]},"items":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/OrderItemCreationDto"}},"terminal":{"nullable":true,"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"paymentMethodSettings":{"type":"string","writeOnly":true,"enum":["STORE"]}},"required":["type","paymentMethod","user","areas","pod","event","items","terminal"]},"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"]},"OrderItemCreationDto":{"type":"object","properties":{"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"},"productOffering":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"posProductOffering":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"event":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"replay":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"sku":{"type":"string"},"appliesTo":{"nullable":true,"description":"Users that this order item applies to","allOf":[{"$ref":"#/components/schemas/UserCollectionDto"}]}},"required":["type","name","description","quantity","price","productOffering","posProductOffering","event","replay","sku","appliesTo"]},"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"]},"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"]}}}} ``` ## The OrderAuthenticationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OrderAuthenticationDto":{"type":"object","properties":{"paymentIntentIds":{"type":"array","items":{"type":"string"}}},"required":["paymentIntentIds"]}}}} ``` ## The AmountSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AmountSummaryDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string","nullable":true}},"required":["amount","description"]}}}} ``` ## The DeprecatedProductOfferingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DeprecatedProductOfferingDto":{"type":"object","properties":{"id":{"type":"string"},"product":{"$ref":"#/components/schemas/DeprecatedProductDto"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"discount":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/AmountSummaryDto"}]},"tax":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/AmountSummaryDto"}]},"subtotal":{"type":"number"},"total":{"type":"number"},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","product","areas","discount","tax","subtotal","total","user","_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"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"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"]},"AmountSummaryDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string","nullable":true}},"required":["amount","description"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The DeprecatedProductOfferingCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DeprecatedProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeprecatedProductOfferingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"DeprecatedProductOfferingDto":{"type":"object","properties":{"id":{"type":"string"},"product":{"$ref":"#/components/schemas/DeprecatedProductDto"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"discount":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/AmountSummaryDto"}]},"tax":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/AmountSummaryDto"}]},"subtotal":{"type":"number"},"total":{"type":"number"},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","product","areas","discount","tax","subtotal","total","user","_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"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"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"]},"AmountSummaryDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string","nullable":true}},"required":["amount","description"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ApiKeyDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","description":"Display name for the API key"},"apiKeySecret":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","status","user","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The ApiKeyCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeyCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"ApiKeyDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string","description":"Display name for the API key"},"apiKeySecret":{"type":"string","readOnly":true},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"user":{"$ref":"#/components/schemas/ItemRefDto"},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","status","user","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The ApiKeyPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeyPatchableDto":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name for the API key"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"isReadonly":{"type":"boolean","description":"When enabled, this API key is restricted to safe, read-only HTTP methods (GET, HEAD, OPTIONS, TRACE) and cannot perform writes","default":false}}}}}} ``` ## The ApiKeysConfigDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeysConfigDto":{"type":"object","properties":{"publicKey":{"type":"string","description":"RSA public key for verifying API key authentication tokens"},"privateKey":{"type":"string","description":"RSA private key preview for signing API key authentication tokens"},"keysSource":{"type":"string","description":"Source of the keys (tenant, environment, or none)","enum":["tenant","environment","none"]},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["publicKey","privateKey","keysSource","_links"]},"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"]}}}} ``` ## The ApiKeysConfigStatusDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeysConfigStatusDto":{"type":"object","properties":{"availableScenarios":{"type":"array","description":"Available scenarios based on current state","items":{"type":"string","enum":["create tenant keys","migrate to tenant keys","re-enable existing tenant keys","re-enable existing environment keys","generate fresh tenant keys"]}},"canChangeSource":{"type":"boolean","description":"Whether scenario selector should be disabled"},"keysSource":{"type":"string","description":"Current source of the keys","enum":["tenant","environment","none"]},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["availableScenarios","canChangeSource","keysSource","_links"]},"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"]}}}} ``` ## The ApiKeysConfigPatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeysConfigPatchDto":{"type":"object","properties":{"publicKey":{"type":"string","description":"RSA public key for verifying API key authentication tokens"},"privateKey":{"type":"string","description":"RSA private key preview for signing API key authentication tokens"}}}}}} ``` ## The ApiKeysChangeSourceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ApiKeysChangeSourceDto":{"type":"object","properties":{"scenario":{"type":"string","description":"Scenario to execute for changing API keys source","enum":["create tenant keys","migrate to tenant keys","re-enable existing tenant keys","re-enable existing environment keys","generate fresh tenant keys"]}},"required":["scenario"]}}}} ``` ## The UserPaymentElementCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPaymentElementCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The UserPaymentElementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPaymentElementDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"type":{"type":"string","readOnly":true,"enum":["klarna","card","us_bank_account"]},"displayName":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"contextAvailability":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["ACTIVE","INVALID","EXPIRED"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","user","type","displayName","description","contextAvailability","createdAt","status","errors","_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"]},"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"]}}}} ``` ## The UserPaymentElementContextAvailabilityCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPaymentElementContextAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The UserPaymentElementContextAvailabilityPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPaymentElementContextAvailabilityPatchableDto":{"type":"object","properties":{"isDefault":{"type":"boolean"}}}}}} ``` ## The UserPaymentElementContextAvailabilityDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserPaymentElementContextAvailabilityDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["booking","memberships"]},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"paymentElement":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"isDefault":{"type":"boolean"},"_links":{"type":"object","readOnly":true}},"required":["id","user","paymentElement","isDefault","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SegmentConfigurationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SegmentConfigurationDto":{"type":"object","properties":{"backendWriteKey":{"type":"string","description":"Backend Segment write key for server-side analytics (masked)"},"flushIntervalMs":{"type":"number","description":"Segment flush interval in milliseconds"},"isEnabled":{"type":"boolean","description":"Whether Segment analytics is enabled"}},"required":["backendWriteKey","flushIntervalMs","isEnabled"]}}}} ``` ## The SegmentConfigurationPatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SegmentConfigurationPatchDto":{"type":"object","properties":{"backendWriteKey":{"type":"string","description":"Backend Segment write key for server-side analytics (masked)"},"flushIntervalMs":{"type":"number","description":"Segment flush interval in milliseconds"}}}}}} ``` ## The ReplayEnhancementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayEnhancementDto":{"type":"object","properties":{"actionType":{"type":"string","description":"Action type: PREVIEW to simulate order, ORDER to create"},"paymentMethod":{"description":"Stripe payment method reference for processing the payment","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"paymentMode":{"type":"string","enum":["PAID","FREE_OF_CHARGE"],"writeOnly":true,"nullable":true,"description":"Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers from the dashboard."},"chargeStrategy":{"type":"string","enum":["CHARGE_CUSTOMER_FULL","CHARGE_CUSTOMER_PROCESSING","CHARGE_CLUB_PROCESSING"],"description":"Charge strategy for enhancement (admin only). Determines how costs are split between customer and club."},"billingUser":{"description":"User to bill for this enhancement (admin only). If not specified, the session user is charged.","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["paymentMode"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The WaitlistedUserDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"WaitlistedUserDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PASSIVE_ENROLLMENT","ACTIVE_ENROLLMENT"]},"enrollTime":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"userProfile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","enrollTime","errors","userProfile","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The WaitlistedUserCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"WaitlistedUserCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WaitlistedUserDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"WaitlistedUserDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PASSIVE_ENROLLMENT","ACTIVE_ENROLLMENT"]},"enrollTime":{"format":"date-time","type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"userProfile":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","enrollTime","errors","userProfile","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The CreateWaitlistedUserDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CreateWaitlistedUserDto":{"type":"object","properties":{"owner":{"writeOnly":true,"description":"The user to add to the waitlist. If not provided, uses the session user.","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"type":{"type":"string","enum":["PASSIVE_ENROLLMENT","ACTIVE_ENROLLMENT"],"writeOnly":true,"description":"The type of enrollment."}}},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The TerminalDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TerminalDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"displayName":{"type":"string"},"registrationCode":{"type":"string","writeOnly":true},"serialNumber":{"type":"string","writeOnly":true},"stripeReader":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"area":{"$ref":"#/components/schemas/ItemRefDto"},"_links":{"type":"object"}},"required":["id","createdDate","displayName","registrationCode","serialNumber","stripeReader","area","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The TerminalCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TerminalCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TerminalDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TerminalDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"displayName":{"type":"string"},"registrationCode":{"type":"string","writeOnly":true},"serialNumber":{"type":"string","writeOnly":true},"stripeReader":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"area":{"$ref":"#/components/schemas/ItemRefDto"},"_links":{"type":"object"}},"required":["id","createdDate","displayName","registrationCode","serialNumber","stripeReader","area","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The DiscourseConfigDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DiscourseConfigDto":{"type":"object","properties":{"discourseConnectSecret":{"type":"string","description":"Discourse Connect secret for SSO authentication"},"discourseApiKey":{"type":"string","description":"Discourse API key for managing chat users and channels"},"betaChatEnabled":{"type":"boolean","description":"Discourse Chat enabled for beta users"},"chatEnabled":{"type":"boolean","description":"Discourse Chat enabled"},"chatBaseUrl":{"type":"string","description":"Discourse base URL"},"_links":{"description":"A `LinksDto` structure containing URL references to properties that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["discourseConnectSecret","discourseApiKey","betaChatEnabled","chatEnabled","chatBaseUrl"]},"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"]}}}} ``` ## The DiscourseConfigPatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DiscourseConfigPatchDto":{"type":"object","properties":{"discourseConnectSecret":{"type":"string","description":"Discourse Connect secret for SSO authentication"},"discourseApiKey":{"type":"string","description":"Discourse API key for managing chat users and channels"},"betaChatEnabled":{"type":"boolean","description":"Discourse Chat enabled for beta users"},"chatEnabled":{"type":"boolean","description":"Discourse Chat enabled"},"chatBaseUrl":{"type":"string","description":"Discourse base URL"}}}}}} ``` ## The SignupPhoneVerificationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SignupPhoneVerificationDto":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format (e.g., +12025551234)"},"recaptchaToken":{"type":"string","description":"reCAPTCHA token from Firebase. Required when the tenant is configured to use Firebase phone verification."},"language":{"type":"string","description":"Preferred language for SMS message"},"verificationId":{"type":"string","description":"Firebase verification ID from the native mobile SDK. Used only for the verify step — mobile clients that use Firebase SDK directly provide this instead of a sessionId.","writeOnly":true},"sessionId":{"type":"string","description":"Session ID returned from the initial request. Required when submitting a verification code."},"verificationCode":{"type":"string","description":"6-digit verification code. When present, the endpoint verifies the code instead of sending a new one."}}}}}} ``` ## The SignupPhoneVerificationSessionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SignupPhoneVerificationSessionDto":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID for tracking verification","readOnly":true},"phonePreview":{"type":"string","description":"Phone number preview (last 4 digits)","readOnly":true},"status":{"type":"string","description":"Session status","enum":["pending","verified","consumed"],"readOnly":true},"expiresAt":{"format":"date-time","type":"string","description":"Session expiration timestamp","readOnly":true},"remainingAttempts":{"type":"number","description":"Remaining verification attempts","readOnly":true},"errors":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["sessionId","phonePreview","status","expiresAt","remainingAttempts"]},"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"]}}}} ``` ## The PatchablePackageDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PatchablePackageDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"expirationDate":{"format":"date-time","type":"string"},"items":{"$ref":"#/components/schemas/PackageItemCollectionDto"}},"required":["displayName","displayNamePlural","expirationDate","items"]},"PackageItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"},"remainingItems":{"type":"number","readOnly":true}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints","remainingItems"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]}}}} ``` ## The PatchablePackageItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PatchablePackageItemDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"}},"required":["displayName","displayNamePlural","totalItems"]}}}} ``` ## The PackageTemplateItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageTemplateItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]}}}} ``` ## The PackageTemplateItemCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageTemplateItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageTemplateItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageTemplateItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]}}}} ``` ## The PackageTemplateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageTemplateDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"durationDays":{"type":"number"},"items":{"$ref":"#/components/schemas/PackageTemplateItemCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","displayNamePlural","createdDate","items","errors","_links"]},"PackageTemplateItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageTemplateItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageTemplateItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]}}}} ``` ## The PackageTemplateCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageTemplateCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageTemplateDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageTemplateDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"durationDays":{"type":"number"},"items":{"$ref":"#/components/schemas/PackageTemplateItemCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","displayNamePlural","createdDate","items","errors","_links"]},"PackageTemplateItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageTemplateItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageTemplateItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]}}}} ``` ## The PackageTemplatePatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageTemplatePatchableDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"durationDays":{"type":"number"},"items":{"$ref":"#/components/schemas/PackageTemplateItemCollectionDto"}},"required":["id","displayName","displayNamePlural","items"]},"PackageTemplateItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageTemplateItemDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageTemplateItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["BOOKING","EVENT_SIGNUP","GUEST_SIGNUP","SERIES_SIGNUP","REPLAY"]},"displayName":{"type":"string"},"displayNamePlural":{"type":"string"},"totalItems":{"type":"number"},"constraints":{"$ref":"#/components/schemas/PackageItemConstraintsDto"}},"required":["id","type","displayName","displayNamePlural","totalItems","constraints"]},"PackageItemConstraintsDto":{"type":"object","properties":{"bookingEventSubtype":{"nullable":true,"type":"array","items":{"type":"OPERATIONS"}},"bookingEventCustomType":{"type":"string","nullable":true},"bookingEventCustomTypesMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAll":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingEventTagsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"allowKids":{"type":"boolean","nullable":true},"bookingSessionPeriodTypeMatchAny":{"description":"Session period types like PEAK, REDUCED, OFF PEAK, etc.","nullable":true,"type":"array","items":{"type":"PEAK"}},"bookingAreaSlugMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}},"bookingPodIdsMatchAny":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["bookingEventSubtype","bookingEventCustomType","bookingEventCustomTypesMatchAny","bookingEventTagsMatchAll","bookingEventTagsMatchAny","allowKids","bookingSessionPeriodTypeMatchAny","bookingAreaSlugMatchAny","bookingPodIdsMatchAny"]},"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"]}}}} ``` ## The PackageHistoryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageHistoryDto":{"type":"object","properties":{"type":{"type":"string","enum":["GRANT","USAGE","RETURN"]},"date":{"format":"date-time","type":"string"},"amount":{"type":"number"},"description":{"type":"string"},"package":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orderItem":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"packageType":{"type":"string","nullable":true},"expirationDate":{"format":"date-time","type":"string","nullable":true}},"required":["type","date","amount","description","package","order","orderItem","packageType","expirationDate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The PackageHistoryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PackageHistoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PackageHistoryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"PackageHistoryDto":{"type":"object","properties":{"type":{"type":"string","enum":["GRANT","USAGE","RETURN"]},"date":{"format":"date-time","type":"string"},"amount":{"type":"number"},"description":{"type":"string"},"package":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orderItem":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"packageType":{"type":"string","nullable":true},"expirationDate":{"format":"date-time","type":"string","nullable":true}},"required":["type","date","amount","description","package","order","orderItem","packageType","expirationDate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The RefundDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RefundDto":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"amount":{"type":"number"},"virtualCredits":{"type":"number"},"reason":{"type":"string","enum":["duplicate","fraudulent","requested_by_customer"],"nullable":true},"details":{"type":"string"},"status":{"type":"string","enum":["CONFIRMED","FAILED","INVALID"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"payment":{"$ref":"#/components/schemas/ItemRefDto"},"user":{"$ref":"#/components/schemas/ItemRefDto"}},"required":["id","createdAt","amount","virtualCredits","reason","details","status","errors","payment","user"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SeriesMembershipPriceOverrideItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SeriesMembershipPriceOverridesCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesMembershipPriceOverridesCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMembershipPriceOverrideItemDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SeriesPriceSettingsMembersDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesPriceSettingsMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0},"overrides":{"$ref":"#/components/schemas/SeriesMembershipPriceOverridesCollectionDto"}}},"SeriesMembershipPriceOverridesCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMembershipPriceOverrideItemDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SeriesPriceSettingsNonMembersDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesPriceSettingsNonMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0}}}}}} ``` ## The SeriesPriceSettingsItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesPriceSettingsItemDto":{"type":"object","properties":{"members":{"$ref":"#/components/schemas/SeriesPriceSettingsMembersDto"},"nonMembers":{"$ref":"#/components/schemas/SeriesPriceSettingsNonMembersDto"}}},"SeriesPriceSettingsMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0},"overrides":{"$ref":"#/components/schemas/SeriesMembershipPriceOverridesCollectionDto"}}},"SeriesMembershipPriceOverridesCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMembershipPriceOverrideItemDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"SeriesPriceSettingsNonMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0}}}}}} ``` ## The SeriesPriceSettingsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesPriceSettingsDto":{"type":"object","properties":{"full":{"$ref":"#/components/schemas/SeriesPriceSettingsItemDto"},"unit":{"$ref":"#/components/schemas/SeriesPriceSettingsItemDto"}}},"SeriesPriceSettingsItemDto":{"type":"object","properties":{"members":{"$ref":"#/components/schemas/SeriesPriceSettingsMembersDto"},"nonMembers":{"$ref":"#/components/schemas/SeriesPriceSettingsNonMembersDto"}}},"SeriesPriceSettingsMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0},"overrides":{"$ref":"#/components/schemas/SeriesMembershipPriceOverridesCollectionDto"}}},"SeriesMembershipPriceOverridesCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMembershipPriceOverrideItemDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"SeriesPriceSettingsNonMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0}}}}}} ``` ## The SeriesDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"bookedBy":{"type":"object","readOnly":true},"canceledAt":{"format":"date-time","type":"string","readOnly":true},"startTime":{"format":"date-time","type":"string","readOnly":true},"endTime":{"format":"date-time","type":"string","readOnly":true},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"overrideFields":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"description":{"type":"string"},"eventsTotal":{"type":"number","readOnly":true},"priceSettings":{"$ref":"#/components/schemas/SeriesPriceSettingsDto"},"admissionRate":{"type":"number","readOnly":true},"signupLimitDate":{"format":"date-time","type":"string"},"membersOnly":{"type":"boolean"},"events":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"signups":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"visibility":{"type":"string","enum":["LISTED","UNLISTED"]},"visibilitySchedules":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventVisibilityScheduleCollectionDto"}]},"type":{"type":"string","enum":["PREVIEW","ORDER"],"nullable":true},"status":{"type":"string","enum":["INVALID","CONFIRMED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","bookedBy","canceledAt","startTime","endTime","eventsTotal","priceSettings","admissionRate","events","signups","visibility","visibilitySchedules","type","status","errors"]},"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"]},"SeriesPriceSettingsDto":{"type":"object","properties":{"full":{"$ref":"#/components/schemas/SeriesPriceSettingsItemDto"},"unit":{"$ref":"#/components/schemas/SeriesPriceSettingsItemDto"}}},"SeriesPriceSettingsItemDto":{"type":"object","properties":{"members":{"$ref":"#/components/schemas/SeriesPriceSettingsMembersDto"},"nonMembers":{"$ref":"#/components/schemas/SeriesPriceSettingsNonMembersDto"}}},"SeriesPriceSettingsMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0},"overrides":{"$ref":"#/components/schemas/SeriesMembershipPriceOverridesCollectionDto"}}},"SeriesMembershipPriceOverridesCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMembershipPriceOverrideItemDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"SeriesPriceSettingsNonMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0}}},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"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"]},"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"]}}}} ``` ## The SeriesSettlementDetailCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesSettlementDetailCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The SeriesSettlementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesSettlementDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["PENDING","SETTLED","INVALID"]},"bookingTotal":{"type":"number","readOnly":true},"signupsTotal":{"type":"number","readOnly":true},"coachingTotal":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"currency":{"type":"string","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"details":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/SeriesSettlementDetailCollectionDto"}},"_links":{"type":"object"}},"required":["type","status","bookingTotal","signupsTotal","coachingTotal","total","currency","errors","details","_links"]},"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"]},"SeriesSettlementDetailCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The SeriesNoteDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesNoteDto":{"type":"object","properties":{"id":{"type":"string"},"comment":{"type":"string"}},"required":["id","comment"]}}}} ``` ## The SeriesNoteCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SeriesNoteCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The TournamentFormatsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TournamentFormatsResponseDto":{"type":"object","properties":{"provider":{"type":"string","enum":["SWISH","PODPLAY"]},"formats":{"description":"Available tournament formats for the provider","type":"array","items":{"type":"object"}}},"required":["provider","formats"]}}}} ``` ## The TournamentWebviewTokenDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TournamentWebviewTokenDto":{"type":"object","properties":{"token":{"type":"string","description":"JWT token for tournament webview access"},"expiresAtDate":{"type":"string","description":"Token expiration timestamp (ISO 8601)"}},"required":["token","expiresAtDate"]}}}} ``` ## The SwishConfigurationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SwishConfigurationDto":{"type":"object","properties":{"apiKey":{"type":"string","description":"Swish API key for tournament management (masked)"},"apiUrl":{"type":"string","description":"Swish API URL for tournament management"},"isEnabled":{"type":"boolean","description":"Whether Swish integration is enabled"}},"required":["apiKey","apiUrl","isEnabled"]}}}} ``` ## The SwishConfigurationPatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SwishConfigurationPatchDto":{"type":"object","properties":{"apiKey":{"type":"string","description":"Swish API key for tournament management (masked)"},"apiUrl":{"type":"string","description":"Swish API URL for tournament management"}}}}}} ``` ## The EventsRecurrenceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"EventsRecurrenceDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdDate":{"format":"date-time","type":"string","readOnly":true},"cadence":{"type":"string","enum":["day","week","month","year","custom"],"readOnly":true},"daysOfWeek":{"readOnly":true,"type":"array","items":{"type":"number"}},"until":{"format":"date-time","type":"string","readOnly":true},"events":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"_links":{"type":"object"}},"required":["id","user","createdDate","cadence","daysOfWeek","until","events","_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"]}}}} ``` ## The RecurrencePatchableEventDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RecurrencePatchableEventDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"guests":{"$ref":"#/components/schemas/GuestsDto"},"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"]},"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"]}},"status":{"type":"string","enum":["INVALID","DRAFT","CONFIRMED","PUBLISHED"]},"tournamentDivision":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TournamentDivisionDto"}]},"id":{"type":"string","writeOnly":true},"bulkUpdateType":{"type":"string","enum":["FROM_CURRENT_ON","ALL_ACTIVE_OCCURRENCES"],"writeOnly":true},"visibilitySchedules":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/EventVisibilityScheduleCollectionDto"}]},"notes":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/EventNoteCollectionDto"}]}},"required":["name","description","startTime","endTime","guests","totalTeams","teamSize","admission","admissionRating","admissionRate","admissionDate","admissionKids","allowedMemberships","coachRate","freeSignupCancellationHorizonHours","tags","visibility","features","status","tournamentDivision","id","bulkUpdateType","visibilitySchedules","notes"]},"GuestsDto":{"type":"object","properties":{"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number","nullable":true}},"required":["displayName","displayNameShort","max"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"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"]},"EventNoteCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventNoteDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventNoteDto":{"type":"object","properties":{"id":{"type":"string"},"comment":{"type":"string"}},"required":["id","comment"]}}}} ``` ## The ProductCategoryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0},"subcategories":{"oneOf":[{"$ref":"#/components/schemas/CollectionRefDto"},{"$ref":"#/components/schemas/ProductSubcategoryCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","errors","_links"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ProductSubcategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubcategoryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductSubcategoryDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"object","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"number","default":0},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","category","name","errors","_links"]},"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"]},"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"]}}}} ``` ## The PaginatedProductCategoryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaginatedProductCategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategoryDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"ProductCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0},"subcategories":{"oneOf":[{"$ref":"#/components/schemas/CollectionRefDto"},{"$ref":"#/components/schemas/ProductSubcategoryCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","errors","_links"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ProductSubcategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubcategoryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductSubcategoryDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"object","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"number","default":0},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","category","name","errors","_links"]},"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"]},"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"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The ProductCategoryPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductCategoryPatchableDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0}},"required":["id"]}}}} ``` ## The ProductCategoryCollectionPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductCategoryCollectionPatchableDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategoryPatchableDto"}}},"required":["items"]},"ProductCategoryPatchableDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0}},"required":["id"]}}}} ``` ## The ProductCategoryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductCategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategoryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0},"subcategories":{"oneOf":[{"$ref":"#/components/schemas/CollectionRefDto"},{"$ref":"#/components/schemas/ProductSubcategoryCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","errors","_links"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ProductSubcategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubcategoryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductSubcategoryDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"object","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"number","default":0},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","category","name","errors","_links"]},"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"]},"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"]}}}} ``` ## The TaxCategoryAssignmentDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TaxCategoryAssignmentDto":{"type":"object","properties":{"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"}},"required":["taxCategory"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ProductSubcategoryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductSubcategoryDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"object","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"number","default":0},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","category","name","errors","_links"]},"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"]}}}} ``` ## The PaginatedProductSubcategoryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaginatedProductSubcategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubcategoryDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"ProductSubcategoryDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"object","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"number","default":0},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","category","name","errors","_links"]},"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"]},"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"]}}}} ``` ## The ProductSubcategoryPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductSubcategoryPatchableDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0}},"required":["id"]}}}} ``` ## The ProductSubcategoryCollectionPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductSubcategoryCollectionPatchableDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubcategoryPatchableDto"}}},"required":["items"]},"ProductSubcategoryPatchableDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"priority":{"type":"number","default":0}},"required":["id"]}}}} ``` ## The ProductSubcategoryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductSubcategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubcategoryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductSubcategoryDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"object","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"priority":{"type":"number","default":0},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","category","name","errors","_links"]},"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"]},"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"]}}}} ``` ## The ProductDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"brandName":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"sku":{"type":"string"},"upc":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"price":{"type":"number"},"cost":{"type":"number"},"salesType":{"type":"string","enum":["PRODUCT","SERVICE"]},"category":{"$ref":"#/components/schemas/ItemRefDto"},"subcategory":{"$ref":"#/components/schemas/ItemRefDto"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"offerings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","sku","status","salesType","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"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"]}}}} ``` ## The PaginatedProductCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaginatedProductCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"ProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"brandName":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"sku":{"type":"string"},"upc":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"price":{"type":"number"},"cost":{"type":"number"},"salesType":{"type":"string","enum":["PRODUCT","SERVICE"]},"category":{"$ref":"#/components/schemas/ItemRefDto"},"subcategory":{"$ref":"#/components/schemas/ItemRefDto"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"offerings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","sku","status","salesType","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"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"]},"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"]}}}} ``` ## The ProductImportSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductImportSummaryDto":{"type":"object","properties":{"imported":{"type":"number"},"updated":{"type":"number"},"failed":{"type":"number"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["imported","updated","failed","errors"]},"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"]}}}} ``` ## The ProductOfferingSettingsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ProductOfferingDiscountDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]}}}} ``` ## The ProductOfferingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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"]}}}} ``` ## The PaginatedProductOfferingCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PaginatedProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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"]},"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"]}}}} ``` ## The ProductOfferingCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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"]},"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"]}}}} ``` ## The ProductOfferingCollectionPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingCollectionPatchableDto":{"type":"object","properties":{}}}}} ``` ## The ProductOfferingStockTransactionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingStockTransactionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"productOffering":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["IN","OUT"]},"quantity":{"type":"number"},"quantityAfter":{"type":"number","readOnly":true},"source":{"type":"string","enum":["INITIAL_STOCK","ORDER","MANUAL_ADJUSTMENT"],"readOnly":true},"reason":{"type":"string"},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","productOffering","order","createdAt","type","quantity","quantityAfter","source","reason","updatedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ProductOfferingStockTransactionsPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProductOfferingStockTransactionsPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingStockTransactionDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_total","_links"]},"ProductOfferingStockTransactionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"productOffering":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["IN","OUT"]},"quantity":{"type":"number"},"quantityAfter":{"type":"number","readOnly":true},"source":{"type":"string","enum":["INITIAL_STOCK","ORDER","MANUAL_ADJUSTMENT"],"readOnly":true},"reason":{"type":"string"},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","productOffering","order","createdAt","type","quantity","quantityAfter","source","reason","updatedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The TaxCategoryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The TaxCategoryCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TaxCategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TaxCategoryDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The AnalyticsUsersStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsUsersStatsDto":{"type":"object","properties":{"total":{"type":"number"},"new":{"type":"number"},"newPercent":{"type":"number"},"active":{"type":"number"},"totalMembers":{"type":"number"},"totalMemberships":{"type":"number"},"newMemberships":{"type":"number"},"newMembershipsPercent":{"type":"number"}},"required":["total","new","newPercent","active","totalMembers","totalMemberships","newMemberships","newMembershipsPercent"]}}}} ``` ## The AnalyticsUserMonthlyStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsUserMonthlyStatsDto":{"type":"object","properties":{"year":{"type":"number"},"month":{"type":"number"},"visits":{"type":"number"},"events":{"type":"number"},"bookings":{"type":"number"},"charged":{"type":"number"}},"required":["year","month","visits","events","bookings","charged"]}}}} ``` ## The AnalyticsUserMonthlyStatsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsUserMonthlyStatsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsUserMonthlyStatsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AnalyticsUserMonthlyStatsDto":{"type":"object","properties":{"year":{"type":"number"},"month":{"type":"number"},"visits":{"type":"number"},"events":{"type":"number"},"bookings":{"type":"number"},"charged":{"type":"number"}},"required":["year","month","visits","events","bookings","charged"]},"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"]}}}} ``` ## The AnalyticsPodUtilisationStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsPodUtilisationStatsDto":{"type":"object","properties":{"id":{"type":"string"},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"totalAvailableHs":{"type":"number"},"operationsHs":{"type":"number"},"regularHs":{"type":"number"},"openPlayHs":{"type":"number"},"leagueNightHs":{"type":"number"},"tournamentHs":{"type":"number"},"partyHs":{"type":"number"},"classesHs":{"type":"number"},"privateEventHs":{"type":"number"},"membersHs":{"type":"number"},"nonMembersHs":{"type":"number"}},"required":["id","pod","startTime","endTime","totalAvailableHs","operationsHs","regularHs","openPlayHs","leagueNightHs","tournamentHs","partyHs","classesHs","privateEventHs","membersHs","nonMembersHs"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The AnalyticsPodUtilisationStatsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsPodUtilisationStatsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsPodUtilisationStatsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AnalyticsPodUtilisationStatsDto":{"type":"object","properties":{"id":{"type":"string"},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"totalAvailableHs":{"type":"number"},"operationsHs":{"type":"number"},"regularHs":{"type":"number"},"openPlayHs":{"type":"number"},"leagueNightHs":{"type":"number"},"tournamentHs":{"type":"number"},"partyHs":{"type":"number"},"classesHs":{"type":"number"},"privateEventHs":{"type":"number"},"membersHs":{"type":"number"},"nonMembersHs":{"type":"number"}},"required":["id","pod","startTime","endTime","totalAvailableHs","operationsHs","regularHs","openPlayHs","leagueNightHs","tournamentHs","partyHs","classesHs","privateEventHs","membersHs","nonMembersHs"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The AnalyticsPodRevenueStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsPodRevenueStatsDto":{"type":"object","properties":{"id":{"type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"total":{"type":"number"},"reservations":{"type":"number"},"eventSignups":{"type":"number"},"memberships":{"type":"number"},"coaching":{"type":"number"},"replays":{"type":"number"},"campsAndClasses":{"type":"number"},"products":{"type":"number"}},"required":["id","area","pod","startTime","endTime","total","reservations","eventSignups","memberships","coaching","replays","campsAndClasses","products"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The AnalyticsPodRevenueStatsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"AnalyticsPodRevenueStatsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsPodRevenueStatsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AnalyticsPodRevenueStatsDto":{"type":"object","properties":{"id":{"type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"total":{"type":"number"},"reservations":{"type":"number"},"eventSignups":{"type":"number"},"memberships":{"type":"number"},"coaching":{"type":"number"},"replays":{"type":"number"},"campsAndClasses":{"type":"number"},"products":{"type":"number"}},"required":["id","area","pod","startTime","endTime","total","reservations","eventSignups","memberships","coaching","replays","campsAndClasses","products"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The OutboundWebhookEventDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OutboundWebhookEventDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"The event type identifier","readOnly":true},"displayName":{"type":"string","description":"The display name for the event type","readOnly":true}},"required":["id","type","displayName"]}}}} ``` ## The OutboundWebhookEventCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OutboundWebhookEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OutboundWebhookEventDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"OutboundWebhookEventDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"The event type identifier","readOnly":true},"displayName":{"type":"string","description":"The display name for the event type","readOnly":true}},"required":["id","type","displayName"]},"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"]}}}} ``` ## The OutboundWebhookDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"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"]},"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"]}}}} ``` ## The OutboundWebhookCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OutboundWebhookCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OutboundWebhookDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"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"]},"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"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The OutboundWebhookPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OutboundWebhookPatchableDto":{"type":"object","properties":{"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]}}}}}} ``` ## The ProximityLoginRequestDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProximityLoginRequestDto":{"type":"object","properties":{"provider":{"type":"string","description":"The proximity access provider to use for authentication.","enum":["KISI","OPEN_PATH","REMOTE_LOCK"]},"deviceBrand":{"type":"string","description":"Device brand (e.g., Apple, Samsung)"},"deviceModel":{"type":"string","description":"Device model (e.g., iPhone 15, Galaxy S24)"},"osName":{"type":"string","description":"Operating system name (e.g., iOS, Android)"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["provider","deviceBrand","deviceModel","osName","errors"]},"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"]}}}} ``` ## The ScramCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ScramCredentialsDto":{"type":"object","properties":{"phoneKey":{"type":"string","description":"Phone key for offline NFC authentication"},"onlineCertificate":{"type":"string","description":"Online certificate for authentication validation"}},"required":["phoneKey","onlineCertificate"]}}}} ``` ## The ProximityLoginResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProximityLoginResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"The login session ID from Kisi"},"secret":{"type":"string","description":"The authentication token used for this login"},"scramCredentials":{"description":"SCRAM credentials for offline NFC authentication","allOf":[{"$ref":"#/components/schemas/ScramCredentialsDto"}]}},"required":["id","secret","scramCredentials"]},"ScramCredentialsDto":{"type":"object","properties":{"phoneKey":{"type":"string","description":"Phone key for offline NFC authentication"},"onlineCertificate":{"type":"string","description":"Online certificate for authentication validation"}},"required":["phoneKey","onlineCertificate"]}}}} ``` ## The ProximitySyncUserJobDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProximitySyncUserJobDto":{"type":"object","properties":{"type":{"type":"string","description":"The job type","enum":["PREVIEW","ORDER"]},"email":{"type":"string","description":"User email to sync"}},"required":["type","email"]}}}} ``` ## The ProximitySyncOperationLineDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProximitySyncOperationLineDto":{"type":"object","properties":{"operation":{"type":"string","description":"Brief description of the operation"},"action":{"type":"string","description":"The operation action","enum":["add","remove"]},"area":{"description":"Reference to the area resource","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["operation","action","area"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ProximitySyncUserJobResultDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ProximitySyncUserJobResultDto":{"type":"object","properties":{"type":{"type":"string","description":"The job type"},"email":{"type":"string","description":"User email that was processed"},"totalOperations":{"type":"number","description":"Total number of operations that would be created"},"addOperations":{"type":"number","description":"Number of ADD operations"},"removeOperations":{"type":"number","description":"Number of REMOVE operations"},"operations":{"description":"Detailed list of operations","type":"array","items":{"$ref":"#/components/schemas/ProximitySyncOperationLineDto"}},"executionTimeMs":{"type":"number","description":"Job execution time in milliseconds"}},"required":["type","email","totalOperations","addOperations","removeOperations","operations","executionTimeMs"]},"ProximitySyncOperationLineDto":{"type":"object","properties":{"operation":{"type":"string","description":"Brief description of the operation"},"action":{"type":"string","description":"The operation action","enum":["add","remove"]},"area":{"description":"Reference to the area resource","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]}},"required":["operation","action","area"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The BookingAdmissionRateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingAdmissionRateDto":{"type":"object","properties":{"regular":{"type":"number","nullable":true},"member":{"type":"number","readOnly":true,"nullable":true},"membersDefault":{"type":"number","nullable":true},"memberships":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventAdmissionRateMembershipCollectionDto"}]},"chargingStrategy":{"type":"string","enum":["spot+","court+"]}},"required":["regular","member","membersDefault","memberships","chargingStrategy"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The BookingAdmissionDateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingAdmissionDateDto":{"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"}]}},"required":["regular","member","membersDefault","memberships"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The BookingAdmissionRatingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingAdmissionRatingDto":{"type":"object","properties":{"minRating":{"type":"number"},"maxRating":{"type":"number"},"type":{"type":"string"}},"required":["minRating","maxRating","type"]}}}} ``` ## The BookingItemReservationSessionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingItemReservationSessionDto":{"type":"object","properties":{"session":{"$ref":"#/components/schemas/ItemRefDto"},"sessionTable":{"$ref":"#/components/schemas/ItemRefDto"},"sessionCoach":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"sessionGuests":{"nullable":true,"description":"Represents the number of guests that will participate in the Reservation","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"type":"string"}}},"required":["session","sessionTable","sessionCoach","sessionGuests","errors"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The BookingSummaryItemReservationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingSummaryItemReservationDto":{"type":"object","properties":{"reservation":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ReservationDto"}]},"rate":{"type":"number","readOnly":true},"baseRate":{"type":"number","readOnly":true},"tableRate":{"type":"number","readOnly":true},"guestsRate":{"type":"number","readOnly":true},"coachRate":{"type":"number","readOnly":true},"admissionRate":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["reservation","rate","baseRate","tableRate","guestsRate","coachRate","admissionRate","errors"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"}}},"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"]}}}} ``` ## The BookingSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingSummaryDto":{"type":"object","properties":{"events":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"reservations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/BookingSummaryItemReservationDto"}},"currency":{"type":"string","readOnly":true},"series":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"couponDiscount":{"type":"number","readOnly":true},"coachingDiscount":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"maxChargableAmount":{"type":"number","readOnly":true},"dayPass":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PodPassRateDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when booking. Valid codes are: EBM053, EBM054, EBM055, EBM056","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["events","reservations","currency","series","subtotal","taxes","couponDiscount","coachingDiscount","virtualCredits","total","maxChargableAmount","passes","errors","messages"]},"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"]},"BookingSummaryItemReservationDto":{"type":"object","properties":{"reservation":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ReservationDto"}]},"rate":{"type":"number","readOnly":true},"baseRate":{"type":"number","readOnly":true},"tableRate":{"type":"number","readOnly":true},"guestsRate":{"type":"number","readOnly":true},"coachRate":{"type":"number","readOnly":true},"admissionRate":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["reservation","rate","baseRate","tableRate","guestsRate","coachRate","admissionRate","errors"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"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"]},"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"]},"PodPassRateDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"rate":{"type":"number"}},"required":["id","displayName","rate"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]}}}} ``` ## The BookingRecurrenceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingRecurrenceDto":{"type":"object","properties":{"id":{"type":"string","nullable":true},"cadence":{"type":"string","enum":["day","week","month","year","custom"]},"daysOfWeek":{"nullable":true,"type":"array","items":{"type":"number"}},"untilDate":{"type":"string","format":"date-time"}},"required":["id","cadence","daysOfWeek","untilDate"]}}}} ``` ## The BookingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","INVALID","PENDING","CONFIRMED","CANCELED","REQUIRES_AUTHENTICATION"],"readOnly":true},"eventSubtype":{"type":"string","enum":["OPERATIONS","KIDS_CLASS","ADULT_CLASS","OPEN_PLAY","LEAGUE_NIGHT","TOURNAMENT","PARTY","PRIVATE_EVENT"]},"eventCustomType":{"type":"string"},"eventStatus":{"type":"string","enum":["DRAFT","PUBLISHED"]},"eventName":{"type":"string"},"eventDescription":{"type":"string"},"eventFeatures":{"type":"array","nullable":true,"items":{"type":"string","enum":["WAITLIST","PUBLIC_ATTENDEE_LIST","QUICK_REPLAYS","CUSTOM_REPLAYS","ENHANCED_REPLAYS","SUBMIT_MATCHES_RESULTS","SHOW_SPOTS_LEFT"]}},"tournamentDivision":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TournamentDivisionDto"}]},"totalTeams":{"type":"number","nullable":true},"teamSize":{"type":"number","nullable":true},"maxGuests":{"type":"number","nullable":true},"admission":{"type":"string","enum":["OPEN","MEMBERS_ONLY","CLOSED"]},"admissionRate":{"$ref":"#/components/schemas/BookingAdmissionRateDto"},"admissionDate":{"$ref":"#/components/schemas/BookingAdmissionDateDto"},"admissionRating":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BookingAdmissionRatingDto"}]},"admissionKids":{"type":"string","enum":["OPEN","CLOSED"]},"allowedMemberships":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"coachRate":{"type":"number"},"freeSignupCancellationHorizonHours":{"type":"number"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"tags":{"type":"array","items":{"type":"string"}},"visibility":{"type":"string","enum":["LISTED","UNLISTED"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/BookingItemReservationSessionDto"}},"couponCode":{"type":"string","writeOnly":true,"nullable":true},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true},"bookingMode":{"type":"string","enum":["USER_BOOKED","FREE_OF_CHARGE"],"writeOnly":true,"nullable":true},"paymentMethod":{"type":"string","enum":["CARD","CASH"],"writeOnly":true,"nullable":true},"coupon":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/CouponSummaryDto"}]},"termsAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Terms\" along with the booking request."},"liabilityWaiverAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Liability waiver\" along with the booking request."},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/BookingSummaryDto"}]},"owner":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createAsSeries":{"type":"boolean","writeOnly":true},"seriesPriceSettings":{"writeOnly":true,"allOf":[{"$ref":"#/components/schemas/SeriesPriceSettingsDto"}]},"chargeStrategy":{"type":"string","enum":["BILL_SPLIT","ONLY_OWNER"],"nullable":true},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE"],"nullable":true},"recurrence":{"writeOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/BookingRecurrenceDto"}]},"_links":{"type":"object"}},"required":["id","type","status","eventSubtype","eventCustomType","eventStatus","eventName","eventDescription","eventFeatures","tournamentDivision","totalTeams","teamSize","maxGuests","admission","admissionKids","coachRate","freeSignupCancellationHorizonHours","tags","visibility","items","couponCode","virtualCredits","bookingMode","paymentMethod","coupon","termsAgreed","liabilityWaiverAgreed","order","summary","owner","createAsSeries","chargeStrategy","passesStrategy","recurrence","_links"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"BookingAdmissionRateDto":{"type":"object","properties":{"regular":{"type":"number","nullable":true},"member":{"type":"number","readOnly":true,"nullable":true},"membersDefault":{"type":"number","nullable":true},"memberships":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventAdmissionRateMembershipCollectionDto"}]},"chargingStrategy":{"type":"string","enum":["spot+","court+"]}},"required":["regular","member","membersDefault","memberships","chargingStrategy"]},"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"]},"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"]},"BookingAdmissionDateDto":{"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"}]}},"required":["regular","member","membersDefault","memberships"]},"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"]},"BookingAdmissionRatingDto":{"type":"object","properties":{"minRating":{"type":"number"},"maxRating":{"type":"number"},"type":{"type":"string"}},"required":["minRating","maxRating","type"]},"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"]},"BookingItemReservationSessionDto":{"type":"object","properties":{"session":{"$ref":"#/components/schemas/ItemRefDto"},"sessionTable":{"$ref":"#/components/schemas/ItemRefDto"},"sessionCoach":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"sessionGuests":{"nullable":true,"description":"Represents the number of guests that will participate in the Reservation","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"type":"string"}}},"required":["session","sessionTable","sessionCoach","sessionGuests","errors"]},"CouponSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","code","discountType","value","_links"]},"BookingSummaryDto":{"type":"object","properties":{"events":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"reservations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/BookingSummaryItemReservationDto"}},"currency":{"type":"string","readOnly":true},"series":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"couponDiscount":{"type":"number","readOnly":true},"coachingDiscount":{"type":"number","readOnly":true},"virtualCredits":{"type":"number","readOnly":true},"total":{"type":"number","readOnly":true},"maxChargableAmount":{"type":"number","readOnly":true},"dayPass":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/PodPassRateDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"messages":{"readOnly":true,"nullable":true,"description":"Possible messages that may be returned when booking. Valid codes are: EBM053, EBM054, EBM055, EBM056","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}}},"required":["events","reservations","currency","series","subtotal","taxes","couponDiscount","coachingDiscount","virtualCredits","total","maxChargableAmount","passes","errors","messages"]},"BookingSummaryItemReservationDto":{"type":"object","properties":{"reservation":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ReservationDto"}]},"rate":{"type":"number","readOnly":true},"baseRate":{"type":"number","readOnly":true},"tableRate":{"type":"number","readOnly":true},"guestsRate":{"type":"number","readOnly":true},"coachRate":{"type":"number","readOnly":true},"admissionRate":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["reservation","rate","baseRate","tableRate","guestsRate","coachRate","admissionRate","errors"]},"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"}}},"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"]},"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"]},"PodPassRateDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"rate":{"type":"number"}},"required":["id","displayName","rate"]},"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"]},"MessageDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true}},"required":["code","message"]},"SeriesPriceSettingsDto":{"type":"object","properties":{"full":{"$ref":"#/components/schemas/SeriesPriceSettingsItemDto"},"unit":{"$ref":"#/components/schemas/SeriesPriceSettingsItemDto"}}},"SeriesPriceSettingsItemDto":{"type":"object","properties":{"members":{"$ref":"#/components/schemas/SeriesPriceSettingsMembersDto"},"nonMembers":{"$ref":"#/components/schemas/SeriesPriceSettingsNonMembersDto"}}},"SeriesPriceSettingsMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0},"overrides":{"$ref":"#/components/schemas/SeriesMembershipPriceOverridesCollectionDto"}}},"SeriesMembershipPriceOverridesCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMembershipPriceOverrideItemDto"}},"_total":{"type":"number"}},"required":["items","_total"]},"SeriesMembershipPriceOverrideItemDto":{"type":"object","properties":{"membership":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number","minimum":0},"_links":{"type":"object"}},"required":["membership","rate","_links"]},"SeriesPriceSettingsNonMembersDto":{"type":"object","properties":{"rate":{"type":"number","minimum":0}}},"BookingRecurrenceDto":{"type":"object","properties":{"id":{"type":"string","nullable":true},"cadence":{"type":"string","enum":["day","week","month","year","custom"]},"daysOfWeek":{"nullable":true,"type":"array","items":{"type":"number"}},"untilDate":{"type":"string","format":"date-time"}},"required":["id","cadence","daysOfWeek","untilDate"]}}}} ``` ## The BookingCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"BookingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The RecurrentBookingDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RecurrentBookingDto":{"type":"object","properties":{"recurrence":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventsRecurrenceDto"}]},"bookings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/BookingCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["recurrence","bookings","errors"]},"EventsRecurrenceDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdDate":{"format":"date-time","type":"string","readOnly":true},"cadence":{"type":"string","enum":["day","week","month","year","custom"],"readOnly":true},"daysOfWeek":{"readOnly":true,"type":"array","items":{"type":"number"}},"until":{"format":"date-time","type":"string","readOnly":true},"events":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"_links":{"type":"object"}},"required":["id","user","createdDate","cadence","daysOfWeek","until","events","_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"]},"BookingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The RecurrentBookingTaskDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RecurrentBookingTaskDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"string","enum":["PENDING","PROCESSING","COMPLETED","FAILED"],"readOnly":true},"totalItems":{"type":"number","readOnly":true},"completedItems":{"type":"number","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"result":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/RecurrentBookingDto"}]},"error":{"type":"string","readOnly":true,"nullable":true},"_links":{"type":"object","readOnly":true}},"required":["id","status","totalItems","completedItems","createdDate","updatedDate","result","error","_links"]},"RecurrentBookingDto":{"type":"object","properties":{"recurrence":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventsRecurrenceDto"}]},"bookings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/BookingCollectionDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["recurrence","bookings","errors"]},"EventsRecurrenceDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdDate":{"format":"date-time","type":"string","readOnly":true},"cadence":{"type":"string","enum":["day","week","month","year","custom"],"readOnly":true},"daysOfWeek":{"readOnly":true,"type":"array","items":{"type":"number"}},"until":{"format":"date-time","type":"string","readOnly":true},"events":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"_links":{"type":"object"}},"required":["id","user","createdDate","cadence","daysOfWeek","until","events","_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"]},"BookingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"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"]}}}} ``` ## The SessionGuestsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionGuestsDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number"},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","displayName","displayNameShort","max","rate","lessonRate"]}}}} ``` ## The SessionGuestsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionGuestsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionGuestsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionGuestsDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number"},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","displayName","displayNameShort","max","rate","lessonRate"]},"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"]}}}} ``` ## The SessionTableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionTableDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["FIXED_TABLE","AUTO"]},"table":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","type","table","rate","lessonRate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SessionTableCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionTableCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionTableDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionTableDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["FIXED_TABLE","AUTO"]},"table":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","type","table","rate","lessonRate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The SessionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionDto":{"type":"object","properties":{"id":{"type":"string"},"pod":{"type":"object"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"periodType":{"type":"string","enum":["OFF_PEAK","REDUCED","PEAK"]},"tablesLeft":{"type":"number"},"status":{"type":"string","enum":["AVAILABLE","FULL","ALREADY_BOOKED","CONFLICTING_RESERVATION"]},"availableGuests":{"$ref":"#/components/schemas/SessionGuestsCollectionDto"},"availableTables":{"$ref":"#/components/schemas/SessionTableCollectionDto"},"availableCoaches":{"type":"object","nullable":true},"defaultTable":{"type":"object","readOnly":true,"nullable":true},"defaultCoach":{"type":"object","readOnly":true,"nullable":true},"defaultGuests":{"type":"object","readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","pod","startTime","endTime","periodType","tablesLeft","status","availableGuests","availableTables","availableCoaches","defaultTable","defaultCoach","defaultGuests","_links"]},"SessionGuestsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionGuestsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionGuestsDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number"},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","displayName","displayNameShort","max","rate","lessonRate"]},"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"]},"SessionTableCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionTableDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionTableDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["FIXED_TABLE","AUTO"]},"table":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","type","table","rate","lessonRate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SessionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionDto":{"type":"object","properties":{"id":{"type":"string"},"pod":{"type":"object"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"periodType":{"type":"string","enum":["OFF_PEAK","REDUCED","PEAK"]},"tablesLeft":{"type":"number"},"status":{"type":"string","enum":["AVAILABLE","FULL","ALREADY_BOOKED","CONFLICTING_RESERVATION"]},"availableGuests":{"$ref":"#/components/schemas/SessionGuestsCollectionDto"},"availableTables":{"$ref":"#/components/schemas/SessionTableCollectionDto"},"availableCoaches":{"type":"object","nullable":true},"defaultTable":{"type":"object","readOnly":true,"nullable":true},"defaultCoach":{"type":"object","readOnly":true,"nullable":true},"defaultGuests":{"type":"object","readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","pod","startTime","endTime","periodType","tablesLeft","status","availableGuests","availableTables","availableCoaches","defaultTable","defaultCoach","defaultGuests","_links"]},"SessionGuestsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionGuestsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionGuestsDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number"},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","displayName","displayNameShort","max","rate","lessonRate"]},"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"]},"SessionTableCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionTableDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionTableDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["FIXED_TABLE","AUTO"]},"table":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","type","table","rate","lessonRate"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The SessionCoachDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionCoachDto":{"type":"object","properties":{"id":{"type":"string"},"coach":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number"},"availableGuests":{"$ref":"#/components/schemas/SessionGuestsCollectionDto"}},"required":["id","coach","rate","availableGuests"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"SessionGuestsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionGuestsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionGuestsDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number"},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","displayName","displayNameShort","max","rate","lessonRate"]},"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"]}}}} ``` ## The SessionCoachCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SessionCoachCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionCoachDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionCoachDto":{"type":"object","properties":{"id":{"type":"string"},"coach":{"$ref":"#/components/schemas/ItemRefDto"},"rate":{"type":"number"},"availableGuests":{"$ref":"#/components/schemas/SessionGuestsCollectionDto"}},"required":["id","coach","rate","availableGuests"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"SessionGuestsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SessionGuestsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"SessionGuestsDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"max":{"type":"number"},"rate":{"type":"number"},"lessonRate":{"type":"number"}},"required":["id","displayName","displayNameShort","max","rate","lessonRate"]},"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"]}}}} ``` ## The CoachTransferDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"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"]}}}} ``` ## The CustomersExportUsersFiltersDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomersExportUsersFiltersDto":{"type":"object","properties":{"search":{"type":"string","description":"Free-text search (name, email, phone)"},"areas":{"description":"Areas to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"membershipAreas":{"description":"Membership areas to filter by (Members tab)","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"includePristine":{"type":"boolean","description":"Include pristine users when no explicit area selection"},"memberships":{"description":"Memberships to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"memberSinceMin":{"format":"date-time","type":"string","description":"Minimum membership enrollment date (inclusive)"},"memberSinceMax":{"format":"date-time","type":"string","description":"Maximum membership enrollment date (inclusive)"},"tenureMin":{"format":"date-time","type":"string","description":"Minimum account creation date (inclusive)"},"tenureMax":{"format":"date-time","type":"string","description":"Maximum account creation date (inclusive)"},"roles":{"description":"User roles to include","type":"array","items":{"type":"string"}},"conditions":{"type":"array","description":"Membership subscription conditions","items":{"type":"string","enum":["VALID","GRACE","HOLD"]}},"membershipStatuses":{"type":"array","description":"Extended membership statuses. Defaults to [\"ACTIVE\"] when exporting from the Members tab.","items":{"type":"string","enum":["ACTIVE","PENDING_CANCEL","CANCELLED","VALID","GRACE","HOLD"]}},"chargeTypes":{"type":"array","description":"Membership charge types","items":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"]}},"billingStatuses":{"type":"array","description":"High-level billing status (translated to subscription conditions server-side).","items":{"type":"string","enum":["ACTIVE","AT_RISK"]}},"sort":{"type":"string","description":"Sort string as used by Users listing (e.g., -fullName, memberSince, nextCharge)"}}},"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"]}}}} ``` ## The ReportDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReportDto":{"type":"object","properties":{"id":{"type":"string"},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string","description":"Required unless type=\"CUSTOMERS\"; for customers export see `usersFilters`."},"endDate":{"format":"date-time","type":"string","description":"Required unless type=\"CUSTOMERS\"; for customers export see `usersFilters`."},"areas":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"usersFilters":{"description":"For type=\"CUSTOMERS\" this is required and must mirror the Users listing filters (including `sort`).","allOf":[{"$ref":"#/components/schemas/CustomersExportUsersFiltersDto"}]},"type":{"type":"string","enum":["BALANCE_SUMMARY","BALANCE_ACTIVITY_SUMMARY","BALANCE_ACTIVITY_ITEMIZED","COACHING","CUSTOMERS","ORDERS","SETTLEMENTS"]},"status":{"type":"string","enum":["FAILED","CREATED","PENDING","SUCCEEDED","PROCESSING"],"readOnly":true},"url":{"type":"string","readOnly":true}},"required":["id","createdDate","areas","type","status","url"]},"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"]},"CustomersExportUsersFiltersDto":{"type":"object","properties":{"search":{"type":"string","description":"Free-text search (name, email, phone)"},"areas":{"description":"Areas to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"membershipAreas":{"description":"Membership areas to filter by (Members tab)","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"includePristine":{"type":"boolean","description":"Include pristine users when no explicit area selection"},"memberships":{"description":"Memberships to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"memberSinceMin":{"format":"date-time","type":"string","description":"Minimum membership enrollment date (inclusive)"},"memberSinceMax":{"format":"date-time","type":"string","description":"Maximum membership enrollment date (inclusive)"},"tenureMin":{"format":"date-time","type":"string","description":"Minimum account creation date (inclusive)"},"tenureMax":{"format":"date-time","type":"string","description":"Maximum account creation date (inclusive)"},"roles":{"description":"User roles to include","type":"array","items":{"type":"string"}},"conditions":{"type":"array","description":"Membership subscription conditions","items":{"type":"string","enum":["VALID","GRACE","HOLD"]}},"membershipStatuses":{"type":"array","description":"Extended membership statuses. Defaults to [\"ACTIVE\"] when exporting from the Members tab.","items":{"type":"string","enum":["ACTIVE","PENDING_CANCEL","CANCELLED","VALID","GRACE","HOLD"]}},"chargeTypes":{"type":"array","description":"Membership charge types","items":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"]}},"billingStatuses":{"type":"array","description":"High-level billing status (translated to subscription conditions server-side).","items":{"type":"string","enum":["ACTIVE","AT_RISK"]}},"sort":{"type":"string","description":"Sort string as used by Users listing (e.g., -fullName, memberSince, nextCharge)"}}}}}} ``` ## The SettlementFinancialsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SettlementFinancialsDto":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Payment method of the settlement"},"currency":{"type":"string","description":"Currency of the settlement"},"subtotal":{"type":"number","description":"Subtotal of the settlement"},"discounts":{"type":"number","description":"Discounts of the settlement"},"taxableAmount":{"type":"number","description":"Taxable amount of the settlement"},"taxes":{"description":"Taxes of the settlement","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"taxAmount":{"type":"number","description":"Tax amount of the settlement"},"grossAmount":{"type":"number","description":"Gross amount of the settlement"},"virtualCredits":{"type":"number","description":"Virtual credits of the settlement"},"paymentGatewayAmount":{"type":"number","description":"Payment gateway amount of the settlement"},"fees":{"type":"number","description":"Fees of the settlement"},"cashAmount":{"type":"number","description":"Cash amount of the settlement"},"feeItems":{"type":"number","description":"Fees of the settlement"},"feeItemsTotal":{"type":"number","description":"Total fees of the settlement"},"netAmount":{"type":"number","description":"Net amount of the settlement"},"netRevenue":{"type":"number","description":"Net revenue of the settlement"}},"required":["paymentMethod","currency","subtotal","discounts","taxableAmount","taxes","taxAmount","grossAmount","virtualCredits","paymentGatewayAmount","fees","cashAmount","feeItems","feeItemsTotal","netAmount","netRevenue"]},"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"]}}}} ``` ## The SettlementLineItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"unitDiscount":{"type":"number","description":"Unit discount of the item"},"proratedDiscount":{"type":"number","description":"Prorated discount of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"},"category":{"type":"string","description":"Category of the item"}},"required":["id","description","quantity","unitPrice","unitDiscount","proratedDiscount","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount","category"]},"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"]}}}} ``` ## The SettlementLineItemCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SettlementLineItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SettlementLineItemDto"}},"total":{"type":"number","description":"Total number of line items"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","total","_links"]},"SettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"unitDiscount":{"type":"number","description":"Unit discount of the item"},"proratedDiscount":{"type":"number","description":"Prorated discount of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"},"category":{"type":"string","description":"Category of the item"}},"required":["id","description","quantity","unitPrice","unitDiscount","proratedDiscount","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount","category"]},"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"]},"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"]}}}} ``` ## The SettlementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SettlementDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement"},"createdDate":{"format":"date-time","type":"string","description":"Date of creation"},"updatedDate":{"format":"date-time","type":"string","description":"Date of last update"},"payoutDate":{"format":"date-time","type":"string","description":"Date the settlement is scheduled to be paid out","nullable":true},"source":{"type":"string","description":"Source of the settlement"},"description":{"type":"string","description":"Description of the settlement"},"financials":{"description":"Financial details of the settlement","allOf":[{"$ref":"#/components/schemas/SettlementFinancialsDto"}]},"notes":{"type":"string","description":"Any notes or memos related to this settlement","nullable":true},"payment":{"description":"Reference to the payment that was used to create this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lineItems":{"description":"Line items included in this settlement","allOf":[{"$ref":"#/components/schemas/SettlementLineItemCollectionDto"}]},"user":{"description":"Reference to the user who initiated or is related to this settlement, if applicable","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orders":{"description":"Reference to the orders that were included in this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"event":{"description":"Reference to the event that was included in this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","createdDate","updatedDate","payoutDate","source","description","financials","notes","payment","lineItems","user","orders","event","_links"]},"SettlementFinancialsDto":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Payment method of the settlement"},"currency":{"type":"string","description":"Currency of the settlement"},"subtotal":{"type":"number","description":"Subtotal of the settlement"},"discounts":{"type":"number","description":"Discounts of the settlement"},"taxableAmount":{"type":"number","description":"Taxable amount of the settlement"},"taxes":{"description":"Taxes of the settlement","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"taxAmount":{"type":"number","description":"Tax amount of the settlement"},"grossAmount":{"type":"number","description":"Gross amount of the settlement"},"virtualCredits":{"type":"number","description":"Virtual credits of the settlement"},"paymentGatewayAmount":{"type":"number","description":"Payment gateway amount of the settlement"},"fees":{"type":"number","description":"Fees of the settlement"},"cashAmount":{"type":"number","description":"Cash amount of the settlement"},"feeItems":{"type":"number","description":"Fees of the settlement"},"feeItemsTotal":{"type":"number","description":"Total fees of the settlement"},"netAmount":{"type":"number","description":"Net amount of the settlement"},"netRevenue":{"type":"number","description":"Net revenue of the settlement"}},"required":["paymentMethod","currency","subtotal","discounts","taxableAmount","taxes","taxAmount","grossAmount","virtualCredits","paymentGatewayAmount","fees","cashAmount","feeItems","feeItemsTotal","netAmount","netRevenue"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"SettlementLineItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SettlementLineItemDto"}},"total":{"type":"number","description":"Total number of line items"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","total","_links"]},"SettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"unitDiscount":{"type":"number","description":"Unit discount of the item"},"proratedDiscount":{"type":"number","description":"Prorated discount of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"},"category":{"type":"string","description":"Category of the item"}},"required":["id","description","quantity","unitPrice","unitDiscount","proratedDiscount","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount","category"]},"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"}}}}}} ``` ## The SettlementCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SettlementCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SettlementDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"SettlementDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement"},"createdDate":{"format":"date-time","type":"string","description":"Date of creation"},"updatedDate":{"format":"date-time","type":"string","description":"Date of last update"},"payoutDate":{"format":"date-time","type":"string","description":"Date the settlement is scheduled to be paid out","nullable":true},"source":{"type":"string","description":"Source of the settlement"},"description":{"type":"string","description":"Description of the settlement"},"financials":{"description":"Financial details of the settlement","allOf":[{"$ref":"#/components/schemas/SettlementFinancialsDto"}]},"notes":{"type":"string","description":"Any notes or memos related to this settlement","nullable":true},"payment":{"description":"Reference to the payment that was used to create this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lineItems":{"description":"Line items included in this settlement","allOf":[{"$ref":"#/components/schemas/SettlementLineItemCollectionDto"}]},"user":{"description":"Reference to the user who initiated or is related to this settlement, if applicable","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orders":{"description":"Reference to the orders that were included in this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"event":{"description":"Reference to the event that was included in this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","createdDate","updatedDate","payoutDate","source","description","financials","notes","payment","lineItems","user","orders","event","_links"]},"SettlementFinancialsDto":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Payment method of the settlement"},"currency":{"type":"string","description":"Currency of the settlement"},"subtotal":{"type":"number","description":"Subtotal of the settlement"},"discounts":{"type":"number","description":"Discounts of the settlement"},"taxableAmount":{"type":"number","description":"Taxable amount of the settlement"},"taxes":{"description":"Taxes of the settlement","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"taxAmount":{"type":"number","description":"Tax amount of the settlement"},"grossAmount":{"type":"number","description":"Gross amount of the settlement"},"virtualCredits":{"type":"number","description":"Virtual credits of the settlement"},"paymentGatewayAmount":{"type":"number","description":"Payment gateway amount of the settlement"},"fees":{"type":"number","description":"Fees of the settlement"},"cashAmount":{"type":"number","description":"Cash amount of the settlement"},"feeItems":{"type":"number","description":"Fees of the settlement"},"feeItemsTotal":{"type":"number","description":"Total fees of the settlement"},"netAmount":{"type":"number","description":"Net amount of the settlement"},"netRevenue":{"type":"number","description":"Net revenue of the settlement"}},"required":["paymentMethod","currency","subtotal","discounts","taxableAmount","taxes","taxAmount","grossAmount","virtualCredits","paymentGatewayAmount","fees","cashAmount","feeItems","feeItemsTotal","netAmount","netRevenue"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"SettlementLineItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SettlementLineItemDto"}},"total":{"type":"number","description":"Total number of line items"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","total","_links"]},"SettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"unitDiscount":{"type":"number","description":"Unit discount of the item"},"proratedDiscount":{"type":"number","description":"Prorated discount of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"},"category":{"type":"string","description":"Category of the item"}},"required":["id","description","quantity","unitPrice","unitDiscount","proratedDiscount","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount","category"]},"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"]}}}} ``` ## The CustomerSettlementSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomerSettlementSummaryDto":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Payment method used for the settlement"},"paymentMethodBrand":{"type":"string","description":"Payment method brand (e.g., visa, mastercard)","nullable":true},"paymentMethodLast4":{"type":"string","description":"Last 4 digits of the payment method","nullable":true},"currency":{"type":"string","description":"Currency of the settlement"},"subtotal":{"type":"number","description":"Subtotal before discounts and taxes"},"discounts":{"type":"number","description":"Total discounts applied"},"taxableAmount":{"type":"number","description":"Amount subject to tax"},"taxes":{"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"taxAmount":{"type":"number","description":"Total tax amount"},"gross":{"type":"number","description":"Total amount charged"},"virtualCredits":{"type":"number","description":"Virtual credits applied to this transaction"}},"required":["paymentMethod","paymentMethodBrand","paymentMethodLast4","currency","subtotal","discounts","taxableAmount","taxes","taxAmount","gross","virtualCredits"]},"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"]}}}} ``` ## The CustomerSettlementLineItemDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomerSettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"}},"required":["id","description","quantity","unitPrice","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount"]},"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"]}}}} ``` ## The CustomerSettlementLineItemCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomerSettlementLineItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSettlementLineItemDto"}},"total":{"type":"number","description":"Total number of line items"}},"required":["items","total"]},"CustomerSettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"}},"required":["id","description","quantity","unitPrice","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount"]},"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"]}}}} ``` ## The CustomerSettlementDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomerSettlementDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement"},"code":{"type":"string","description":"Short code derived from the first 8 characters of the settlement id"},"createdDate":{"format":"date-time","type":"string","description":"Date the settlement was created"},"title":{"type":"string","description":"Human-friendly title for the settlement"},"source":{"type":"string","description":"Source type of the settlement (e.g., BOOKING, MEMBERSHIP, EVENT_SIGNUP)","nullable":true},"description":{"type":"string","description":"Description of the settlement","nullable":true},"summary":{"description":"Financial summary of the settlement","allOf":[{"$ref":"#/components/schemas/CustomerSettlementSummaryDto"}]},"payment":{"description":"Reference to the payment used for this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lineItems":{"description":"Line items included in this settlement","allOf":[{"$ref":"#/components/schemas/CustomerSettlementLineItemCollectionDto"}]},"event":{"description":"Reference to the event associated with this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orders":{"description":"Reference to the orders included in this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"_links":{"type":"object"}},"required":["id","code","createdDate","title","source","description","summary","payment","lineItems","event","orders","_links"]},"CustomerSettlementSummaryDto":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Payment method used for the settlement"},"paymentMethodBrand":{"type":"string","description":"Payment method brand (e.g., visa, mastercard)","nullable":true},"paymentMethodLast4":{"type":"string","description":"Last 4 digits of the payment method","nullable":true},"currency":{"type":"string","description":"Currency of the settlement"},"subtotal":{"type":"number","description":"Subtotal before discounts and taxes"},"discounts":{"type":"number","description":"Total discounts applied"},"taxableAmount":{"type":"number","description":"Amount subject to tax"},"taxes":{"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"taxAmount":{"type":"number","description":"Total tax amount"},"gross":{"type":"number","description":"Total amount charged"},"virtualCredits":{"type":"number","description":"Virtual credits applied to this transaction"}},"required":["paymentMethod","paymentMethodBrand","paymentMethodLast4","currency","subtotal","discounts","taxableAmount","taxes","taxAmount","gross","virtualCredits"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CustomerSettlementLineItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSettlementLineItemDto"}},"total":{"type":"number","description":"Total number of line items"}},"required":["items","total"]},"CustomerSettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"}},"required":["id","description","quantity","unitPrice","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}}}}} ``` ## The CustomerSettlementCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomerSettlementCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSettlementDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"CustomerSettlementDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement"},"code":{"type":"string","description":"Short code derived from the first 8 characters of the settlement id"},"createdDate":{"format":"date-time","type":"string","description":"Date the settlement was created"},"title":{"type":"string","description":"Human-friendly title for the settlement"},"source":{"type":"string","description":"Source type of the settlement (e.g., BOOKING, MEMBERSHIP, EVENT_SIGNUP)","nullable":true},"description":{"type":"string","description":"Description of the settlement","nullable":true},"summary":{"description":"Financial summary of the settlement","allOf":[{"$ref":"#/components/schemas/CustomerSettlementSummaryDto"}]},"payment":{"description":"Reference to the payment used for this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lineItems":{"description":"Line items included in this settlement","allOf":[{"$ref":"#/components/schemas/CustomerSettlementLineItemCollectionDto"}]},"event":{"description":"Reference to the event associated with this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"orders":{"description":"Reference to the orders included in this settlement","nullable":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"_links":{"type":"object"}},"required":["id","code","createdDate","title","source","description","summary","payment","lineItems","event","orders","_links"]},"CustomerSettlementSummaryDto":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Payment method used for the settlement"},"paymentMethodBrand":{"type":"string","description":"Payment method brand (e.g., visa, mastercard)","nullable":true},"paymentMethodLast4":{"type":"string","description":"Last 4 digits of the payment method","nullable":true},"currency":{"type":"string","description":"Currency of the settlement"},"subtotal":{"type":"number","description":"Subtotal before discounts and taxes"},"discounts":{"type":"number","description":"Total discounts applied"},"taxableAmount":{"type":"number","description":"Amount subject to tax"},"taxes":{"description":"Tax breakdown","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"taxAmount":{"type":"number","description":"Total tax amount"},"gross":{"type":"number","description":"Total amount charged"},"virtualCredits":{"type":"number","description":"Virtual credits applied to this transaction"}},"required":["paymentMethod","paymentMethodBrand","paymentMethodLast4","currency","subtotal","discounts","taxableAmount","taxes","taxAmount","gross","virtualCredits"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CustomerSettlementLineItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSettlementLineItemDto"}},"total":{"type":"number","description":"Total number of line items"}},"required":["items","total"]},"CustomerSettlementLineItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the settlement line item"},"description":{"type":"string","description":"Description of the line item"},"quantity":{"type":"number","description":"Quantity of the item"},"unitPrice":{"type":"number","description":"Unit price of the item"},"subtotal":{"type":"number","description":"Subtotal of the item"},"totalDiscount":{"type":"number","description":"Total discount of the item"},"taxableAmount":{"type":"number","description":"Taxable amount of the item"},"taxAmount":{"type":"number","description":"Tax amount of the item"},"taxes":{"description":"Taxes of the item","type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"grossAmount":{"type":"number","description":"Gross amount of the item"}},"required":["id","description","quantity","unitPrice","subtotal","totalDiscount","taxableAmount","taxAmount","taxes","grossAmount"]},"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"]}}}} ``` ## The PayoutStatusDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutStatusDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true}},"required":["id","value","displayName"]}}}} ``` ## The PayoutDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"stripePayout":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"stripeAccount":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"amount":{"type":"number","readOnly":true,"description":"Payout amount in dollars"},"currency":{"type":"string","readOnly":true,"description":"Three letter currency code (e.g., USD)"},"arrivalDate":{"format":"date-time","type":"string","readOnly":true,"description":"Expected arrival date of the payout"},"status":{"readOnly":true,"description":"Current status of the payout","allOf":[{"$ref":"#/components/schemas/PayoutStatusDto"}]},"method":{"type":"string","readOnly":true,"description":"Payout method (e.g., standard, instant)"},"balanceTransaction":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"reconciliationStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"],"nullable":true,"description":"Reconciliation status of this payout"},"reconciledAt":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"reconciliation":{"oneOf":[{"$ref":"#/components/schemas/ItemRefDto"},{"$ref":"#/components/schemas/PayoutReconciliationSummaryDto"}],"readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","stripePayout","stripeAccount","amount","currency","arrivalDate","status","method","balanceTransaction","createdAt","updatedAt","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"PayoutStatusDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true}},"required":["id","value","displayName"]},"PayoutReconciliationSummaryDto":{"type":"object","properties":{"status":{"type":"string","description":"Reconciliation status","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"]},"reconciledAt":{"format":"date-time","type":"string","nullable":true,"description":"When the payout was last reconciled"},"issuesSummary":{"description":"Summary of reconciliation issues (if any)","allOf":[{"$ref":"#/components/schemas/ReconciliationIssuesSummaryDto"}]},"unmatchedTransactions":{"description":"Balance transactions that could not be matched to settlements (from last reconciliation run)","type":"array","items":{"$ref":"#/components/schemas/UnmatchedTransactionDto"}}},"required":["status","reconciledAt","issuesSummary"]},"ReconciliationIssuesSummaryDto":{"type":"object","properties":{"unmatchedCount":{"type":"number","description":"Number of unmatched balance transactions"},"netMismatchCount":{"type":"number","description":"Number of net mismatches detected"},"totalNetDifference":{"type":"number","description":"Total net difference across mismatches (in dollars)"},"totalNetReconciled":{"type":"number","description":"Total net reconciled across all processed transactions (in dollars)"},"errorsCount":{"type":"number","description":"Number of processing errors"},"severity":{"type":"string","enum":["low","medium","high","critical"]}},"required":["unmatchedCount","netMismatchCount","totalNetDifference","errorsCount","severity"]},"UnmatchedTransactionDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier for the Stripe balance transaction"},"type":{"type":"string","description":"Type of the balance transaction","enum":["payment","transfer","payment_refund"]},"amount":{"type":"number","description":"Transaction amount in cents"},"currency":{"type":"string","description":"Three-letter ISO currency code"},"created":{"format":"date-time","type":"string","description":"Date when the transaction was created"},"description":{"type":"string","description":"Optional description of the transaction"},"sourceId":{"type":"string","description":"Optional source ID (charge, refund, etc.) that created this transaction"},"reason":{"type":"string","description":"Reason why this transaction could not be matched to a settlement"}},"required":["transactionId","type","amount","currency","created","reason"]}}}} ``` ## The PayoutCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PayoutDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"PayoutDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"stripePayout":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"stripeAccount":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"amount":{"type":"number","readOnly":true,"description":"Payout amount in dollars"},"currency":{"type":"string","readOnly":true,"description":"Three letter currency code (e.g., USD)"},"arrivalDate":{"format":"date-time","type":"string","readOnly":true,"description":"Expected arrival date of the payout"},"status":{"readOnly":true,"description":"Current status of the payout","allOf":[{"$ref":"#/components/schemas/PayoutStatusDto"}]},"method":{"type":"string","readOnly":true,"description":"Payout method (e.g., standard, instant)"},"balanceTransaction":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"reconciliationStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"],"nullable":true,"description":"Reconciliation status of this payout"},"reconciledAt":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"reconciliation":{"oneOf":[{"$ref":"#/components/schemas/ItemRefDto"},{"$ref":"#/components/schemas/PayoutReconciliationSummaryDto"}],"readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","stripePayout","stripeAccount","amount","currency","arrivalDate","status","method","balanceTransaction","createdAt","updatedAt","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"PayoutStatusDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true}},"required":["id","value","displayName"]},"PayoutReconciliationSummaryDto":{"type":"object","properties":{"status":{"type":"string","description":"Reconciliation status","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"]},"reconciledAt":{"format":"date-time","type":"string","nullable":true,"description":"When the payout was last reconciled"},"issuesSummary":{"description":"Summary of reconciliation issues (if any)","allOf":[{"$ref":"#/components/schemas/ReconciliationIssuesSummaryDto"}]},"unmatchedTransactions":{"description":"Balance transactions that could not be matched to settlements (from last reconciliation run)","type":"array","items":{"$ref":"#/components/schemas/UnmatchedTransactionDto"}}},"required":["status","reconciledAt","issuesSummary"]},"ReconciliationIssuesSummaryDto":{"type":"object","properties":{"unmatchedCount":{"type":"number","description":"Number of unmatched balance transactions"},"netMismatchCount":{"type":"number","description":"Number of net mismatches detected"},"totalNetDifference":{"type":"number","description":"Total net difference across mismatches (in dollars)"},"totalNetReconciled":{"type":"number","description":"Total net reconciled across all processed transactions (in dollars)"},"errorsCount":{"type":"number","description":"Number of processing errors"},"severity":{"type":"string","enum":["low","medium","high","critical"]}},"required":["unmatchedCount","netMismatchCount","totalNetDifference","errorsCount","severity"]},"UnmatchedTransactionDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier for the Stripe balance transaction"},"type":{"type":"string","description":"Type of the balance transaction","enum":["payment","transfer","payment_refund"]},"amount":{"type":"number","description":"Transaction amount in cents"},"currency":{"type":"string","description":"Three-letter ISO currency code"},"created":{"format":"date-time","type":"string","description":"Date when the transaction was created"},"description":{"type":"string","description":"Optional description of the transaction"},"sourceId":{"type":"string","description":"Optional source ID (charge, refund, etc.) that created this transaction"},"reason":{"type":"string","description":"Reason why this transaction could not be matched to a settlement"}},"required":["transactionId","type","amount","currency","created","reason"]},"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"]}}}} ``` ## The ReconciliationIssuesSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReconciliationIssuesSummaryDto":{"type":"object","properties":{"unmatchedCount":{"type":"number","description":"Number of unmatched balance transactions"},"netMismatchCount":{"type":"number","description":"Number of net mismatches detected"},"totalNetDifference":{"type":"number","description":"Total net difference across mismatches (in dollars)"},"totalNetReconciled":{"type":"number","description":"Total net reconciled across all processed transactions (in dollars)"},"errorsCount":{"type":"number","description":"Number of processing errors"},"severity":{"type":"string","enum":["low","medium","high","critical"]}},"required":["unmatchedCount","netMismatchCount","totalNetDifference","errorsCount","severity"]}}}} ``` ## The UnmatchedTransactionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UnmatchedTransactionDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier for the Stripe balance transaction"},"type":{"type":"string","description":"Type of the balance transaction","enum":["payment","transfer","payment_refund"]},"amount":{"type":"number","description":"Transaction amount in cents"},"currency":{"type":"string","description":"Three-letter ISO currency code"},"created":{"format":"date-time","type":"string","description":"Date when the transaction was created"},"description":{"type":"string","description":"Optional description of the transaction"},"sourceId":{"type":"string","description":"Optional source ID (charge, refund, etc.) that created this transaction"},"reason":{"type":"string","description":"Reason why this transaction could not be matched to a settlement"}},"required":["transactionId","type","amount","currency","created","reason"]}}}} ``` ## The PayoutReconciliationSummaryDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutReconciliationSummaryDto":{"type":"object","properties":{"status":{"type":"string","description":"Reconciliation status","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"]},"reconciledAt":{"format":"date-time","type":"string","nullable":true,"description":"When the payout was last reconciled"},"issuesSummary":{"description":"Summary of reconciliation issues (if any)","allOf":[{"$ref":"#/components/schemas/ReconciliationIssuesSummaryDto"}]},"unmatchedTransactions":{"description":"Balance transactions that could not be matched to settlements (from last reconciliation run)","type":"array","items":{"$ref":"#/components/schemas/UnmatchedTransactionDto"}}},"required":["status","reconciledAt","issuesSummary"]},"ReconciliationIssuesSummaryDto":{"type":"object","properties":{"unmatchedCount":{"type":"number","description":"Number of unmatched balance transactions"},"netMismatchCount":{"type":"number","description":"Number of net mismatches detected"},"totalNetDifference":{"type":"number","description":"Total net difference across mismatches (in dollars)"},"totalNetReconciled":{"type":"number","description":"Total net reconciled across all processed transactions (in dollars)"},"errorsCount":{"type":"number","description":"Number of processing errors"},"severity":{"type":"string","enum":["low","medium","high","critical"]}},"required":["unmatchedCount","netMismatchCount","totalNetDifference","errorsCount","severity"]},"UnmatchedTransactionDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier for the Stripe balance transaction"},"type":{"type":"string","description":"Type of the balance transaction","enum":["payment","transfer","payment_refund"]},"amount":{"type":"number","description":"Transaction amount in cents"},"currency":{"type":"string","description":"Three-letter ISO currency code"},"created":{"format":"date-time","type":"string","description":"Date when the transaction was created"},"description":{"type":"string","description":"Optional description of the transaction"},"sourceId":{"type":"string","description":"Optional source ID (charge, refund, etc.) that created this transaction"},"reason":{"type":"string","description":"Reason why this transaction could not be matched to a settlement"}},"required":["transactionId","type","amount","currency","created","reason"]}}}} ``` ## The PayoutSyncErrorDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutSyncErrorDto":{"type":"object","properties":{"payout":{"description":"The Stripe payout ID that failed to sync","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"error":{"type":"string","description":"The error message"}},"required":["payout","error"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The PayoutSyncResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutSyncResponseDto":{"type":"object","properties":{"synced":{"type":"number","description":"Number of payouts successfully synced"},"failed":{"type":"number","description":"Number of payouts that failed to sync"},"errors":{"description":"List of errors","type":"array","items":{"$ref":"#/components/schemas/PayoutSyncErrorDto"}},"hasMore":{"type":"boolean","description":"Whether there are more payouts to sync"}},"required":["synced","failed","errors","hasMore"]},"PayoutSyncErrorDto":{"type":"object","properties":{"payout":{"description":"The Stripe payout ID that failed to sync","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"error":{"type":"string","description":"The error message"}},"required":["payout","error"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ReconciliationErrorDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReconciliationErrorDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Transaction ID that caused the error"},"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["transactionId","error"]}}}} ``` ## The ReconciliationStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReconciliationStatsDto":{"type":"object","properties":{"totalTransactions":{"type":"number","description":"Total number of transactions processed during reconciliation","minimum":0},"chargesProcessed":{"type":"number","description":"Number of charge transactions successfully processed","minimum":0},"refundsProcessed":{"type":"number","description":"Number of refund transactions successfully processed","minimum":0},"transfersProcessed":{"type":"number","description":"Number of transfer transactions successfully processed","minimum":0},"settlementsUpdated":{"type":"number","description":"Number of settlement records that were updated","minimum":0},"errors":{"description":"List of transactions that encountered errors during processing","type":"array","items":{"$ref":"#/components/schemas/ReconciliationErrorDto"}},"unmatchedTransactions":{"description":"Balance transactions that could not be matched to settlements","type":"array","items":{"$ref":"#/components/schemas/UnmatchedTransactionDto"}},"totalGross":{"type":"number","description":"Total gross amount reconciled in cents"},"totalNet":{"type":"number","description":"Total net amount reconciled in cents (after fees)"}},"required":["totalTransactions","chargesProcessed","refundsProcessed","transfersProcessed","settlementsUpdated","errors","unmatchedTransactions","totalGross","totalNet"]},"ReconciliationErrorDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Transaction ID that caused the error"},"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["transactionId","error"]},"UnmatchedTransactionDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier for the Stripe balance transaction"},"type":{"type":"string","description":"Type of the balance transaction","enum":["payment","transfer","payment_refund"]},"amount":{"type":"number","description":"Transaction amount in cents"},"currency":{"type":"string","description":"Three-letter ISO currency code"},"created":{"format":"date-time","type":"string","description":"Date when the transaction was created"},"description":{"type":"string","description":"Optional description of the transaction"},"sourceId":{"type":"string","description":"Optional source ID (charge, refund, etc.) that created this transaction"},"reason":{"type":"string","description":"Reason why this transaction could not be matched to a settlement"}},"required":["transactionId","type","amount","currency","created","reason"]}}}} ``` ## The PayoutReconciliationDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PayoutReconciliationDto":{"type":"object","properties":{"payout":{"description":"The payout that was reconciled with Stripe balance transactions","allOf":[{"$ref":"#/components/schemas/PayoutDto"}]},"reconciliationStats":{"description":"Detailed statistics and results from the reconciliation process","allOf":[{"$ref":"#/components/schemas/ReconciliationStatsDto"}]}},"required":["payout","reconciliationStats"]},"PayoutDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"stripePayout":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"stripeAccount":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"amount":{"type":"number","readOnly":true,"description":"Payout amount in dollars"},"currency":{"type":"string","readOnly":true,"description":"Three letter currency code (e.g., USD)"},"arrivalDate":{"format":"date-time","type":"string","readOnly":true,"description":"Expected arrival date of the payout"},"status":{"readOnly":true,"description":"Current status of the payout","allOf":[{"$ref":"#/components/schemas/PayoutStatusDto"}]},"method":{"type":"string","readOnly":true,"description":"Payout method (e.g., standard, instant)"},"balanceTransaction":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"reconciliationStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"],"nullable":true,"description":"Reconciliation status of this payout"},"reconciledAt":{"format":"date-time","type":"string","readOnly":true,"nullable":true},"reconciliation":{"oneOf":[{"$ref":"#/components/schemas/ItemRefDto"},{"$ref":"#/components/schemas/PayoutReconciliationSummaryDto"}],"readOnly":true,"nullable":true},"_links":{"type":"object"}},"required":["id","stripePayout","stripeAccount","amount","currency","arrivalDate","status","method","balanceTransaction","createdAt","updatedAt","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"PayoutStatusDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true}},"required":["id","value","displayName"]},"PayoutReconciliationSummaryDto":{"type":"object","properties":{"status":{"type":"string","description":"Reconciliation status","enum":["PENDING","IN_PROGRESS","SUCCESS","SUCCESS_WITH_ISSUES","FAILED","PARTIAL"]},"reconciledAt":{"format":"date-time","type":"string","nullable":true,"description":"When the payout was last reconciled"},"issuesSummary":{"description":"Summary of reconciliation issues (if any)","allOf":[{"$ref":"#/components/schemas/ReconciliationIssuesSummaryDto"}]},"unmatchedTransactions":{"description":"Balance transactions that could not be matched to settlements (from last reconciliation run)","type":"array","items":{"$ref":"#/components/schemas/UnmatchedTransactionDto"}}},"required":["status","reconciledAt","issuesSummary"]},"ReconciliationIssuesSummaryDto":{"type":"object","properties":{"unmatchedCount":{"type":"number","description":"Number of unmatched balance transactions"},"netMismatchCount":{"type":"number","description":"Number of net mismatches detected"},"totalNetDifference":{"type":"number","description":"Total net difference across mismatches (in dollars)"},"totalNetReconciled":{"type":"number","description":"Total net reconciled across all processed transactions (in dollars)"},"errorsCount":{"type":"number","description":"Number of processing errors"},"severity":{"type":"string","enum":["low","medium","high","critical"]}},"required":["unmatchedCount","netMismatchCount","totalNetDifference","errorsCount","severity"]},"UnmatchedTransactionDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier for the Stripe balance transaction"},"type":{"type":"string","description":"Type of the balance transaction","enum":["payment","transfer","payment_refund"]},"amount":{"type":"number","description":"Transaction amount in cents"},"currency":{"type":"string","description":"Three-letter ISO currency code"},"created":{"format":"date-time","type":"string","description":"Date when the transaction was created"},"description":{"type":"string","description":"Optional description of the transaction"},"sourceId":{"type":"string","description":"Optional source ID (charge, refund, etc.) that created this transaction"},"reason":{"type":"string","description":"Reason why this transaction could not be matched to a settlement"}},"required":["transactionId","type","amount","currency","created","reason"]},"ReconciliationStatsDto":{"type":"object","properties":{"totalTransactions":{"type":"number","description":"Total number of transactions processed during reconciliation","minimum":0},"chargesProcessed":{"type":"number","description":"Number of charge transactions successfully processed","minimum":0},"refundsProcessed":{"type":"number","description":"Number of refund transactions successfully processed","minimum":0},"transfersProcessed":{"type":"number","description":"Number of transfer transactions successfully processed","minimum":0},"settlementsUpdated":{"type":"number","description":"Number of settlement records that were updated","minimum":0},"errors":{"description":"List of transactions that encountered errors during processing","type":"array","items":{"$ref":"#/components/schemas/ReconciliationErrorDto"}},"unmatchedTransactions":{"description":"Balance transactions that could not be matched to settlements","type":"array","items":{"$ref":"#/components/schemas/UnmatchedTransactionDto"}},"totalGross":{"type":"number","description":"Total gross amount reconciled in cents"},"totalNet":{"type":"number","description":"Total net amount reconciled in cents (after fees)"}},"required":["totalTransactions","chargesProcessed","refundsProcessed","transfersProcessed","settlementsUpdated","errors","unmatchedTransactions","totalGross","totalNet"]},"ReconciliationErrorDto":{"type":"object","properties":{"transactionId":{"type":"string","description":"Transaction ID that caused the error"},"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["transactionId","error"]}}}} ``` ## The CustomEmailConfigDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomEmailConfigDto":{"type":"object","properties":{"appBaseUrl":{"type":"string","nullable":true,"description":"Base URL for building CTA links in custom email templates"},"_links":{"description":"A `LinksDto` structure containing URL references to properties that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["appBaseUrl"]},"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"]}}}} ``` ## The CustomEmailContextDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomEmailContextDto":{"type":"object","properties":{"type":{"type":"string","enum":["EVENT","MEMBERSHIP","GENERAL"],"description":"Type of custom email context for validation"},"resourceId":{"type":"string","description":"Resource ID (event ID, membership ID) - required for EVENT and MEMBERSHIP types"}},"required":["type"]}}}} ``` ## The CustomEmailDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"CustomEmailDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource","readOnly":true},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"subject":{"type":"string","maxLength":100},"bodyHtml":{"type":"string","description":"Complete WYSIWYG HTML body"},"recipients":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"context":{"$ref":"#/components/schemas/CustomEmailContextDto"},"bccClubEmail":{"type":"boolean","description":"Whether to BCC the company email address","default":true},"recipientSource":{"type":"string","enum":["INVITATION","WAITLIST"],"description":"Recipient source for EVENT emails (invitations or waitlist entries)","default":"INVITATION"},"sentCount":{"type":"number","readOnly":true},"skippedCount":{"type":"number","readOnly":true},"clubEmailSent":{"type":"boolean","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"status":{"type":"string","enum":["PENDING","SENDING","SENT","FAILED"],"readOnly":true}},"required":["id","subject","bodyHtml","recipients","sentCount","skippedCount","clubEmailSent","createdDate","status"]},"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"]},"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"]},"CustomEmailContextDto":{"type":"object","properties":{"type":{"type":"string","enum":["EVENT","MEMBERSHIP","GENERAL"],"description":"Type of custom email context for validation"},"resourceId":{"type":"string","description":"Resource ID (event ID, membership ID) - required for EVENT and MEMBERSHIP types"}},"required":["type"]}}}} ``` ## The OAuth2AccessTokenRequestPasswordDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestPasswordDto":{"type":"object","properties":{"grant_type":{"type":"string","enum":["password"],"writeOnly":true},"username":{"type":"string","writeOnly":true},"password":{"type":"string","writeOnly":true},"scope":{"type":"string","writeOnly":true}},"required":["grant_type","username","password"]}}}} ``` ## The OAuth2AccessTokenRequestRefreshTokenDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestRefreshTokenDto":{"type":"object","properties":{"grant_type":{"type":"string","enum":["refresh_token"],"writeOnly":true},"refresh_token":{"type":"string","writeOnly":true}},"required":["grant_type","refresh_token"]}}}} ``` ## The OAuth2AccessTokenRequestAuthorizationCodeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestAuthorizationCodeDto":{"type":"object","properties":{"grant_type":{"type":"string","enum":["authorization_code"],"writeOnly":true},"code":{"type":"string","writeOnly":true},"redirect_uri":{"type":"string","writeOnly":true},"client_id":{"type":"string","writeOnly":true},"client_secret":{"type":"string","writeOnly":true}},"required":["grant_type","code","client_id","client_secret"]}}}} ``` ## The OAuth2AccessTokenRequestMagicLinkDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestMagicLinkDto":{"type":"object","properties":{"username":{"type":"string","writeOnly":true},"redirect_uri":{"type":"string","writeOnly":true},"grant_type":{"type":"string","enum":["passwordless_auth"],"writeOnly":true}},"required":["username","grant_type"]}}}} ``` ## The OAuth2AccessTokenRequestOtpDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestOtpDto":{"type":"object","properties":{"username":{"type":"string","writeOnly":true},"code":{"type":"string","writeOnly":true},"grant_type":{"type":"string","enum":["otp_auth"],"writeOnly":true}},"required":["username","code","grant_type"]}}}} ``` ## The OAuth2AccessTokenRequestSignUpDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestSignUpDto":{"type":"object","properties":{"username":{"type":"string","writeOnly":true},"code":{"type":"string","writeOnly":true},"podify_first_name":{"type":"string","writeOnly":true},"podify_last_name":{"type":"string","writeOnly":true},"podify_gender":{"type":"string"},"podify_birthday":{"format":"date-time","type":"string"},"podify_agree_to_tos":{"type":"boolean","writeOnly":true},"podify_email_marketing_opt_in":{"type":"boolean","writeOnly":true},"podify_sms_marketing_opt_in":{"type":"boolean","writeOnly":true},"podify_accepted_agreements":{"writeOnly":true,"type":"array","items":{"type":"string"}},"phone_verification_session_id":{"type":"string","writeOnly":true,"description":"Phone verification session ID from pre-auth phone verification"},"grant_type":{"type":"string","enum":["passwordless_sign_up","otp_sign_up"],"writeOnly":true}},"required":["username","code","podify_first_name","podify_last_name","podify_agree_to_tos","grant_type"]}}}} ``` ## The OAuth2AccessTokenRequestSwaggerExampleDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestSwaggerExampleDto":{"type":"object","properties":{"grant_type":{"type":"string","enum":["password","refresh_token","authorization_code","passwordless_auth","mobile_webview_auth"]},"username":{"type":"string","writeOnly":true},"password":{"type":"string","writeOnly":true},"scope":{"type":"string","writeOnly":true},"refresh_token":{"type":"string","writeOnly":true},"code":{"type":"string","writeOnly":true},"redirect_uri":{"type":"string","writeOnly":true},"client_id":{"type":"string","writeOnly":true},"client_secret":{"type":"string","writeOnly":true}},"required":["grant_type"]}}}} ``` ## The OAuth2AccessTokenDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenDto":{"type":"object","properties":{"access_token":{"type":"string","readOnly":true},"token_type":{"type":"string","enum":["bearer","custom"],"readOnly":true},"expires_in":{"type":"number","readOnly":true},"refresh_token":{"type":"string","readOnly":true},"scope":{"type":"string","readOnly":true}},"required":["access_token","token_type","expires_in","refresh_token"]}}}} ``` ## The OAuth2AccessTokenErrorDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenErrorDto":{"type":"object","properties":{"podify_required_agreements":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"errors":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["errors"]},"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"]}}}} ``` ## The OAuth2AccessTokenRequestWebviewAuthDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OAuth2AccessTokenRequestWebviewAuthDto":{"type":"object","properties":{"username":{"type":"string"},"grant_type":{"type":"string","enum":["mobile_webview_auth"]}},"required":["username","grant_type"]}}}} ``` ## The SSOAuthorizationDiscourseConnectDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SSOAuthorizationDiscourseConnectDto":{"type":"object","properties":{"type":{"type":"string","enum":["DISCOURSE_CONNECT"]},"sso":{"type":"string"},"sig":{"type":"string"},"callbackUrl":{"type":"string","readOnly":true}},"required":["type","sso","sig","callbackUrl"]}}}} ``` ## The SSOAuthorizationOauth2AuthorizationCodeDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SSOAuthorizationOauth2AuthorizationCodeDto":{"type":"object","properties":{"type":{"type":"string","enum":["OAUTH2_AUTHORIZATION_CODE"]},"clientId":{"type":"string"},"redirectUri":{"type":"string","writeOnly":true},"scope":{"type":"string"},"code":{"type":"string","readOnly":true},"callbackUrl":{"type":"string","readOnly":true}},"required":["type","clientId","redirectUri","code","callbackUrl"]}}}} ``` ## The UserCredentialsPatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"UserCredentialsPatchableDto":{"type":"object","properties":{"email":{"type":"string","format":"email","writeOnly":true}},"required":["email"]}}}} ``` ## The OpenGraphEventDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OpenGraphEventDto":{"type":"object","properties":{"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["startTime","endTime"]}}}} ``` ## The OpenGraphDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OpenGraphDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"siteName":{"type":"string"},"locale":{"type":"string"},"updatedTime":{"type":"string"},"image":{"type":"string"},"video":{"type":"string","nullable":true},"event":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OpenGraphEventDto"}]}},"required":["id","type","url","title","description","siteName","locale","updatedTime","image","video","event"]},"OpenGraphEventDto":{"type":"object","properties":{"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"}},"required":["startTime","endTime"]}}}} ``` ## The OrderExpenseReportDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"OrderExpenseReportDto":{"type":"object","properties":{"dateFrom":{"format":"date-time","type":"string"},"dateTo":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","VALID"],"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["dateFrom","dateTo","status","errors"]},"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"]}}}} ``` ## The RevenueStatsDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RevenueStatsDto":{"type":"object","properties":{"date":{"format":"date-time","type":"string"},"rangeType":{"type":"string","enum":["DAY","WEEK","MONTH","QUARTER","YEAR"]},"expected":{"type":"number"},"actual":{"type":"number"},"delta":{"type":"number"},"errorRate":{"type":"number"},"pendingStatusCount":{"type":"number"}},"required":["date","rangeType","expected","actual","delta","errorRate","pendingStatusCount"]}}}} ``` ## The RevenueStatsCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"RevenueStatsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RevenueStatsDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"RevenueStatsDto":{"type":"object","properties":{"date":{"format":"date-time","type":"string"},"rangeType":{"type":"string","enum":["DAY","WEEK","MONTH","QUARTER","YEAR"]},"expected":{"type":"number"},"actual":{"type":"number"},"delta":{"type":"number"},"errorRate":{"type":"number"},"pendingStatusCount":{"type":"number"}},"required":["date","rangeType","expected","actual","delta","errorRate","pendingStatusCount"]},"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"]}}}} ``` ## The SuspendedEventDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The SuspendedEventCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The SuspensionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The SuspensionPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SuspensionPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspensionDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_pagination","_total","_links"]},"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The SuspendedEventPaginatedCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SuspendedEventPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number"},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_pagination","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The PatchableSuspensionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PatchableSuspensionDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"endTime":{"format":"date-time","type":"string"}},"required":["type","endTime"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The SuspensionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"SuspensionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspensionDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspensionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"suspendedEvents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SuspendedEventCollectionDto"}]},"pod":{"$ref":"#/components/schemas/ItemRefDto"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT","ACTIVE","CANCELED"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["type","pod","startTime","endTime","status","errors","_links"]},"SuspendedEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedEventDto"}},"_total":{"type":"number","readOnly":true},"_links":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items","_total","_links"]},"SuspendedEventDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"event":{"$ref":"#/components/schemas/ItemRefDto"},"action":{"type":"string","enum":["REFUND","NO_REFUND"]},"status":{"type":"string","enum":["INVALID","CONFIRMED","DRAFT"],"nullable":true,"readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object","readOnly":true}},"required":["id","event","action","status","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]}}}} ``` ## The ScopeItemCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The TemplateDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateDto":{"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"}]},"type":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"number"},"data":{"type":"object"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"createdBy":{"$ref":"#/components/schemas/ItemRefDto"},"lastUpdatedBy":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"required":["id","type","status","name","version","data","createdDate","updatedDate"]},"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"]},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The TemplateCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TemplateDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TemplateDto":{"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"}]},"type":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"number"},"data":{"type":"object"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"createdBy":{"$ref":"#/components/schemas/ItemRefDto"},"lastUpdatedBy":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string"},"updatedDate":{"format":"date-time","type":"string"}},"required":["id","type","status","name","version","data","createdDate","updatedDate"]},"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"]},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}}} ``` ## The TemplateCreatableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateCreatableDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["EVENT","SERIES"]},"status":{"type":"string","enum":["DRAFT","PUBLISHED"]},"data":{"type":"object"},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"}},"required":["name","type","data"]},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The TemplatePatchableDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplatePatchableDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","ARCHIVED"]},"data":{"type":"object"},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"}}},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The TemplateVersionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateVersionDto":{"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"}]},"version":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"data":{"type":"object"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"changedBy":{"$ref":"#/components/schemas/ItemRefDto"},"changedDate":{"format":"date-time","type":"string"},"changeAction":{"type":"string"}},"required":["id","version","name","status","data","changedDate","changeAction"]},"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"]},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The TemplateVersionCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateVersionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TemplateVersionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"TemplateVersionDto":{"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"}]},"version":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"data":{"type":"object"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"changedBy":{"$ref":"#/components/schemas/ItemRefDto"},"changedDate":{"format":"date-time","type":"string"},"changeAction":{"type":"string"}},"required":["id","version","name","status","data","changedDate","changeAction"]},"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"]},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The TemplateRollbackDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateRollbackDto":{"type":"object","properties":{"version":{"type":"number"}},"required":["version"]}}}} ``` ## The TemplateFromSourceDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"TemplateFromSourceDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED"]},"areas":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"regions":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"pods":{"$ref":"#/components/schemas/ScopeItemCollectionDto"},"courts":{"$ref":"#/components/schemas/ScopeItemCollectionDto"}},"required":["name"]},"ScopeItemCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemRefDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The GiftCardDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"GiftCardDto":{"type":"object","properties":{"id":{"type":"string","description":"Gift card ID"},"gan":{"type":"string","description":"Gift card number (GAN)"},"type":{"type":"string","description":"Gift card request type","enum":["PREVIEW","ORDER"]},"balance":{"type":"number","description":"Current gift card balance in dollars"},"amount":{"type":"number","description":"Amount requested gift card in dollars"},"status":{"type":"string","description":"Gift card status","enum":["ACTIVE","BLOCKED","REDEEMED"]},"currency":{"type":"string","description":"Currency code"},"errors":{"description":"Validation errors if any","default":[],"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"provider":{"type":"string","description":"Gift card provider","enum":["SQUARE"]}},"required":["id","gan","type","balance","amount","status","currency","provider"]},"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"]}}}} ``` ## The GiftCardRedeemRequestDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"GiftCardRedeemRequestDto":{"type":"object","properties":{"type":{"type":"string","enum":["PREVIEW","ORDER"]},"gan":{"type":"string","description":"Gift card number (GAN)"}},"required":["type","gan"]}}}} ``` ## The GiftCardConfigDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"GiftCardConfigDto":{"type":"object","properties":{"squareAccessToken":{"type":"string","description":"Square access token for managing gift cards"},"giftCardsBuyLink":{"type":"string","description":"Gift cards buy link"},"isEnabled":{"type":"boolean","description":"Square gift cards are enabled"}},"required":["squareAccessToken","giftCardsBuyLink","isEnabled"]}}}} ``` ## The GiftCardConfigPatchDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"GiftCardConfigPatchDto":{"type":"object","properties":{"squareAccessToken":{"type":"string","description":"Square access token for managing gift cards"},"giftCardsBuyLink":{"type":"string","description":"Gift cards buy link"},"isEnabled":{"type":"boolean","description":"Square gift cards are enabled"}}}}}} ``` ## The VoiceMessageDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"VoiceMessageDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"message":{"type":"string"},"url":{"type":"string"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","message","url","_links"]},"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"]}}}} ``` ## The VoiceMessageCollectionDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"VoiceMessageCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMessageDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"VoiceMessageDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"displayName":{"type":"string"},"message":{"type":"string"},"url":{"type":"string"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","message","url","_links"]},"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"]}}}} ``` ## The VoiceDownDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"VoiceDownDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"status":{"type":"string"},"table":{"$ref":"#/components/schemas/ItemRefDto"},"voiceMessage":{"$ref":"#/components/schemas/ItemRefDto"},"user":{"$ref":"#/components/schemas/ItemRefDto"},"_links":{"type":"object","readOnly":true}},"required":["id","createdDate","updatedDate","status","table","voiceMessage","user","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]}}}} ``` ## The ReplayGenerationClientRequestDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayGenerationClientRequestDto":{"type":"object","properties":{"clipId":{"type":"string","writeOnly":true},"success":{"type":"boolean","writeOnly":true},"cameraId":{"type":"string","writeOnly":true},"url":{"type":"string","writeOnly":true},"hlsUrl":{"type":"string","writeOnly":true},"thumbnailSmallUrl":{"type":"string","writeOnly":true},"thumbnailMediumUrl":{"type":"string","writeOnly":true},"thumbnailLargeUrl":{"type":"string","writeOnly":true}},"required":["clipId","success","cameraId","url","hlsUrl","thumbnailSmallUrl","thumbnailMediumUrl","thumbnailLargeUrl"]}}}} ``` ## The ReplayCleanupResponseDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"ReplayCleanupResponseDto":{"type":"object","properties":{"success":{"type":"boolean","writeOnly":true},"id":{"type":"string","writeOnly":true},"errors":{"writeOnly":true,"type":"array","items":{"type":"string"}}},"required":["success","id","errors"]}}}} ``` ## The DiscourseNotificationRequestDto object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"DiscourseNotificationRequestDto":{"type":"object","properties":{"data":{"type":"string","writeOnly":true},"aesKey":{"type":"string","writeOnly":true},"aesIv":{"type":"string","writeOnly":true}},"required":["data","aesKey","aesIv"]}}}} ``` ## The PodplayTriggerHeaders object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerHeaders":{"type":"object","description":"HTTP headers included with every PodPlay trigger request","properties":{"Content-Type":{"type":"string","description":"Always application/json"},"User-Agent":{"type":"string","description":"PodPlay webhook identifier"},"X-Webhook-ID":{"type":"string","description":"Unique webhook configuration ID"},"X-Event-Type":{"type":"string","description":"The type of event being sent"},"X-Event-ID":{"type":"string","description":"Unique identifier for this event instance"},"X-Tenant-ID":{"type":"string","description":"The tenant where the event occurred"}},"required":["Content-Type","User-Agent","X-Webhook-ID","X-Event-Type","X-Event-ID","X-Tenant-ID"]}}}} ``` ## The PodplayTriggerUserCreatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerUserCreatedPayload":{"type":"object","description":"Complete payload for user.created PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserDto"},"creator":{"$ref":"#/components/schemas/UserDto"},"areas":{"type":"array","items":{"$ref":"#/components/schemas/AreaDto"}}},"required":["user"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"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"}}},"AreaDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"displayNameShort":{"type":"string"},"status":{"type":"string","enum":["NOT_AVAILABLE","AVAILABLE","TEMPORARILY_CLOSED","COMING_SOON"]},"comingSoonText":{"type":"string","description":"Custom text to display when status is COMING_SOON (max 40 chars)"},"address":{"$ref":"#/components/schemas/AreaAddressDto"},"pods":{"$ref":"#/components/schemas/PodCollectionDto"},"availableCoaches":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/AreaCoachAvailabilityCollectionDto"}]},"picture":{"$ref":"#/components/schemas/ImageDto"},"region":{"$ref":"#/components/schemas/RegionDto"},"settings":{"$ref":"#/components/schemas/AreaSettingsCollectionDto"},"replaysPricing":{"description":"Replay pricing configuration (admin only, expandable)","allOf":[{"$ref":"#/components/schemas/ReplayPricingDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","displayNameShort","status","address","picture","region","settings","errors","_links"]},"AreaAddressDto":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"borough":{"type":"string"},"zip":{"type":"string"},"displayName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/AreaAddressCoordinatesDto"}},"required":["street","city","borough","zip","displayName"]},"AreaAddressCoordinatesDto":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"required":["latitude","longitude"]},"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"]},"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"]},"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"]},"AreaCoachAvailabilityCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaCoachAvailabilityDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaCoachAvailabilityDto":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","UNAVAILABLE_EXPIRED","UNAVAILABLE_NOTICE_CUSHION","UNAVAILABLE_SWITCH_CUSHION"]},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"coach":{"$ref":"#/components/schemas/CoachProfileDto"},"_links":{"type":"object"}},"required":["id","status","startTime","endTime","area","coach","_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"]},"CoachRateDto":{"type":"object","properties":{"guests":{"type":"number"},"hourlyRate":{"type":"number"}},"required":["guests","hourlyRate"]},"ImageDto":{"type":"object","properties":{"id":{"type":"string"},"small":{"$ref":"#/components/schemas/LinkDto"},"medium":{"$ref":"#/components/schemas/LinkDto"},"large":{"$ref":"#/components/schemas/LinkDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","small","medium","large","_links"]},"RegionDto":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"displayName":{"type":"string"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"taxSettings":{"type":"array","items":{"type":"string"}},"settings":{"$ref":"#/components/schemas/RegionSettingsCollectionDto"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","slug","displayName","taxSettings","settings","errors","_links"]},"RegionSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RegionSettingDto"}},"_total":{"type":"number"},"_links":{"type":"object"}},"required":["items","_total","_links"]},"RegionSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"value":{"type":"object"}},"required":["id","value"]},"AreaSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AreaSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"AreaSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["area.timezone","area.onPremiseApiURL","area.onPremiseLocalApiURL","area.onPremiseReplaysEnabled","area.priority","area.stripeAccountId","area.pictureAssetId","area.duprClubId","area.taxSettings","area.membersInvitationCopy","area.membershipDefaultMinTenancyDays","area.membershipDefaultMinCancellationNoticeDaysMonthly","area.membershipDefaultMinCancellationNoticeDaysYearly","feature.showSpotsLeft","feature.allowCreditsForCoaching","area.membershipHeaderHtml","area.membershipBenefitsMarkdown"]},"value":{"type":"object"}},"required":["id","value"]},"ReplayPricingDto":{"type":"object","properties":{"quickReplay":{"$ref":"#/components/schemas/ReplayPricingQuickReplayDto"},"customReplay":{"$ref":"#/components/schemas/ReplayPricingCustomReplayDto"},"enhancedReplay":{"$ref":"#/components/schemas/ReplayPricingEnhancedReplayDto"}}},"ReplayPricingQuickReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether quick replays are enabled"},"lengthSeconds":{"type":"number","description":"Length in seconds"},"price":{"type":"number","description":"Price in dollars"},"initialFree":{"type":"number","description":"Number of initial free quick replays"}}},"ReplayPricingCustomReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether custom replays are enabled"},"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds for custom replays"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds for custom replays"},"maxDaysToRequest":{"type":"number","description":"Number of days in the past users can request replays from"},"pricingIntervals":{"description":"Interval-based pricing. Each interval defines a price for a duration range. Takes precedence over pricePerMinute.","type":"array","items":{"$ref":"#/components/schemas/ReplayPricingIntervalDto"}},"pricePerMinute":{"type":"number","description":"Price per minute in dollars (legacy, used when pricingIntervals is not defined)"}}},"ReplayPricingIntervalDto":{"type":"object","properties":{"minDurationSeconds":{"type":"number","description":"Minimum duration in seconds (inclusive)"},"maxDurationSeconds":{"type":"number","description":"Maximum duration in seconds (exclusive). If null, applies to all durations above minDurationSeconds"},"price":{"type":"number","description":"Price in dollars for this interval"}},"required":["minDurationSeconds","price"]},"ReplayPricingEnhancedReplayDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether enhanced replays are enabled"},"pricePerMinute":{"type":"number","description":"Price per minute in dollars for new enhanced replays"}}}}}} ``` ## The PodplayTriggerUserUpdatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerUserUpdatedPayload":{"type":"object","description":"Complete payload for user.updated PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserDto"}},"required":["user"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"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"}}}}}} ``` ## The PodplayTriggerPurchaseCreatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerPurchaseCreatedPayload":{"type":"object","description":"Complete payload for purchase.created PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderDto"}},"required":["order"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"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"]},"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"]},"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"]}}}} ``` ## The PodplayTriggerBookingCreatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerBookingCreatedPayload":{"type":"object","description":"Complete payload for booking.created PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderDto"}},"required":["order"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"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"]},"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"]},"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"]}}}} ``` ## The PodplayTriggerMembershipEnrollmentCreatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerMembershipEnrollmentCreatedPayload":{"type":"object","description":"Complete payload for membership-enrollment.created PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"membershipEnrollment":{"$ref":"#/components/schemas/MembershipEnrollmentDto"}},"required":["membershipEnrollment"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"MembershipEnrollmentDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string","readOnly":true},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"],"readOnly":true},"user":{"$ref":"#/components/schemas/ItemRefDto"},"creatorUser":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membership":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"membershipSubscription":{"$ref":"#/components/schemas/ItemRefDto"},"isOwner":{"type":"boolean","readOnly":true,"nullable":true},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"customFee":{"type":"number","nullable":false,"default":0},"_links":{"type":"object"}},"required":["id","displayName","type","user","creatorUser","membership","membershipSubscription","isOwner","errors","customFee","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]}}}} ``` ## The PodplayTriggerEventCreatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerEventCreatedPayload":{"type":"object","description":"Complete payload for event.created PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventDto"}},"required":["event"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The PodplayTriggerEventSignupCreatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerEventSignupCreatedPayload":{"type":"object","description":"Complete payload for event-signup.created PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"eventSignup":{"$ref":"#/components/schemas/EventSignupDto"},"event":{"$ref":"#/components/schemas/EventDto"}},"required":["eventSignup","event"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"EventSignupDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","INVALID","PENDING","CONFIRMED","CANCELED","REQUIRES_AUTHENTICATION","PROCESSING"],"readOnly":true},"mode":{"type":"string","enum":["USER_BOOKED","FREE_OF_CHARGE"],"writeOnly":true,"nullable":true},"paymentMethod":{"type":"string","enum":["CASH","CARD"],"writeOnly":true,"nullable":true},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true},"couponCode":{"type":"string","writeOnly":true,"nullable":true},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE","USE_ONLY_OWNER","USE_ONLY_GUESTS"],"nullable":true},"termsAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Terms\" along with the signup request."},"liabilityWaiverAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Liability waiver\" along with the signup request."},"availableGuests":{"description":"The additional guests that can be added to the signup.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupGuestsOptionCollectionDto"}]},"guests":{"writeOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"kids":{"writeOnly":false,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"coupon":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/CouponSummaryDto"}]},"summary":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryDto"}]},"owner":{"$ref":"#/components/schemas/ItemRefDto"},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","status","mode","paymentMethod","virtualCredits","couponCode","passesStrategy","termsAgreed","liabilityWaiverAgreed","availableGuests","guests","kids","coupon","summary","owner","order","_links"]},"EventSignupGuestsOptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSignupGuestsOptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSignupGuestsOptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"guests":{"type":"number"},"rate":{"type":"number"}},"required":["id","displayName","guests","rate"]},"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"]},"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"]},"CouponSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","code","discountType","value","_links"]},"EventSignupSummaryDto":{"type":"object","properties":{"event":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"currency":{"type":"string","readOnly":true},"rates":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryRatesDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"couponDiscount":{"type":"number","readOnly":true},"package":{"readOnly":true,"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"total":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["event","invitation","openInvitation","currency","rates","subtotal","taxes","virtualCredits","couponDiscount","package","passes","total","errors"]},"EventSignupSummaryRatesDto":{"type":"object","properties":{"signup":{"type":"number","readOnly":true},"guests":{"type":"number","readOnly":true},"teamLeader":{"type":"number","readOnly":true},"teamMember":{"type":"number","readOnly":true}},"required":["signup","guests"]},"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"]},"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"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The PodplayTriggerEventUpdatedPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerEventUpdatedPayload":{"type":"object","description":"Complete payload for event.updated PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventDto"}},"required":["event"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"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"]},"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"]},"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"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` ## The PodplayTriggerEventSignupCanceledPayload object ```json {"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"components":{"schemas":{"PodplayTriggerEventSignupCanceledPayload":{"type":"object","description":"Complete payload for event-signup.canceled PodPlay trigger event","properties":{"event":{"type":"object","properties":{"type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"data":{"type":"object","properties":{"eventSignup":{"$ref":"#/components/schemas/EventSignupDto"},"event":{"$ref":"#/components/schemas/EventDto"}},"required":["eventSignup","event"]}},"required":["type","timestamp","tenantId","data"]},"webhook":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"url":{"type":"string"}},"required":["id","displayName","url"]}},"required":["event","webhook"]},"EventSignupDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","enum":["PREVIEW","ORDER"]},"status":{"type":"string","enum":["DRAFT","INVALID","PENDING","CONFIRMED","CANCELED","REQUIRES_AUTHENTICATION","PROCESSING"],"readOnly":true},"mode":{"type":"string","enum":["USER_BOOKED","FREE_OF_CHARGE"],"writeOnly":true,"nullable":true},"paymentMethod":{"type":"string","enum":["CASH","CARD"],"writeOnly":true,"nullable":true},"virtualCredits":{"type":"number","writeOnly":true,"nullable":true},"couponCode":{"type":"string","writeOnly":true,"nullable":true},"passesStrategy":{"type":"string","enum":["USE_ALL","USE_NONE","USE_ONLY_OWNER","USE_ONLY_GUESTS"],"nullable":true},"termsAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Terms\" along with the signup request."},"liabilityWaiverAgreed":{"type":"boolean","writeOnly":true,"nullable":true,"description":"An optional parameter to tell the User is agreeing the \"Liability waiver\" along with the signup request."},"availableGuests":{"description":"The additional guests that can be added to the signup.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupGuestsOptionCollectionDto"}]},"guests":{"writeOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"kids":{"writeOnly":false,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"coupon":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/CouponSummaryDto"}]},"summary":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryDto"}]},"owner":{"$ref":"#/components/schemas/ItemRefDto"},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","type","status","mode","paymentMethod","virtualCredits","couponCode","passesStrategy","termsAgreed","liabilityWaiverAgreed","availableGuests","guests","kids","coupon","summary","owner","order","_links"]},"EventSignupGuestsOptionCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EventSignupGuestsOptionDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"EventSignupGuestsOptionDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"guests":{"type":"number"},"rate":{"type":"number"}},"required":["id","displayName","guests","rate"]},"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"]},"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"]},"CouponSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"discountType":{"type":"string","enum":["AMOUNT_OFF","PERCENT_OFF"]},"value":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","code","discountType","value","_links"]},"EventSignupSummaryDto":{"type":"object","properties":{"event":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"invitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"openInvitation":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"currency":{"type":"string","readOnly":true},"rates":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/EventSignupSummaryRatesDto"}]},"subtotal":{"type":"number","readOnly":true},"taxes":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"virtualCredits":{"type":"number","readOnly":true},"couponDiscount":{"type":"number","readOnly":true},"package":{"readOnly":true,"nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"passes":{"readOnly":true,"nullable":true,"description":"Only available if `passesStrategy` is not null.","allOf":[{"$ref":"#/components/schemas/OrderPassCollectionDto"}]},"total":{"type":"number","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["event","invitation","openInvitation","currency","rates","subtotal","taxes","virtualCredits","couponDiscount","package","passes","total","errors"]},"EventSignupSummaryRatesDto":{"type":"object","properties":{"signup":{"type":"number","readOnly":true},"guests":{"type":"number","readOnly":true},"teamLeader":{"type":"number","readOnly":true},"teamMember":{"type":"number","readOnly":true}},"required":["signup","guests"]},"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"]},"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"]},"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"]},"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"]},"UserProfileCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserProfileDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]}}}} ``` --- # 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/models.md?ask=&goal= ``` `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.