{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-restcollection-model-base-open-api-group-controller-group-schema.json",
  "title": "RESTCollectionModelBase_OpenApiGroupController.Group",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-group-api-openapi.yml#/components/schemas/RESTCollectionModelBase_OpenApiGroupController.Group",
  "type": "object",
  "properties": {
    "embed": {
      "type": "string"
    },
    "item": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OpenApiGroupController.Group"
      }
    },
    "page": {
      "format": "int32",
      "type": "integer"
    },
    "recordsPerPage": {
      "format": "int32",
      "type": "integer"
    },
    "searchQuery": {
      "type": "string"
    },
    "sort": {
      "type": "string"
    },
    "totalRecords": {
      "format": "int32",
      "type": "integer"
    }
  },
  "$defs": {
    "OpenApiGroupController.Group": {
      "description": "Group REST model",
      "type": "object",
      "properties": {
        "countryId": {
          "format": "uuid",
          "description": "Unique identifier representing the related Country entity.",
          "type": "string"
        },
        "email": {
          "description": "The email address associated with the group.",
          "type": "string"
        },
        "hasPetAssureIntegration": {
          "description": "Value indicating whether this Group has Pet Assure integration.\nIf this Group is a Pet Assure practice, it can automatically apply discounts for all Pet Assure members without manual validation.",
          "type": "boolean"
        },
        "hasShepherdPayIntegration": {
          "description": "Value indicating whether this Group has shepherd pay integration.",
          "type": "boolean"
        },
        "isAutoResponseMessageEnabled": {
          "description": "Value indicating whether automatic response messaging is enabled for this Group.\nAn automatic message is sent when clients contact the clinic via SMS outside of working hours.",
          "type": "boolean"
        },
        "isDemo": {
          "description": "Value indicating whether this Group is demo clinic (for migration).",
          "type": "boolean"
        },
        "isDemoChangedOnce": {
          "description": "Value indicating whether the IsDemo is changed once from true to false.",
          "type": "boolean"
        },
        "isMultiSite": {
          "description": "Indicates whether this Group is part of a multisite setup.",
          "type": "boolean"
        },
        "mediaVaultEntryId": {
          "format": "uuid",
          "description": "Unique identifier representing the related MediaVaultEntry entity.",
          "type": "string"
        },
        "name": {
          "description": "The name of the group.",
          "type": "string"
        },
        "paymentProcessorSetting": {
          "$ref": "#/$defs/OpenApiGroupController.PaymentProcessorSetting",
          "description": "Object representing the related payment processor setting entity."
        },
        "petPortalSetting": {
          "$ref": "#/$defs/OpenApiGroupController.PetPortalSetting",
          "description": "Object representing the related the pet portal setting entity."
        },
        "phone": {
          "description": "Phone number of the group.",
          "type": "string"
        },
        "shareClientDiscount": {
          "description": "Flag indicating whether group clinics share client discount data. If client discounts are shared, they can only be created and edited on the group platform, but discount can be added to clients on clinics.\nWhen retrieving data, all client discount data will be shown from the group platform.",
          "type": "boolean"
        },
        "shareClientsAndPatients": {
          "description": "Flag indicating whether group clinics share client and patient data.\nIf clients and patients are shared, client discount data must also be shared.\nClients and patients are created at one of the multisite clinics, which becomes their home clinic.\nWhen retrieving data, all values are the same across all clinics within the multisite group.",
          "type": "boolean"
        },
        "shareForms": {
          "description": "Flag indicating whether group clinics share form data. If forms are shared, they can only be created on the group platform.\nWhen retrieving data, all form data will be shown from the group, except for assigned appointment types.\nEach group clinic creates its own appointment types, which can be assigned to forms at the clinic level.\nRetrieved form data will include default form values as well as overridden values, such as the appointment type date.",
          "type": "boolean"
        },
        "shareMessaging": {
          "description": "Flag indicating whether group clinics share messaging data. Shared messaging requires shared Clients/Patients\nIf shared, a single phone number is used for all clinics, and messaging is handled on the group platform.\nIf messaging is not shared, each group clinic has its own phone number and message center.",
          "type": "boolean"
        },
        "sharePaymentMethods": {
          "description": "Flag indicating whether group clinics share payment method (payment type) data.\nIf shared, creation and editing of payment types is done at the group platform.\nOtherwise, it is managed individually per clinic.",
          "type": "boolean"
        },
        "sharePaymentProcessorSetting": {
          "description": "Flag indicating whether group clinics share payment processor setting data (shepherd pay).\nIf shared, enabling/disabling of shepherd pay is done at the group platform; otherwise, it is managed individually per clinic.",
          "type": "boolean"
        },
        "sharePayments": {
          "description": "Value indicating if payments are shared at the group level. To share payments, clients and patients must also be shared.",
          "type": "boolean"
        },
        "sharePetPortal": {
          "description": "Flag indicating whether group clinics share pet portal data.\nIf shared, management of the pet portal is done at the group level and all group clinics have the same pet portal URL.\nOtherwise, the pet portal is managed individually per clinic and each clinic has its own URL.\nValue indicating whether all clinics in the group share pet portal data.",
          "type": "boolean"
        },
        "shareProductPricing": {
          "description": "Flag indicating whether group clinics share product pricing data. Sharing Product pricing requires sharing of products and reminders.\nIf shared, product pricing is managed on the group platform and group clinics cannot override pricing values, only default custom types such as discharge instructions and etc.\nIf product pricing is not shared, product pricing is managed on the clinic level.",
          "type": "boolean"
        },
        "shareProducts": {
          "description": "Flag indicating whether a group shares product data.\nIf products are shared, creation is done on the group platform.\nWhen retrieving data, group-level data is already embedded and will always be included.\nIf a clinic overrides any values (e.g., price when not shared), the overridden clinic-specific data will be shown instead.\nClinics can override custom types such as discharge instructions and automatic tasks.",
          "type": "boolean"
        },
        "shareReferralSource": {
          "description": "Flag indicating whether group clinics share referral sources.\nIf shared, creation and editing of referral sources are done on the group platform level.\nOtherwise, each clinic creates and edits its own referral sources.\nReferral sources can be assigned to users at clinic level only.",
          "type": "boolean"
        },
        "shareTasks": {
          "description": "Flag indicating whether group clinics share task data.\nTasks are created at the clinic level, regardless of whether sharing is enabled.\nIf sharing is enabled, tasks can be managed from any clinic, regardless of where they were originally created. When retrieving data,\ntasks from the clinic specified in the x-clinic-id header will be returned. If additional clinic IDs are included in the request filter,\ntasks from those clinics will also be returned. If tasks are not shared, each clinic creates and manages its own tasks (e.g., Clinic A will not have access to Clinic B's tasks).\nWhen a filter is applied, only tasks from the specified clinic IDs are returned.",
          "type": "boolean"
        },
        "twilioA2PRegistrationStatus": {
          "$ref": "#/$defs/OpenApiGroupController.TwilioA2PRegistrationStatus",
          "description": "Object representing the related Twilio Application-to-Person registration status entity.\nTwilio Application-to-Person allows businesses to send automated messages to customers, such as alerts or notifications, through SMS or other channels."
        },
        "twilioA2PRegistrationStatusId": {
          "format": "uuid",
          "description": "Unique identifier representing the related TwilioA2PRegistrationStatus entity.",
          "type": "string"
        },
        "twilioNumber": {
          "description": "The twilio number for the group.",
          "type": "string"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiGroupController.PaymentProcessorSetting": {
      "description": "PaymentProcessorSetting REST model.",
      "type": "object",
      "properties": {
        "clinicId": {
          "format": "uuid",
          "description": "Unique identifier representing the related Clinic entity.",
          "type": "string"
        },
        "isShepherdPayEnabled": {
          "description": "Indicates whether this PaymentProcessorSetting has Shepherd Pay enabled.",
          "type": "boolean"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiGroupController.PetPortalSetting": {
      "description": "PetPortalSetting REST model.",
      "type": "object",
      "properties": {
        "clinicId": {
          "format": "uuid",
          "description": "Unique identifier representing the related Clinic entity.",
          "type": "string"
        },
        "directBookingEnableRegister": {
          "description": "Flag which indicates whether the direct booking registration feature is enabled.\nClients can use the pet portal to register new clients at the clinic.",
          "type": "boolean"
        },
        "directBookingEnabled": {
          "description": "Flag which indicates whether direct booking through the pet portal is enabled.\nClients can request appointments with the clinic via the pet portal.\nIf the DirectBookingWithoutApprovalEnabled flag is set to true, clients do not\nneed to wait for the clinic's response to approve their requests.",
          "type": "boolean"
        },
        "directBookingMaxDaysInAdvance": {
          "format": "int32",
          "description": "Number of maximum days in advance for direct booking.",
          "type": "integer"
        },
        "directBookingMinDaysInAdvance": {
          "format": "int32",
          "description": "Number of mimimum days in advance for direct booking.",
          "type": "integer"
        },
        "directBookingScheduleInterval": {
          "format": "int32",
          "description": "The interval period displayed for available slots on the pet portal.",
          "type": "integer"
        },
        "directBookingWithoutApprovalEnabled": {
          "description": "Flag indicating whether pet portal direct booking without approval is enabled.\nClients can create appointments with the clinic without approval via the pet portal.",
          "type": "boolean"
        },
        "petPortalAppointmentsEnabled": {
          "description": "Flag which indicates whether appointments through the pet portal are enabled.",
          "type": "boolean"
        },
        "petPortalColorSchemeId": {
          "format": "uuid",
          "description": "Unique identifier representing the related PetPortalColorScheme entity.",
          "type": "string"
        },
        "petPortalEnabled": {
          "description": "Flag indicating whether pet portal is enabled.",
          "type": "boolean"
        },
        "petPortalHeroId": {
          "format": "uuid",
          "description": "Unique identifier representing the related PetPortalHero entity.",
          "type": "string"
        },
        "petPortalOnlinePaymentsEnabled": {
          "description": "Flag indicating whether pet portal online payments is enabled.",
          "type": "boolean"
        },
        "petPortalPrescriptionsEnabled": {
          "description": "Flag indicating whether pet portal prescriptions is enabled.",
          "type": "boolean"
        },
        "petPortalUrl": {
          "description": "The pet portal URL.",
          "type": "string"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiGroupController.TwilioA2PRegistrationStatus": {
      "description": "TwilioA2PRegistrationStatus REST model",
      "type": "object",
      "properties": {
        "abrv": {
          "description": "Short unique identifier for the lookup.",
          "type": "string"
        },
        "description": {
          "description": "The description of the lookup entry.",
          "type": "string"
        },
        "name": {
          "description": "The name of the lookup entry.",
          "type": "string"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    }
  }
}