import { SdPlatformChargebeeAddon, SdPlatformChargebeeCustomer, SdPlatformChargebeePlan, SdPlatformChargebeeSubscription } from "../commons/SdPlatformChargebee"; import { SdPlatformPolicyCommonAliasesOrganization, SdPlatformPolicyPermissionsOrganization } from "../commons/SdPlatformPolicyCommons"; import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibility"; import { SdPlatformResponseBackendSystem } from "./SdPlatformResponseBackendSystem"; import { SdPlatformResponseDomain } from "./SdPlatformResponseDomain"; import { SdPlatformResponseFeatures } from "./SdPlatformResponseFeatures"; import { SdPlatformResponsePolicyPermissions } from "./SdPlatformResponsePolicy"; import { SdPlatformUsedCredits } from "../commons/SdPlatformUsedCredits"; import { SdPlatformOrganizationMemberRole } from "../commons/SdPlatformOrganizationCommons"; /** * Organization - public access level */ export interface SdPlatformResponseOrganizationPublic extends SdPlatformResponsePolicyPermissions { /** * Unique id of the organization. */ readonly id: string; /** * Name of the organization. */ readonly name: string; /** * URL-compatible short name of the organization. Used for links to the organizations's profile on the ShapeDiver Platform. */ readonly slug: string; /** * URL to the organization's avatar. */ readonly avatar_url?: string; /** * Website of organization. */ readonly website?: string; /** * Description of organization. */ readonly description?: string; /** * Features which the organization has access to. */ readonly features?: SdPlatformResponseFeatures; /** * List of query parameters which should always be added before opening Apps. */ readonly app_builder_url_params?: { [key: string]: string; }; /** * App mode of the organization. */ readonly appmode?: boolean; } /** * Organization - organization member access level. */ export interface SdPlatformResponseOrganizationMember extends SdPlatformResponseOrganizationPublic { /** * Accessdomains of the organization. */ readonly accessdomains?: Array; /** * Visibility of the organization. This limits the visibility of organization members and their models. */ readonly visibility: SdPlatformOrganizationVisibility; /** * Should sharing be allowed for organization members? */ readonly allow_sharing: boolean; /** * Should private link sharing be allowed for organization members? */ readonly allow_link_sharing: boolean; /** * Should organization members be allowed to expose their email address? */ readonly allow_expose_email: boolean; /** * Geometry backend system of the organization. */ readonly backend_system?: SdPlatformResponseBackendSystem; /** * Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the organization? */ readonly force_require_token: boolean; /** * Should credit consumption be limited once the monthly quota has been reached? */ readonly limit_credit_consumption: boolean; /** * OpenID provider linked with the organization */ readonly openid_provider?: string; /** * The primary domain of organization. */ readonly domain?: string; /** * The domains of organization. */ readonly domains?: { id: string; name: string; }[]; /** * The chargebee subscription of the organization. */ readonly chargebee_subscription?: SdPlatformChargebeeSubscription; /** * Path to the custom app builder. */ readonly app_builder_slug?: string; /** * Default team for new users. */ readonly default_team?: string; /** * Limit model visibility per team (applies to Consumer and User roles) */ readonly filter_by_team?: boolean; /** * Limit for excess credits */ readonly max_excess_credits?: number; /** * Credit limit exceeded flag */ readonly credit_limit_exceeded?: boolean; /** * Summarized information about consumed credits */ readonly used_credits?: SdPlatformUsedCredits; /** * The minimum role required for member's backend system change */ readonly backend_system_change_minimum_role?: SdPlatformOrganizationMemberRole; /** * The subscription status of the organization. */ readonly subscription_status?: string; /** * The subscription name of the organization. */ readonly subscription_name?: string; } /** * Organization - organization administrator access level. */ export interface SdPlatformResponseOrganizationAdministrator extends SdPlatformResponseOrganizationMember { /** * Features which the organization has access to */ readonly created_at: number; /** * Features which the organization has access to. */ readonly updated_at: number; } /** * Organization - organization owner access level. */ export interface SdPlatformResponseOrganizationOwner extends SdPlatformResponseOrganizationAdministrator { /** * Status of the organization, one of "created" or "confirmed" */ readonly status?: string; readonly chargebee_customer?: SdPlatformChargebeeCustomer; readonly chargebee_plan?: SdPlatformChargebeePlan; readonly chargbee_addons?: Array; } /** * Organization - admin access level. */ export interface SdPlatformResponseOrganizationAdmin extends SdPlatformResponseOrganizationOwner { /** * Epoch timestamp of deletion. */ readonly deleted_at?: number; /** * Id of backend system {@link SdPlatformRequestBackendSystemToken} */ readonly backend_system_id?: string; /** * Chargebee customer id. */ readonly chargebee_customer_id?: string; } /** * Holds name of single sign on provider. */ export interface SdPlatformResponseIdentifySSO { /** * The name of a open id provider. */ readonly openid_provider_name: string; } /** * Organization - any access level */ export type SdPlatformResponseOrganizationAny = SdPlatformResponseOrganizationAdmin | SdPlatformResponseOrganizationOwner | SdPlatformResponseOrganizationAdministrator | SdPlatformResponseOrganizationMember | SdPlatformResponseOrganizationPublic; export type SdPlatformResponseOrganizationToken = { access_token: string; backend_system: SdPlatformResponseBackendSystem; }; //# sourceMappingURL=SdPlatformResponseOrganization.d.ts.map