Studio Services
StudioService
pydantic-model
¶
Bases: OtfItemBase
A service or class package offered by a studio, such as class packs or memberships.
Show JSON schema:
{
"$defs": {
"StudioDetail": {
"description": "Detailed information about an OrangeTheory studio.",
"properties": {
"studioUUId": {
"description": "The OTF studio UUID",
"title": "Studiouuid",
"type": "string"
},
"contactEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Studio contact email address.",
"title": "Contactemail"
},
"distance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Distance from latitude and longitude provided to `search_studios_by_geo` method, NULL if that method was not used",
"title": "Distance"
},
"studioLocation": {
"allOf": [
{
"$ref": "#/$defs/StudioLocation"
}
],
"description": "Physical location details."
},
"studioName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the studio.",
"title": "Studioname"
},
"studioStatus": {
"anyOf": [
{
"$ref": "#/$defs/StudioStatus"
},
{
"type": "null"
}
],
"default": null,
"description": "Active, Temporarily Closed, Coming Soon"
},
"timeZone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "IANA time zone of the studio.",
"title": "Timezone"
},
"acceptsAch": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Acceptsach"
},
"acceptsAmericanExpress": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Acceptsamericanexpress"
},
"acceptsDiscover": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Acceptsdiscover"
},
"acceptsVisaMasterCard": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Acceptsvisamastercard"
},
"allowsCrWaitlist": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Allowscrwaitlist"
},
"allowsDashboardAccess": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Allowsdashboardaccess"
},
"is_crm": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Crm"
},
"isIntegrated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Always 'True'",
"title": "Isintegrated"
},
"isMobile": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Ismobile"
},
"isOtbeat": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Isotbeat"
},
"is_web": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Web"
},
"smsPackageEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Smspackageenabled"
},
"studioId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Not used by API",
"title": "Studioid"
},
"mboStudioId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "MindBody attr",
"title": "Mbostudioid"
},
"openDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Opendate"
},
"pricingLevel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Pro, Legacy, Accelerate, or empty",
"title": "Pricinglevel"
},
"reOpenDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reopendate"
},
"studioNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Studionumber"
},
"studioPhysicalLocationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Studiophysicallocationid"
},
"studioToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Studiotoken"
},
"studioTypeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Studiotypeid"
}
},
"required": [
"studioUUId"
],
"title": "StudioDetail",
"type": "object"
},
"StudioLocation": {
"description": "Physical location details for an OrangeTheory studio.",
"properties": {
"line1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Line1"
},
"line2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Line2"
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City"
},
"postal_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Postal Code"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
},
"physicalRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Physicalregion"
},
"physicalCountryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Physicalcountryid"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Studio phone number.",
"title": "Phone"
},
"latitude": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Geographic latitude.",
"title": "Latitude"
},
"longitude": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Geographic longitude.",
"title": "Longitude"
}
},
"title": "StudioLocation",
"type": "object"
},
"StudioStatus": {
"description": "Operational status of an OrangeTheory studio.",
"enum": [
"OTHER",
"Active",
"Inactive",
"Coming Soon",
"Temporarily Closed",
"Permanently Closed",
"Unknown"
],
"title": "StudioStatus",
"type": "string"
}
},
"description": "A service or class package offered by a studio, such as class packs or memberships.",
"properties": {
"studio": {
"$ref": "#/$defs/StudioDetail"
},
"serviceUUId": {
"description": "Unique identifier for the service.",
"title": "Serviceuuid",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the service.",
"title": "Name"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Price of the service.",
"title": "Price"
},
"qty": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Quantity included in the service.",
"title": "Qty"
},
"onlinePrice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Online purchase price.",
"title": "Onlineprice"
},
"taxRate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tax rate applied to the service.",
"title": "Taxrate"
},
"current": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the service is currently active.",
"title": "Current"
},
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether the service has been deleted.",
"title": "Isdeleted"
},
"createdDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the service record was created.",
"title": "Createddate"
},
"updatedDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "When the service record was last updated.",
"title": "Updateddate"
},
"mboProgramId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Mboprogramid"
},
"mboDescriptionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mbodescriptionid"
},
"mboProductId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Mboproductid"
},
"serviceId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serviceid"
},
"studioId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Studioid"
},
"createdBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Createdby"
},
"updatedBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updatedby"
},
"isWeb": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Isweb"
},
"isCrm": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Iscrm"
},
"isMobile": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Ismobile"
}
},
"required": [
"studio",
"serviceUUId"
],
"title": "StudioService",
"type": "object"
}
Fields:
-
studio(StudioDetail) -
service_uuid(str) -
name(str | None) -
price(str | None) -
qty(int | None) -
online_price(str | None) -
tax_rate(str | None) -
current(bool | None) -
is_deleted(bool | None) -
created_date(datetime | None) -
updated_date(datetime | None) -
mbo_program_id(int | None) -
mbo_description_id(str | None) -
mbo_product_id(int | None) -
service_id(int | None) -
studio_id(int | None) -
created_by(str | None) -
updated_by(str | None) -
is_web(bool | None) -
is_crm(bool | None) -
is_mobile(bool | None)