/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AssignTenantPhoneNumberRequest, ConfigureTenantSsoRequest, CreateTenantRequestBody, CreateTenantUploadRequestBody, PurchaseTenantPhoneNumberRequest, TenantSchema, TenantSsoSchema, TenantUploadSchema, TenantsSchema, UnassignTenantPhoneNumberRequest, UpdateTenantRequestBody, UpdateTenantSsoRequest } from '../models/index'; export interface AssignTenantPhoneNumberOperationRequest { tenantId: string; assignTenantPhoneNumberRequest: AssignTenantPhoneNumberRequest; } export interface ConfigureTenantSsoOperationRequest { tenantId: string; configureTenantSsoRequest: ConfigureTenantSsoRequest; } export interface CreateTenantRequest { createTenantRequestBody: CreateTenantRequestBody; } export interface CreateTenantUploadRequest { tenantId: string; createTenantUploadRequestBody: CreateTenantUploadRequestBody; } export interface DeleteTenantRequest { tenantId: string; permanentDelete?: DeleteTenantPermanentDeleteEnum; } export interface DeleteTenantSsoRequest { tenantId: string; } export interface ListTenantsRequest { filterStatus?: ListTenantsFilterStatusEnum; filterEmail?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; countBy?: string; } export interface PurchaseTenantPhoneNumberOperationRequest { tenantId: string; purchaseTenantPhoneNumberRequest: PurchaseTenantPhoneNumberRequest; } export interface ReleaseTenantPhoneNumberRequest { tenantId: string; } export interface SearchTenantPhoneNumbersRequest { tenantId: string; country?: string; areaCode?: string; contains?: string; } export interface ShowTenantRequest { tenantId: string; include?: string; } export interface ShowTenantSsoRequest { tenantId: string; } export interface TenantOptionsRequest { tenantId: string; } export interface TenantPhoneNumbersAssignOptionsRequest { tenantId: string; } export interface TenantPhoneNumbersOptionsRequest { tenantId: string; } export interface TenantPhoneNumbersSearchOptionsRequest { tenantId: string; } export interface TenantPhoneNumbersUnassignOptionsRequest { tenantId: string; } export interface TenantSsoOptionsRequest { tenantId: string; } export interface TenantUploadsOptionsRequest { tenantId: string; } export interface UnassignTenantPhoneNumberOperationRequest { tenantId: string; unassignTenantPhoneNumberRequest?: UnassignTenantPhoneNumberRequest; } export interface UpdateTenantRequest { tenantId: string; updateTenantRequestBody: UpdateTenantRequestBody; } export interface UpdateTenantSsoOperationRequest { tenantId: string; updateTenantSsoRequest: UpdateTenantSsoRequest; } /** * */ export declare class TenantsApi extends runtime.BaseAPI { /** * Creates request options for assignTenantPhoneNumber without sending the request */ assignTenantPhoneNumberRequestOpts(requestParameters: AssignTenantPhoneNumberOperationRequest): Promise; /** * Attach an EXISTING phone number to the tenant without purchasing. Owner/sysowner only. provider `twilio` (default): the number must already exist on the platform Twilio account - it is verified there, voice/SMS webhooks are configured, the registry claim is taken and the virtual employee\'s user row is stamped. provider `telnyx`: the number must already exist on the platform Telnyx account - it is verified there, attached to this environment\'s TeXML application, claimed and stamped. provider `external`: a number hosted at an unintegrated provider - stored, claimed and stamped only; inbound stays inactive. A capability snapshot ({voice,sms,mms} booleans) is stamped next to the number - read from the provider for twilio/telnyx (any client-sent value is ignored), taken from the request `capabilities` for external (undeclared default false). `slot` picks the channel slot: `calling` (default) = the voice identity number (settings.calling, stamped onto the virtual employee); `messaging` = optional dedicated SMS number (settings.messaging, normalized keys phoneNumber/provider/ capabilities, no virtual-employee stamp) - outbound SMS then prefers it over the calling number. The messaging slot requires SMS capability (400 otherwise). Each slot holds at most one number, independently. Fails with 400 when the number is unknown to the provider, already claimed by another tenant, or the slot already has a number. * Assign Existing Phone Number */ assignTenantPhoneNumberRaw(requestParameters: AssignTenantPhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Attach an EXISTING phone number to the tenant without purchasing. Owner/sysowner only. provider `twilio` (default): the number must already exist on the platform Twilio account - it is verified there, voice/SMS webhooks are configured, the registry claim is taken and the virtual employee\'s user row is stamped. provider `telnyx`: the number must already exist on the platform Telnyx account - it is verified there, attached to this environment\'s TeXML application, claimed and stamped. provider `external`: a number hosted at an unintegrated provider - stored, claimed and stamped only; inbound stays inactive. A capability snapshot ({voice,sms,mms} booleans) is stamped next to the number - read from the provider for twilio/telnyx (any client-sent value is ignored), taken from the request `capabilities` for external (undeclared default false). `slot` picks the channel slot: `calling` (default) = the voice identity number (settings.calling, stamped onto the virtual employee); `messaging` = optional dedicated SMS number (settings.messaging, normalized keys phoneNumber/provider/ capabilities, no virtual-employee stamp) - outbound SMS then prefers it over the calling number. The messaging slot requires SMS capability (400 otherwise). Each slot holds at most one number, independently. Fails with 400 when the number is unknown to the provider, already claimed by another tenant, or the slot already has a number. * Assign Existing Phone Number */ assignTenantPhoneNumber(requestParameters: AssignTenantPhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for configureTenantSso without sending the request */ configureTenantSsoRequestOpts(requestParameters: ConfigureTenantSsoOperationRequest): Promise; /** * Write the tenant\'s enterprise SSO configuration. SYSOWNER only, checked in the handler - `domains` decides whose employees may sign in as this tenant, and phase 1 has no DNS proof of ownership (a human confirms it with the customer\'s IT during onboarding), so the customer\'s own owner cannot reach this door. Idempotent: re-posting reconciles the global domain claims (claims what is new, releases what was dropped) and overwrites the block. A domain already claimed by another tenant is rejected with 400. Two fields are NOT client-writable and are ignored if sent: `idpName` is derived server-side as `ms-{shortCode}` (the name is what lets the auth triggers resolve the tenant without scanning, so its shape is an invariant, and it must fit Cognito\'s 32-character limit), and `enabled` is owned by the IdP provisioning step - it means \"a Cognito identity provider exists for this tenant\", which this door cannot make true. Note this door does NOT create the Cognito identity provider. Until it exists no token can be minted for this configuration. * Configure Tenant Enterprise SSO */ configureTenantSsoRaw(requestParameters: ConfigureTenantSsoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Write the tenant\'s enterprise SSO configuration. SYSOWNER only, checked in the handler - `domains` decides whose employees may sign in as this tenant, and phase 1 has no DNS proof of ownership (a human confirms it with the customer\'s IT during onboarding), so the customer\'s own owner cannot reach this door. Idempotent: re-posting reconciles the global domain claims (claims what is new, releases what was dropped) and overwrites the block. A domain already claimed by another tenant is rejected with 400. Two fields are NOT client-writable and are ignored if sent: `idpName` is derived server-side as `ms-{shortCode}` (the name is what lets the auth triggers resolve the tenant without scanning, so its shape is an invariant, and it must fit Cognito\'s 32-character limit), and `enabled` is owned by the IdP provisioning step - it means \"a Cognito identity provider exists for this tenant\", which this door cannot make true. Note this door does NOT create the Cognito identity provider. Until it exists no token can be minted for this configuration. * Configure Tenant Enterprise SSO */ configureTenantSso(requestParameters: ConfigureTenantSsoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createTenant without sending the request */ createTenantRequestOpts(requestParameters: CreateTenantRequest): Promise; /** * Creates a new tenant in your account. ### Tenant\'s Attributes Here is a table that describes the attributes of the tenant object: | Attribute | Type | Description | |---------------------------|---------|------------------------------------------------------------------------------| | `name` | string | The full name of the tenant. Must be 5-255 characters. | | `email` | string | The primary email address of the tenant. Must be a valid email format. | | `plan` | string | The subscription plan or tier of the tenant. | | `username` | string | The username associated with the tenant account. | | `address` | string | The physical or mailing address of the tenant. | | `phone` | string | The contact phone number for the tenant. | | `shortCode` | string | A unique short identifier for the tenant. | | `trialExpiryDate` | string | The date and time when the tenant\'s trial period expires (ISO 8601 format). | | `status` | string | The current status of the tenant (active or archived). | | `timestamps.created` | string | The date and time when the tenant was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the tenant was last modified (ISO 8601 format). | ## Notes 1. Required Fields: - `name` - `email` - `plan` 2. Date-Time Format: - All date-time fields follow ISO 8601 format (e.g., \"2024-01-20T12:00:00Z\") 3. Status Values: - Only \"active\" and \"archived\" are valid external status values - Status transitions must be explicitly managed 4. Validation: - Name must be 5-255 characters and match the specified pattern - Email must be a valid email format and 5-255 characters - Plan must be at least 1 character and no more than 255 characters * Create Tenant */ createTenantRaw(requestParameters: CreateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new tenant in your account. ### Tenant\'s Attributes Here is a table that describes the attributes of the tenant object: | Attribute | Type | Description | |---------------------------|---------|------------------------------------------------------------------------------| | `name` | string | The full name of the tenant. Must be 5-255 characters. | | `email` | string | The primary email address of the tenant. Must be a valid email format. | | `plan` | string | The subscription plan or tier of the tenant. | | `username` | string | The username associated with the tenant account. | | `address` | string | The physical or mailing address of the tenant. | | `phone` | string | The contact phone number for the tenant. | | `shortCode` | string | A unique short identifier for the tenant. | | `trialExpiryDate` | string | The date and time when the tenant\'s trial period expires (ISO 8601 format). | | `status` | string | The current status of the tenant (active or archived). | | `timestamps.created` | string | The date and time when the tenant was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the tenant was last modified (ISO 8601 format). | ## Notes 1. Required Fields: - `name` - `email` - `plan` 2. Date-Time Format: - All date-time fields follow ISO 8601 format (e.g., \"2024-01-20T12:00:00Z\") 3. Status Values: - Only \"active\" and \"archived\" are valid external status values - Status transitions must be explicitly managed 4. Validation: - Name must be 5-255 characters and match the specified pattern - Email must be a valid email format and 5-255 characters - Plan must be at least 1 character and no more than 255 characters * Create Tenant */ createTenant(requestParameters: CreateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createTenantUpload without sending the request */ createTenantUploadRequestOpts(requestParameters: CreateTenantUploadRequest): Promise; /** * Generates a presigned URL for uploading a tenant asset (logo, background, favicon) directly to S3. * Create Tenant Upload */ createTenantUploadRaw(requestParameters: CreateTenantUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Generates a presigned URL for uploading a tenant asset (logo, background, favicon) directly to S3. * Create Tenant Upload */ createTenantUpload(requestParameters: CreateTenantUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteTenant without sending the request */ deleteTenantRequestOpts(requestParameters: DeleteTenantRequest): Promise; /** * Two-phase deletion. Default (soft delete): archives the tenant (`status -> archived`), stamps `archivedAt`, and freezes all of its activity (automations, API keys, user logins). Reversible via `PATCH` with `attributes.status = \"active\"` within the retention window; after the window the tenant is automatically and permanently purged. Permanent delete (`?permanentDelete=true`): flips the tenant to `status = purging` and immediately, irreversibly destroys every trace of it (all data, users, files and secrets). Cannot be undone. The system tenant can never be deleted. * Delete Tenant */ deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Two-phase deletion. Default (soft delete): archives the tenant (`status -> archived`), stamps `archivedAt`, and freezes all of its activity (automations, API keys, user logins). Reversible via `PATCH` with `attributes.status = \"active\"` within the retention window; after the window the tenant is automatically and permanently purged. Permanent delete (`?permanentDelete=true`): flips the tenant to `status = purging` and immediately, irreversibly destroys every trace of it (all data, users, files and secrets). Cannot be undone. The system tenant can never be deleted. * Delete Tenant */ deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteTenantSso without sending the request */ deleteTenantSsoRequestOpts(requestParameters: DeleteTenantSsoRequest): Promise; /** * Remove the tenant\'s enterprise SSO configuration and release its domain claims, freeing them for another tenant. SYSOWNER only. Does NOT delete the Cognito identity provider - that rides the provisioning step, which the offboarding purge must also call, or a recycled shortCode could inherit the previous customer\'s IdP. * Delete Tenant Enterprise SSO */ deleteTenantSsoRaw(requestParameters: DeleteTenantSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove the tenant\'s enterprise SSO configuration and release its domain claims, freeing them for another tenant. SYSOWNER only. Does NOT delete the Cognito identity provider - that rides the provisioning step, which the offboarding purge must also call, or a recycled shortCode could inherit the previous customer\'s IdP. * Delete Tenant Enterprise SSO */ deleteTenantSso(requestParameters: DeleteTenantSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listTenants without sending the request */ listTenantsRequestOpts(requestParameters: ListTenantsRequest): Promise; /** * Returns a collection of your account tenants ## Overview Returns a collection of your account tenants, sorted by the time they were inserted into the system in ascending order. ### Tenants Endpoints Pagination The tenants endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Tenants */ listTenantsRaw(requestParameters: ListTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account tenants ## Overview Returns a collection of your account tenants, sorted by the time they were inserted into the system in ascending order. ### Tenants Endpoints Pagination The tenants endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Tenants */ listTenants(requestParameters?: ListTenantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for purchaseTenantPhoneNumber without sending the request */ purchaseTenantPhoneNumberRequestOpts(requestParameters: PurchaseTenantPhoneNumberOperationRequest): Promise; /** * Purchase a Twilio phone number for the tenant. TEMPORARILY DISABLED (returns 503) while Twilio has no purchasable PL inventory - use assignTenantPhoneNumber for existing numbers; contact help@smartytalent.com. * Purchase Phone Number */ purchaseTenantPhoneNumberRaw(requestParameters: PurchaseTenantPhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Purchase a Twilio phone number for the tenant. TEMPORARILY DISABLED (returns 503) while Twilio has no purchasable PL inventory - use assignTenantPhoneNumber for existing numbers; contact help@smartytalent.com. * Purchase Phone Number */ purchaseTenantPhoneNumber(requestParameters: PurchaseTenantPhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for releaseTenantPhoneNumber without sending the request */ releaseTenantPhoneNumberRequestOpts(requestParameters: ReleaseTenantPhoneNumberRequest): Promise; /** * Release the tenant\'s Twilio phone number. TEMPORARILY DISABLED (returns 503): released PL numbers cannot be re-purchased, so release is blocked platform-wide; contact help@smartytalent.com. * Release Phone Number */ releaseTenantPhoneNumberRaw(requestParameters: ReleaseTenantPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Release the tenant\'s Twilio phone number. TEMPORARILY DISABLED (returns 503): released PL numbers cannot be re-purchased, so release is blocked platform-wide; contact help@smartytalent.com. * Release Phone Number */ releaseTenantPhoneNumber(requestParameters: ReleaseTenantPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for searchTenantPhoneNumbers without sending the request */ searchTenantPhoneNumbersRequestOpts(requestParameters: SearchTenantPhoneNumbersRequest): Promise; /** * Search for available Twilio phone numbers. TEMPORARILY DISABLED (returns 503) together with purchase while Twilio has no purchasable PL inventory - use assignTenantPhoneNumber for existing numbers; contact help@smartytalent.com. * Search Available Phone Numbers */ searchTenantPhoneNumbersRaw(requestParameters: SearchTenantPhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Search for available Twilio phone numbers. TEMPORARILY DISABLED (returns 503) together with purchase while Twilio has no purchasable PL inventory - use assignTenantPhoneNumber for existing numbers; contact help@smartytalent.com. * Search Available Phone Numbers */ searchTenantPhoneNumbers(requestParameters: SearchTenantPhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showTenant without sending the request */ showTenantRequestOpts(requestParameters: ShowTenantRequest): Promise; /** * This endpoint retrieves details of a specific tenant from your account. You can view information such as name, and other relevant attributes of the tenant. * Show Tenant */ showTenantRaw(requestParameters: ShowTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific tenant from your account. You can view information such as name, and other relevant attributes of the tenant. * Show Tenant */ showTenant(requestParameters: ShowTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showTenantSso without sending the request */ showTenantSsoRequestOpts(requestParameters: ShowTenantSsoRequest): Promise; /** * Read the tenant\'s enterprise SSO configuration. SYSOWNER only - the role is checked in the handler, because the authorizer policy allows GET on tenant sub-resources far more widely. Returns 404 when SSO has never been configured for this tenant. * Show Tenant Enterprise SSO */ showTenantSsoRaw(requestParameters: ShowTenantSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Read the tenant\'s enterprise SSO configuration. SYSOWNER only - the role is checked in the handler, because the authorizer policy allows GET on tenant sub-resources far more widely. Returns 404 when SSO has never been configured for this tenant. * Show Tenant Enterprise SSO */ showTenantSso(requestParameters: ShowTenantSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantOptions without sending the request */ tenantOptionsRequestOpts(requestParameters: TenantOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Tenant Options */ tenantOptionsRaw(requestParameters: TenantOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Tenant Options */ tenantOptions(requestParameters: TenantOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantPhoneNumbersAssignOptions without sending the request */ tenantPhoneNumbersAssignOptionsRequestOpts(requestParameters: TenantPhoneNumbersAssignOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Assign Phone Number Options */ tenantPhoneNumbersAssignOptionsRaw(requestParameters: TenantPhoneNumbersAssignOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Assign Phone Number Options */ tenantPhoneNumbersAssignOptions(requestParameters: TenantPhoneNumbersAssignOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantPhoneNumbersOptions without sending the request */ tenantPhoneNumbersOptionsRequestOpts(requestParameters: TenantPhoneNumbersOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Phone Numbers Options */ tenantPhoneNumbersOptionsRaw(requestParameters: TenantPhoneNumbersOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Phone Numbers Options */ tenantPhoneNumbersOptions(requestParameters: TenantPhoneNumbersOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantPhoneNumbersSearchOptions without sending the request */ tenantPhoneNumbersSearchOptionsRequestOpts(requestParameters: TenantPhoneNumbersSearchOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Phone Numbers Search Options */ tenantPhoneNumbersSearchOptionsRaw(requestParameters: TenantPhoneNumbersSearchOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Phone Numbers Search Options */ tenantPhoneNumbersSearchOptions(requestParameters: TenantPhoneNumbersSearchOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantPhoneNumbersUnassignOptions without sending the request */ tenantPhoneNumbersUnassignOptionsRequestOpts(requestParameters: TenantPhoneNumbersUnassignOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Unassign Phone Number Options */ tenantPhoneNumbersUnassignOptionsRaw(requestParameters: TenantPhoneNumbersUnassignOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Unassign Phone Number Options */ tenantPhoneNumbersUnassignOptions(requestParameters: TenantPhoneNumbersUnassignOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantSsoOptions without sending the request */ tenantSsoOptionsRequestOpts(requestParameters: TenantSsoOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Tenant SSO Options */ tenantSsoOptionsRaw(requestParameters: TenantSsoOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Tenant SSO Options */ tenantSsoOptions(requestParameters: TenantSsoOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantUploadsOptions without sending the request */ tenantUploadsOptionsRequestOpts(requestParameters: TenantUploadsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Tenant Uploads Options */ tenantUploadsOptionsRaw(requestParameters: TenantUploadsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Tenant Uploads Options */ tenantUploadsOptions(requestParameters: TenantUploadsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for tenantsOptions without sending the request */ tenantsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Tenants Options */ tenantsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Tenants Options */ tenantsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for unassignTenantPhoneNumber without sending the request */ unassignTenantPhoneNumberRequestOpts(requestParameters: UnassignTenantPhoneNumberOperationRequest): Promise; /** * Detach the tenant\'s phone number IN-SYSTEM ONLY. Owner/sysowner only. Makes no provider API calls: a Twilio number stays on the platform account with its webhooks untouched (webhooks are repointed manually in the Twilio console when the number moves). The optional body selects the slot: `calling` (default, also when no body is sent) = clears the tenant\'s calling settings, releases the registry claim and clears the virtual employee\'s phone; `messaging` = removes settings.messaging and releases that number\'s claim, the virtual employee\'s phone is untouched. Works for all providers and is fully reversible via assignTenantPhoneNumber. Not subject to the release kill-switch - unlike DELETE /phone-numbers, nothing is lost at the provider. Fails with 400 when the slot has no number provisioned. * Unassign Phone Number */ unassignTenantPhoneNumberRaw(requestParameters: UnassignTenantPhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Detach the tenant\'s phone number IN-SYSTEM ONLY. Owner/sysowner only. Makes no provider API calls: a Twilio number stays on the platform account with its webhooks untouched (webhooks are repointed manually in the Twilio console when the number moves). The optional body selects the slot: `calling` (default, also when no body is sent) = clears the tenant\'s calling settings, releases the registry claim and clears the virtual employee\'s phone; `messaging` = removes settings.messaging and releases that number\'s claim, the virtual employee\'s phone is untouched. Works for all providers and is fully reversible via assignTenantPhoneNumber. Not subject to the release kill-switch - unlike DELETE /phone-numbers, nothing is lost at the provider. Fails with 400 when the slot has no number provisioned. * Unassign Phone Number */ unassignTenantPhoneNumber(requestParameters: UnassignTenantPhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateTenant without sending the request */ updateTenantRequestOpts(requestParameters: UpdateTenantRequest): Promise; /** * This endpoint allows you to update details of a specific tenant in your account. You can modify information such as name, and other relevant attributes of the tenant. Only the fields provided in the request will be updated. * Update Tenant */ updateTenantRaw(requestParameters: UpdateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific tenant in your account. You can modify information such as name, and other relevant attributes of the tenant. Only the fields provided in the request will be updated. * Update Tenant */ updateTenant(requestParameters: UpdateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateTenantSso without sending the request */ updateTenantSsoRequestOpts(requestParameters: UpdateTenantSsoOperationRequest): Promise; /** * Change the POLICY that sits on top of an existing SSO connection. OWNER or SYSOWNER - deliberately unlike the POST beside it, which stays sysowner-only. The split follows what each field can reach. `required`, `autoApprove` and `defaultRole` affect nothing outside this tenant, and every comparable product (Slack, GitHub, Google Workspace) lets the customer\'s own owner set them. `domains` is different: a domain claim is global, one domain belongs to one tenant, and phase 1 proves ownership by a human at our end confirming it - so until DNS-TXT verification exists, that field cannot be reachable by the customer. `entraTenantId` and `idpName` identify the connection itself and are ours for the same reason. This is also the door that matters when the customer\'s IdP breaks: the owner keeps their password (the break-glass exemption) AND can lift the requirement themselves, instead of having to call us. Switching `required` from false to true signs every one of the tenant\'s accounts out - see `sessionsRevoked`. Only on the transition: repeating the same value is a no-op, so a retry cannot sign the company out twice. Any field not sent keeps its stored value; sending only `required` is the normal case. 404 when SSO has never been configured - there is no policy to change without a connection to put it on. * Update Tenant Enterprise SSO Policy */ updateTenantSsoRaw(requestParameters: UpdateTenantSsoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Change the POLICY that sits on top of an existing SSO connection. OWNER or SYSOWNER - deliberately unlike the POST beside it, which stays sysowner-only. The split follows what each field can reach. `required`, `autoApprove` and `defaultRole` affect nothing outside this tenant, and every comparable product (Slack, GitHub, Google Workspace) lets the customer\'s own owner set them. `domains` is different: a domain claim is global, one domain belongs to one tenant, and phase 1 proves ownership by a human at our end confirming it - so until DNS-TXT verification exists, that field cannot be reachable by the customer. `entraTenantId` and `idpName` identify the connection itself and are ours for the same reason. This is also the door that matters when the customer\'s IdP breaks: the owner keeps their password (the break-glass exemption) AND can lift the requirement themselves, instead of having to call us. Switching `required` from false to true signs every one of the tenant\'s accounts out - see `sessionsRevoked`. Only on the transition: repeating the same value is a no-op, so a retry cannot sign the company out twice. Any field not sent keeps its stored value; sending only `required` is the normal case. 404 when SSO has never been configured - there is no policy to change without a connection to put it on. * Update Tenant Enterprise SSO Policy */ updateTenantSso(requestParameters: UpdateTenantSsoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const DeleteTenantPermanentDeleteEnum: { readonly True: "true"; readonly False: "false"; }; export type DeleteTenantPermanentDeleteEnum = typeof DeleteTenantPermanentDeleteEnum[keyof typeof DeleteTenantPermanentDeleteEnum]; /** * @export */ export declare const ListTenantsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListTenantsFilterStatusEnum = typeof ListTenantsFilterStatusEnum[keyof typeof ListTenantsFilterStatusEnum]; //# sourceMappingURL=TenantsApi.d.ts.map