The Beta API provides information about VRChat's beta programs. Currently, it allows you to retrieve information about the closed beta for iOS devices.

1. getIOSClosedBetaInformation - Get information about the current closed beta for iOS.

getIOSClosedBetaInformation(): Promise<BetaIOSInformation>

// Example: Get information about the iOS closed beta
const betaInfo = await vrchatApi.betaApi.getIOSClosedBetaInformation();
console.log(betaInfo);

// Access specific details
console.log(`Beta Active: ${betaInfo.active}`);
console.log(`Beta Name: ${betaInfo.betaName}`);
console.log(`Supported Devices: ${betaInfo.userFields.devices.allowedValues.join(', ')}`);

type BetaIOSInformation = {
  active: boolean;
  id: string; // BaseId
  betaGroupId: string;
  betaName: string;
  created_at: string; // Date in ISO 8601 format
  lastSynchronizedAt: string; // Date in ISO 8601 format
  type: string;
  updated_at: string; // Date in ISO 8601 format
  userFields: UserFields;
};

• active: Indicates whether the beta program is currently active (true or false).
• id: The unique identifier for the beta information.
• betaGroupId: The identifier for the beta group.
• betaName: The name of the beta program.
• created_at, updated_at, lastSynchronizedAt: Timestamps indicating when the beta information was created, last updated, and last synchronized.
• type: The type of the beta program.
• userFields: An object containing the fields required from users to participate in the beta.

type UserFields = {
  devices: DevicesField;
  discordName: DiscordNameField;
  isCreator: IsCreatorField;
};

• devices: Information about the devices supported in the beta.
• discordName: Indicates whether the user's Discord name is required and if it is excluded from analytics.
• isCreator: Indicates whether being a creator is required for the beta.

type DevicesField = {
  allowedValues: DevicesAllowedValues[];
  required: boolean;
};

• allowedValues: An array of device identifiers that are supported in the beta.
• required: Indicates whether specifying a device is required to participate.

enum DevicesAllowedValues {
  iPhone12PM = 'iPhone12PM',
  iPhone13PM = 'iPhone13PM',
  iPhone14 = 'iPhone14',
  iPhone14PM = 'iPhone14PM',
  iPhone15 = 'iPhone15',
  iPhone15PM = 'iPhone15PM',
  iPadPro11 = 'iPadPro11',
  iPadPro12 = 'iPadPro12',
  iPadAir = 'iPadAir',
}

• This enum lists the allowed device values for the iOS closed beta. Devices include various models of iPhones and iPads.

type DiscordNameField = {
  excludeFromAnalytics: boolean;
  required: boolean;
};

• excludeFromAnalytics: Indicates whether the Discord name is excluded from analytics data.
• required: Indicates whether providing a Discord name is required to participate.

type IsCreatorField = {
  required: boolean;
};

• required: Indicates whether being a creator is a requirement for participating in the beta.

1. getIOSClosedBetaInformation - Get information about the current closed beta for iOS.

• Beta Participation Requirements: The userFields object provides information about the requirements for users to participate in the beta program, such as required devices, whether a Discord name is needed, and if being a creator is necessary.

• Device Support: The allowedValues array in the devices field lists all the supported devices for the beta. Ensure that you have one of the supported devices if you plan to participate.