SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Variable InstanceServiceConst

    InstanceService: GenService<
        {
            addInstanceAccount: {
                input: typeof InstanceAddAccountRequestSchema;
                methodKind: "unary";
                output: typeof InstanceAddAccountResponseSchema;
            };
            addInstanceAccountsBatch: {
                input: typeof InstanceAddAccountsBatchRequestSchema;
                methodKind: "unary";
                output: typeof InstanceAddAccountsBatchResponseSchema;
            };
            addInstanceProxiesBatch: {
                input: typeof InstanceAddProxiesBatchRequestSchema;
                methodKind: "unary";
                output: typeof InstanceAddProxiesBatchResponseSchema;
            };
            addInstanceProxy: {
                input: typeof InstanceAddProxyRequestSchema;
                methodKind: "unary";
                output: typeof InstanceAddProxyResponseSchema;
            };
            createInstance: {
                input: typeof InstanceCreateRequestSchema;
                methodKind: "unary";
                output: typeof InstanceCreateResponseSchema;
            };
            deleteAccountMetadataEntry: {
                input: typeof DeleteAccountMetadataEntryRequestSchema;
                methodKind: "unary";
                output: typeof DeleteAccountMetadataEntryResponseSchema;
            };
            deleteInstance: {
                input: typeof InstanceDeleteRequestSchema;
                methodKind: "unary";
                output: typeof InstanceDeleteResponseSchema;
            };
            deleteInstanceMetadataEntry: {
                input: typeof DeleteInstanceMetadataEntryRequestSchema;
                methodKind: "unary";
                output: typeof DeleteInstanceMetadataEntryResponseSchema;
            };
            getAccountMetadata: {
                input: typeof GetAccountMetadataRequestSchema;
                methodKind: "unary";
                output: typeof GetAccountMetadataResponseSchema;
            };
            getAuditLog: {
                input: typeof InstanceAuditLogRequestSchema;
                methodKind: "unary";
                output: typeof InstanceAuditLogResponseSchema;
            };
            getInstanceInfo: {
                input: typeof InstanceInfoRequestSchema;
                methodKind: "unary";
                output: typeof InstanceInfoResponseSchema;
            };
            getInstanceMetadata: {
                input: typeof GetInstanceMetadataRequestSchema;
                methodKind: "unary";
                output: typeof GetInstanceMetadataResponseSchema;
            };
            getOrCreateBot: {
                input: typeof InstanceGetOrCreateBotRequestSchema;
                methodKind: "unary";
                output: typeof InstanceGetOrCreateBotResponseSchema;
            };
            getOrCreateInstance: {
                input: typeof InstanceGetOrCreateRequestSchema;
                methodKind: "unary";
                output: typeof InstanceGetOrCreateResponseSchema;
            };
            listInstances: {
                input: typeof InstanceListRequestSchema;
                methodKind: "unary";
                output: typeof InstanceListResponseSchema;
            };
            removeInstanceAccount: {
                input: typeof InstanceRemoveAccountRequestSchema;
                methodKind: "unary";
                output: typeof InstanceRemoveAccountResponseSchema;
            };
            removeInstanceAccountsBatch: {
                input: typeof InstanceRemoveAccountsBatchRequestSchema;
                methodKind: "unary";
                output: typeof InstanceRemoveAccountsBatchResponseSchema;
            };
            removeInstanceProxiesBatch: {
                input: typeof InstanceRemoveProxiesBatchRequestSchema;
                methodKind: "unary";
                output: typeof InstanceRemoveProxiesBatchResponseSchema;
            };
            removeInstanceProxy: {
                input: typeof InstanceRemoveProxyRequestSchema;
                methodKind: "unary";
                output: typeof InstanceRemoveProxyResponseSchema;
            };
            setAccountMetadataEntry: {
                input: typeof SetAccountMetadataEntryRequestSchema;
                methodKind: "unary";
                output: typeof SetAccountMetadataEntryResponseSchema;
            };
            setInstanceMetadataEntry: {
                input: typeof SetInstanceMetadataEntryRequestSchema;
                methodKind: "unary";
                output: typeof SetInstanceMetadataEntryResponseSchema;
            };
            updateInstanceAccount: {
                input: typeof InstanceUpdateAccountRequestSchema;
                methodKind: "unary";
                output: typeof InstanceUpdateAccountResponseSchema;
            };
            updateInstanceConfig: {
                input: typeof InstanceUpdateConfigRequestSchema;
                methodKind: "unary";
                output: typeof InstanceUpdateConfigResponseSchema;
            };
            updateInstanceConfigEntry: {
                input: typeof InstanceUpdateConfigEntryRequestSchema;
                methodKind: "unary";
                output: typeof InstanceUpdateConfigEntryResponseSchema;
            };
            updateInstanceMeta: {
                input: typeof InstanceUpdateMetaRequestSchema;
                methodKind: "unary";
                output: typeof InstanceUpdateMetaResponseSchema;
            };
            updateInstanceProxy: {
                input: typeof InstanceUpdateProxyRequestSchema;
                methodKind: "unary";
                output: typeof InstanceUpdateProxyResponseSchema;
            };
        },
    > = ...

    Service for managing SoulFire instances. An instance is a permission and configuration compartment for independently controlled Minecraft bots, settings, accounts, proxies, and remote clients.

    All operations require appropriate permissions:

    • CREATE_INSTANCE (global): Required to create new instances
    • READ_INSTANCE: Required to list and view instance details
    • UPDATE_INSTANCE_META: Required to change instance name/icon
    • UPDATE_INSTANCE_CONFIG: Required to modify settings, accounts, and proxies
    • DELETE_INSTANCE: Required to delete an instance
    • READ_INSTANCE_AUDIT_LOGS: Required to view audit logs
    • READ_BOT_INFO: Required to read account metadata

    from service soulfire.v1.InstanceService