@snokam/platform-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator-ignore +23 -0
- package/README.md +423 -0
- package/dist/apis/PlatformClient.d.ts +2194 -0
- package/dist/apis/PlatformClient.js +5902 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +19 -0
- package/dist/esm/apis/PlatformClient.d.ts +2194 -0
- package/dist/esm/apis/PlatformClient.js +5898 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +3 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/index.d.ts +6691 -0
- package/dist/esm/models/index.js +336 -0
- package/dist/esm/runtime.d.ts +181 -0
- package/dist/esm/runtime.js +342 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/index.d.ts +6691 -0
- package/dist/models/index.js +339 -0
- package/dist/runtime.d.ts +181 -0
- package/dist/runtime.js +357 -0
- package/docs/AccessSubject.md +17 -0
- package/docs/ActivateRequest.md +15 -0
- package/docs/ActivateResult.md +16 -0
- package/docs/AddCustomDomainRequest.md +16 -0
- package/docs/ApiTokenSummary.md +20 -0
- package/docs/ApiTokenVerifyResult.md +16 -0
- package/docs/AppCatalogEntry.md +18 -0
- package/docs/AppModule.md +20 -0
- package/docs/ApproveDeviceRequest.md +15 -0
- package/docs/BillingPaymentMethod.md +16 -0
- package/docs/BillingSessionRequest.md +14 -0
- package/docs/BillingSessionResponse.md +14 -0
- package/docs/BridgeWebhookResult.md +18 -0
- package/docs/Business.md +65 -0
- package/docs/BusinessAccess.md +15 -0
- package/docs/BusinessConfig.md +18 -0
- package/docs/BusinessHealth.md +17 -0
- package/docs/BusinessMeterUsage.md +18 -0
- package/docs/BusinessOwner.md +16 -0
- package/docs/BusinessUsageRollup.md +23 -0
- package/docs/Capability.md +17 -0
- package/docs/CommissionTierReference.md +16 -0
- package/docs/ComponentBlocksInnerOneOfChildrenInner.md +17 -0
- package/docs/ComponentBlocksInnerOneOfMarkDefsInner.md +16 -0
- package/docs/CreateApiTokenRequest.md +15 -0
- package/docs/CreateUserRequest.md +20 -0
- package/docs/CreatedApiToken.md +21 -0
- package/docs/CredentialSummary.md +21 -0
- package/docs/CustomDomain.md +18 -0
- package/docs/CustomDomainProvisioning.md +15 -0
- package/docs/DevicePairRequestBody.md +14 -0
- package/docs/DevicePairing.md +17 -0
- package/docs/DevicePairingStatus.md +17 -0
- package/docs/DevicePollRequestBody.md +15 -0
- package/docs/DeviceScreen.md +20 -0
- package/docs/DirectoryAppRoleItem.md +15 -0
- package/docs/DirectoryGroupItem.md +15 -0
- package/docs/DirectoryGroupsResponse.md +14 -0
- package/docs/DirectoryLicenseItem.md +16 -0
- package/docs/DirectoryLicensesResponse.md +14 -0
- package/docs/DirectoryMailbox.md +15 -0
- package/docs/DirectoryServicePrincipalItem.md +16 -0
- package/docs/DirectoryServicePrincipalsResponse.md +14 -0
- package/docs/DnsRecord.md +16 -0
- package/docs/EmployeeReference.md +16 -0
- package/docs/EmployeeSettings.md +14 -0
- package/docs/EmployeeSystemAccess.md +24 -0
- package/docs/EmployeeSystemConfig.md +18 -0
- package/docs/Entitlements.md +23 -0
- package/docs/FacebookAccount.md +17 -0
- package/docs/GitHubRepo.md +18 -0
- package/docs/GoogleAnalyticsProperty.md +16 -0
- package/docs/GoogleAnalyticsSelection.md +14 -0
- package/docs/ImpersonationHistoryEntry.md +25 -0
- package/docs/IntegrationCheckResult.md +18 -0
- package/docs/IntegrationHealthStatus.md +16 -0
- package/docs/IntegrationSecret.md +16 -0
- package/docs/IntegrationSetting.md +17 -0
- package/docs/IntegrationSummary.md +29 -0
- package/docs/InviteCredentialRequest.md +15 -0
- package/docs/InvoiceBasis.md +20 -0
- package/docs/InvoiceBasisLine.md +18 -0
- package/docs/LoginConfig.md +21 -0
- package/docs/MeApp.md +15 -0
- package/docs/MeterEnforcementDecision.md +19 -0
- package/docs/MeterEntitlement.md +22 -0
- package/docs/ModelReconciliation.md +24 -0
- package/docs/OAuthAccessTokenResponse.md +16 -0
- package/docs/OAuthStartResponse.md +14 -0
- package/docs/OlafApiKeyResponse.md +14 -0
- package/docs/OlafTeamsSettings.md +14 -0
- package/docs/OnboardBusinessRequest.md +27 -0
- package/docs/OnboardingConfig.md +18 -0
- package/docs/OnboardingStatus.md +19 -0
- package/docs/OnboardingStep.md +15 -0
- package/docs/PageEmployeeOrderInner.md +17 -0
- package/docs/PageEquipmentInner.md +17 -0
- package/docs/PasswordLoginRequest.md +17 -0
- package/docs/PasswordLoginResult.md +20 -0
- package/docs/PatchBusinessRequest.md +26 -0
- package/docs/PatchEmployee.md +58 -0
- package/docs/PendingDevicePreview.md +17 -0
- package/docs/PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfig.md +14 -0
- package/docs/PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSettings.md +14 -0
- package/docs/PlanFeature.md +16 -0
- package/docs/PlanInfo.md +21 -0
- package/docs/PlanMeter.md +24 -0
- package/docs/PlatformClient.md +9321 -0
- package/docs/PlatformIntegration.md +21 -0
- package/docs/PlatformSanityConfig.md +17 -0
- package/docs/PlatformSecretField.md +16 -0
- package/docs/PlatformSecretStatus.md +16 -0
- package/docs/PowerOfficeConnectResponse.md +14 -0
- package/docs/PowerOfficeProduct.md +15 -0
- package/docs/PowerOfficeProductsResponse.md +15 -0
- package/docs/PowerOfficeProject.md +15 -0
- package/docs/PowerOfficeProjectsResponse.md +15 -0
- package/docs/ProtectedEmployee.md +63 -0
- package/docs/ProvisioningEvent.md +17 -0
- package/docs/RecordImpersonationActivityRequest.md +18 -0
- package/docs/RenameDeviceRequest.md +14 -0
- package/docs/ResetConfirmRequest.md +16 -0
- package/docs/ResetRequest.md +15 -0
- package/docs/RevokeRequest.md +14 -0
- package/docs/RollupMeterTotal.md +18 -0
- package/docs/SanityCreateEmployeeCliftonStrengthsInner.md +17 -0
- package/docs/SanityCreateEmployeeGroupsInner.md +17 -0
- package/docs/SanityCreateEmployeeTagsInner.md +17 -0
- package/docs/SanityCreateEmployeeTechnologiesInner.md +17 -0
- package/docs/SanityEmployeeCliftonStrengthsInner.md +20 -0
- package/docs/SanityEmployeeCommissionTier.md +20 -0
- package/docs/SanityEmployeeEquipmentInner.md +19 -0
- package/docs/SanityEmployeeGroupsInner.md +24 -0
- package/docs/SanityEmployeeManager.md +23 -0
- package/docs/SanityEmployeeNextOfKinInner.md +17 -0
- package/docs/SanityEmployeeSalaryConfig.md +14 -0
- package/docs/SanityEmployeeSettings.md +14 -0
- package/docs/SanityImageAssetReference.md +16 -0
- package/docs/SanityImageCrop.md +18 -0
- package/docs/SanityImageHotspot.md +18 -0
- package/docs/SanityPatchPageMetaImage.md +18 -0
- package/docs/SanitySystemsInnerDescriptionInner.md +20 -0
- package/docs/SanityTechnologyWithRelationsArticlesInnerMediaOneOf.md +15 -0
- package/docs/SanityTechnologyWithRelationsEmployeesInnerTagsInner.md +17 -0
- package/docs/SanityTechnologyWithRelationsProjectsInnerTechnologiesInner.md +18 -0
- package/docs/SanityTvCategoryDashboardsInnerBackgroundImage.md +15 -0
- package/docs/SanityTvCategoryDashboardsInnerBackgroundImageAsset.md +18 -0
- package/docs/ScopeDefinition.md +17 -0
- package/docs/SessionBootstrapRequest.md +14 -0
- package/docs/SetActiveProviderRequest.md +15 -0
- package/docs/SetFacebookAccountRequest.md +17 -0
- package/docs/SetGoogleAnalyticsPropertyRequest.md +14 -0
- package/docs/SetPlatformSecretRequest.md +14 -0
- package/docs/SetScopeGrantsRequest.md +14 -0
- package/docs/SetWorkReposRequest.md +14 -0
- package/docs/SetWorkspaceRepoRequest.md +14 -0
- package/docs/SignupConfig.md +14 -0
- package/docs/SignupRequest.md +25 -0
- package/docs/SignupResult.md +15 -0
- package/docs/Slug.md +16 -0
- package/docs/SsoExchangeRequest.md +14 -0
- package/docs/StartImpersonationRequest.md +16 -0
- package/docs/StartImpersonationResult.md +20 -0
- package/docs/StudioSanityConfig.md +16 -0
- package/docs/SystemRoleOption.md +15 -0
- package/docs/TeamsAcsTokenResponse.md +16 -0
- package/docs/TeamsAuthStateResponse.md +14 -0
- package/docs/TenantDomain.md +17 -0
- package/docs/TenantInfo.md +32 -0
- package/docs/TenantSanityCredentials.md +16 -0
- package/docs/TokenExchangeRequest.md +14 -0
- package/docs/TokenExchangeResult.md +15 -0
- package/docs/TokenReconciliationReport.md +16 -0
- package/docs/TokenReconciliationSnapshot.md +27 -0
- package/docs/TotpEnrollRequest.md +15 -0
- package/docs/TotpEnrollResult.md +16 -0
- package/docs/UpdateAppsRequest.md +14 -0
- package/docs/UpdateSecretsRequest.md +14 -0
- package/docs/UsageDailySeries.md +16 -0
- package/docs/UsageDayPoint.md +15 -0
- package/docs/UsageEvent.md +18 -0
- package/docs/UsageEventsRequest.md +15 -0
- package/docs/UsageMeterDailySeries.md +17 -0
- package/docs/UsageMeterSummary.md +31 -0
- package/docs/UsageRollup.md +16 -0
- package/docs/UsageRollupTotals.md +18 -0
- package/docs/UsageSummary.md +23 -0
- package/docs/VerifyApiTokenRequest.md +14 -0
- package/docs/WorkReposSelection.md +14 -0
- package/docs/WorkspaceRepoSelection.md +14 -0
- package/package.json +20 -0
- package/src/apis/PlatformClient.ts +7514 -0
- package/src/apis/index.ts +3 -0
- package/src/index.ts +5 -0
- package/src/models/index.ts +6789 -0
- package/src/runtime.ts +442 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,2194 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Platform API
|
|
3
|
+
* Self-service business platform management API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { ActivateRequest, ActivateResult, AddCustomDomainRequest, ApiTokenSummary, ApiTokenVerifyResult, AppCatalogEntry, AppModule, ApproveDeviceRequest, BillingPaymentMethod, BillingSessionRequest, BillingSessionResponse, BridgeWebhookResult, Business, BusinessAccess, BusinessHealth, Capability, CreateApiTokenRequest, CreateUserRequest, CreatedApiToken, CredentialSummary, CustomDomainProvisioning, DevicePairRequestBody, DevicePairing, DevicePairingStatus, DevicePollRequestBody, DeviceScreen, DirectoryGroupsResponse, DirectoryLicensesResponse, DirectoryMailbox, DirectoryServicePrincipalsResponse, EmployeeSettings, EmployeeSystemAccess, EmployeeSystemConfig, FacebookAccount, GitHubRepo, GoogleAnalyticsProperty, GoogleAnalyticsSelection, ImpersonationHistoryEntry, IntegrationCheckResult, IntegrationSummary, InviteCredentialRequest, InvoiceBasis, LoginConfig, MeApp, MeterEnforcementDecision, OAuthAccessTokenResponse, OAuthStartResponse, OlafApiKeyResponse, OlafTeamsSettings, OnboardBusinessRequest, OnboardingConfig, OnboardingStatus, PasswordLoginRequest, PasswordLoginResult, PatchBusinessRequest, PatchEmployee, PendingDevicePreview, PlanInfo, PlatformIntegration, PlatformSanityConfig, PlatformSecretStatus, PowerOfficeConnectResponse, PowerOfficeProduct, PowerOfficeProductsResponse, PowerOfficeProject, PowerOfficeProjectsResponse, ProtectedEmployee, RecordImpersonationActivityRequest, RenameDeviceRequest, ResetConfirmRequest, ResetRequest, RevokeRequest, ScopeDefinition, SessionBootstrapRequest, SetActiveProviderRequest, SetFacebookAccountRequest, SetGoogleAnalyticsPropertyRequest, SetPlatformSecretRequest, SetScopeGrantsRequest, SetWorkReposRequest, SetWorkspaceRepoRequest, SignupConfig, SignupRequest, SignupResult, SsoExchangeRequest, StartImpersonationRequest, StartImpersonationResult, StudioSanityConfig, TeamsAcsTokenResponse, TeamsAuthStateResponse, TenantInfo, TenantSanityCredentials, TokenExchangeRequest, TokenExchangeResult, TokenReconciliationReport, TotpEnrollRequest, TotpEnrollResult, UpdateAppsRequest, UpdateSecretsRequest, UsageDailySeries, UsageEventsRequest, UsageRollup, UsageSummary, VerifyApiTokenRequest, WorkReposSelection, WorkspaceRepoSelection } from '../models/index';
|
|
14
|
+
export interface AddCustomDomainOperationRequest {
|
|
15
|
+
id: string;
|
|
16
|
+
addCustomDomainRequest: AddCustomDomainRequest;
|
|
17
|
+
}
|
|
18
|
+
export interface ApproveDeviceOperationRequest {
|
|
19
|
+
id: string;
|
|
20
|
+
approveDeviceRequest: ApproveDeviceRequest;
|
|
21
|
+
}
|
|
22
|
+
export interface AssignBusinessEmployeeSystemRequest {
|
|
23
|
+
id: string;
|
|
24
|
+
upn: string;
|
|
25
|
+
systemKey: string;
|
|
26
|
+
roleId?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface BackfillBridgeWebhookRequest {
|
|
29
|
+
id: string;
|
|
30
|
+
}
|
|
31
|
+
export interface CheckIntegrationRequest {
|
|
32
|
+
id: string;
|
|
33
|
+
key: string;
|
|
34
|
+
}
|
|
35
|
+
export interface CheckPlatformIntegrationRequest {
|
|
36
|
+
key: string;
|
|
37
|
+
}
|
|
38
|
+
export interface ConnectTenantRequest {
|
|
39
|
+
id: string;
|
|
40
|
+
}
|
|
41
|
+
export interface CreateApiTokenOperationRequest {
|
|
42
|
+
id: string;
|
|
43
|
+
createApiTokenRequest: CreateApiTokenRequest;
|
|
44
|
+
}
|
|
45
|
+
export interface CreateBillingCheckoutRequest {
|
|
46
|
+
id: string;
|
|
47
|
+
billingSessionRequest: BillingSessionRequest;
|
|
48
|
+
}
|
|
49
|
+
export interface CreateBillingPortalRequest {
|
|
50
|
+
id: string;
|
|
51
|
+
billingSessionRequest: BillingSessionRequest;
|
|
52
|
+
}
|
|
53
|
+
export interface CreateBusinessRequest {
|
|
54
|
+
onboardBusinessRequest: OnboardBusinessRequest;
|
|
55
|
+
}
|
|
56
|
+
export interface CreateUserOperationRequest {
|
|
57
|
+
id: string;
|
|
58
|
+
createUserRequest: CreateUserRequest;
|
|
59
|
+
}
|
|
60
|
+
export interface DeleteBusinessRequest {
|
|
61
|
+
id: string;
|
|
62
|
+
}
|
|
63
|
+
export interface DeleteCustomDomainRequest {
|
|
64
|
+
id: string;
|
|
65
|
+
host: string;
|
|
66
|
+
}
|
|
67
|
+
export interface DevicePairPollRequest {
|
|
68
|
+
devicePollRequestBody: DevicePollRequestBody;
|
|
69
|
+
}
|
|
70
|
+
export interface DevicePairRequestRequest {
|
|
71
|
+
devicePairRequestBody?: DevicePairRequestBody;
|
|
72
|
+
}
|
|
73
|
+
export interface DisableCredentialRequest {
|
|
74
|
+
id: string;
|
|
75
|
+
credentialId: string;
|
|
76
|
+
}
|
|
77
|
+
export interface EndImpersonationRequest {
|
|
78
|
+
tokenId: string;
|
|
79
|
+
}
|
|
80
|
+
export interface ExportBusinessDataRequest {
|
|
81
|
+
id: string;
|
|
82
|
+
}
|
|
83
|
+
export interface GetBillingPaymentMethodRequest {
|
|
84
|
+
id: string;
|
|
85
|
+
}
|
|
86
|
+
export interface GetBusinessRequest {
|
|
87
|
+
id: string;
|
|
88
|
+
}
|
|
89
|
+
export interface GetBusinessAccessRequest {
|
|
90
|
+
id: string;
|
|
91
|
+
}
|
|
92
|
+
export interface GetBusinessEmployeeSystemsConfigRequest {
|
|
93
|
+
id: string;
|
|
94
|
+
}
|
|
95
|
+
export interface GetCustomDomainsRequest {
|
|
96
|
+
id: string;
|
|
97
|
+
}
|
|
98
|
+
export interface GetDirectoryGroupsRequest {
|
|
99
|
+
id: string;
|
|
100
|
+
}
|
|
101
|
+
export interface GetDirectoryLicensesRequest {
|
|
102
|
+
id: string;
|
|
103
|
+
}
|
|
104
|
+
export interface GetDirectoryServicePrincipalsRequest {
|
|
105
|
+
id: string;
|
|
106
|
+
}
|
|
107
|
+
export interface GetFacebookSelectedAccountRequest {
|
|
108
|
+
id: string;
|
|
109
|
+
}
|
|
110
|
+
export interface GetImpersonationHistoryRequest {
|
|
111
|
+
limit?: number;
|
|
112
|
+
}
|
|
113
|
+
export interface GetOAuthAccessTokenRequest {
|
|
114
|
+
id: string;
|
|
115
|
+
provider: string;
|
|
116
|
+
}
|
|
117
|
+
export interface GetOlafApiKeyRequest {
|
|
118
|
+
id: string;
|
|
119
|
+
}
|
|
120
|
+
export interface GetOlafTeamsSettingsRequest {
|
|
121
|
+
id: string;
|
|
122
|
+
}
|
|
123
|
+
export interface GetOnboardingConfigRequest {
|
|
124
|
+
id: string;
|
|
125
|
+
}
|
|
126
|
+
export interface GetOnboardingStatusRequest {
|
|
127
|
+
id: string;
|
|
128
|
+
}
|
|
129
|
+
export interface GetPlatformOAuthAccessTokenRequest {
|
|
130
|
+
provider: string;
|
|
131
|
+
}
|
|
132
|
+
export interface GetProvisioningStatusRequest {
|
|
133
|
+
id: string;
|
|
134
|
+
}
|
|
135
|
+
export interface GetTeamsAuthStateRequest {
|
|
136
|
+
id: string;
|
|
137
|
+
}
|
|
138
|
+
export interface GetTeamsUserAcsTokenRequest {
|
|
139
|
+
id: string;
|
|
140
|
+
}
|
|
141
|
+
export interface GetTokenReconciliationRequest {
|
|
142
|
+
month?: string;
|
|
143
|
+
}
|
|
144
|
+
export interface GetUsageDailyRequest {
|
|
145
|
+
businessId: string;
|
|
146
|
+
month?: string;
|
|
147
|
+
}
|
|
148
|
+
export interface GetUsageMeterDecisionRequest {
|
|
149
|
+
businessId: string;
|
|
150
|
+
meter: string;
|
|
151
|
+
}
|
|
152
|
+
export interface GetUsageRollupRequest {
|
|
153
|
+
month?: string;
|
|
154
|
+
}
|
|
155
|
+
export interface GetUsageSummaryRequest {
|
|
156
|
+
businessId: string;
|
|
157
|
+
month?: string;
|
|
158
|
+
}
|
|
159
|
+
export interface GetWorkReposRequest {
|
|
160
|
+
id: string;
|
|
161
|
+
}
|
|
162
|
+
export interface GetWorkspaceRepoRequest {
|
|
163
|
+
id: string;
|
|
164
|
+
}
|
|
165
|
+
export interface IngestUsageEventsRequest {
|
|
166
|
+
usageEventsRequest: UsageEventsRequest;
|
|
167
|
+
}
|
|
168
|
+
export interface InviteCredentialOperationRequest {
|
|
169
|
+
id: string;
|
|
170
|
+
inviteCredentialRequest: InviteCredentialRequest;
|
|
171
|
+
}
|
|
172
|
+
export interface ListAccountingProductsRequest {
|
|
173
|
+
id: string;
|
|
174
|
+
}
|
|
175
|
+
export interface ListAccountingProjectsRequest {
|
|
176
|
+
id: string;
|
|
177
|
+
}
|
|
178
|
+
export interface ListApiTokensRequest {
|
|
179
|
+
id: string;
|
|
180
|
+
}
|
|
181
|
+
export interface ListBusinessEmployeeSystemsRequest {
|
|
182
|
+
id: string;
|
|
183
|
+
upn: string;
|
|
184
|
+
}
|
|
185
|
+
export interface ListBusinessEmployeesRequest {
|
|
186
|
+
id: string;
|
|
187
|
+
}
|
|
188
|
+
export interface ListCredentialsRequest {
|
|
189
|
+
id: string;
|
|
190
|
+
}
|
|
191
|
+
export interface ListDevicesRequest {
|
|
192
|
+
id: string;
|
|
193
|
+
}
|
|
194
|
+
export interface ListFacebookAccountsRequest {
|
|
195
|
+
id: string;
|
|
196
|
+
}
|
|
197
|
+
export interface ListGitHubReposRequest {
|
|
198
|
+
id: string;
|
|
199
|
+
}
|
|
200
|
+
export interface ListIntegrationsRequest {
|
|
201
|
+
id: string;
|
|
202
|
+
}
|
|
203
|
+
export interface ListMailboxesRequest {
|
|
204
|
+
id: string;
|
|
205
|
+
}
|
|
206
|
+
export interface OAuthCallbackRequest {
|
|
207
|
+
provider: string;
|
|
208
|
+
code: string;
|
|
209
|
+
state: string;
|
|
210
|
+
}
|
|
211
|
+
export interface PasswordActivateRequest {
|
|
212
|
+
activateRequest: ActivateRequest;
|
|
213
|
+
}
|
|
214
|
+
export interface PasswordAuthLoginConfigRequest {
|
|
215
|
+
host: string;
|
|
216
|
+
}
|
|
217
|
+
export interface PasswordEnrollTotpRequest {
|
|
218
|
+
totpEnrollRequest: TotpEnrollRequest;
|
|
219
|
+
}
|
|
220
|
+
export interface PasswordLoginOperationRequest {
|
|
221
|
+
passwordLoginRequest: PasswordLoginRequest;
|
|
222
|
+
}
|
|
223
|
+
export interface PasswordResetConfirmRequest {
|
|
224
|
+
resetConfirmRequest: ResetConfirmRequest;
|
|
225
|
+
}
|
|
226
|
+
export interface PasswordResetRequestRequest {
|
|
227
|
+
resetRequest: ResetRequest;
|
|
228
|
+
}
|
|
229
|
+
export interface PasswordSessionBootstrapRequest {
|
|
230
|
+
sessionBootstrapRequest: SessionBootstrapRequest;
|
|
231
|
+
}
|
|
232
|
+
export interface PasswordTokenExchangeRequest {
|
|
233
|
+
tokenExchangeRequest: TokenExchangeRequest;
|
|
234
|
+
}
|
|
235
|
+
export interface PasswordTokenRevokeRequest {
|
|
236
|
+
revokeRequest: RevokeRequest;
|
|
237
|
+
}
|
|
238
|
+
export interface PatchBusinessOperationRequest {
|
|
239
|
+
id: string;
|
|
240
|
+
patchBusinessRequest: PatchBusinessRequest;
|
|
241
|
+
}
|
|
242
|
+
export interface PatchBusinessEmployeeRequest {
|
|
243
|
+
id: string;
|
|
244
|
+
employeeId: string;
|
|
245
|
+
patchEmployee: PatchEmployee;
|
|
246
|
+
}
|
|
247
|
+
export interface PowerOfficeOnboardingCallbackRequest {
|
|
248
|
+
reference: string;
|
|
249
|
+
}
|
|
250
|
+
export interface PowerOfficeOnboardingReturnRequest {
|
|
251
|
+
reference: string;
|
|
252
|
+
}
|
|
253
|
+
export interface PreviewBillingInvoiceRequest {
|
|
254
|
+
id: string;
|
|
255
|
+
month?: string;
|
|
256
|
+
}
|
|
257
|
+
export interface PreviewDeviceRequest {
|
|
258
|
+
id: string;
|
|
259
|
+
code: string;
|
|
260
|
+
}
|
|
261
|
+
export interface ProvisionBusinessRequest {
|
|
262
|
+
id: string;
|
|
263
|
+
}
|
|
264
|
+
export interface PublicSignupRequest {
|
|
265
|
+
signupRequest: SignupRequest;
|
|
266
|
+
}
|
|
267
|
+
export interface RecordImpersonationActivityOperationRequest {
|
|
268
|
+
recordImpersonationActivityRequest: RecordImpersonationActivityRequest;
|
|
269
|
+
}
|
|
270
|
+
export interface RenameDeviceOperationRequest {
|
|
271
|
+
id: string;
|
|
272
|
+
deviceId: string;
|
|
273
|
+
renameDeviceRequest: RenameDeviceRequest;
|
|
274
|
+
}
|
|
275
|
+
export interface RequestUpgradeRequest {
|
|
276
|
+
id: string;
|
|
277
|
+
}
|
|
278
|
+
export interface ResetCredentialRequest {
|
|
279
|
+
id: string;
|
|
280
|
+
credentialId: string;
|
|
281
|
+
}
|
|
282
|
+
export interface ResolveStudioSanityConfigRequest {
|
|
283
|
+
host: string;
|
|
284
|
+
}
|
|
285
|
+
export interface ResolveTenantRequest {
|
|
286
|
+
host?: string;
|
|
287
|
+
businessId?: string;
|
|
288
|
+
entraTenantId?: string;
|
|
289
|
+
}
|
|
290
|
+
export interface ResolveTenantSanityCredentialsRequest {
|
|
291
|
+
host: string;
|
|
292
|
+
}
|
|
293
|
+
export interface RevokeApiTokenRequest {
|
|
294
|
+
id: string;
|
|
295
|
+
fingerprint: string;
|
|
296
|
+
}
|
|
297
|
+
export interface RevokeBusinessEmployeeSystemRequest {
|
|
298
|
+
id: string;
|
|
299
|
+
upn: string;
|
|
300
|
+
systemKey: string;
|
|
301
|
+
}
|
|
302
|
+
export interface RevokeDeviceRequest {
|
|
303
|
+
id: string;
|
|
304
|
+
deviceId: string;
|
|
305
|
+
}
|
|
306
|
+
export interface SetAccountingGadgetsProjectRequest {
|
|
307
|
+
id: string;
|
|
308
|
+
powerOfficeProject: PowerOfficeProject;
|
|
309
|
+
}
|
|
310
|
+
export interface SetAccountingReinvoiceProductRequest {
|
|
311
|
+
id: string;
|
|
312
|
+
powerOfficeProduct: PowerOfficeProduct;
|
|
313
|
+
}
|
|
314
|
+
export interface SetActiveProviderOperationRequest {
|
|
315
|
+
id: string;
|
|
316
|
+
setActiveProviderRequest: SetActiveProviderRequest;
|
|
317
|
+
}
|
|
318
|
+
export interface SetBusinessEmployeePhotoRequest {
|
|
319
|
+
id: string;
|
|
320
|
+
employeeId: string;
|
|
321
|
+
body: Blob;
|
|
322
|
+
}
|
|
323
|
+
export interface SetEmployeeScopeGrantsRequest {
|
|
324
|
+
id: string;
|
|
325
|
+
employeeId: string;
|
|
326
|
+
setScopeGrantsRequest: SetScopeGrantsRequest;
|
|
327
|
+
}
|
|
328
|
+
export interface SetFacebookSelectedAccountRequest {
|
|
329
|
+
id: string;
|
|
330
|
+
setFacebookAccountRequest: SetFacebookAccountRequest;
|
|
331
|
+
}
|
|
332
|
+
export interface SetGoogleAnalyticsSelectedPropertyRequest {
|
|
333
|
+
setGoogleAnalyticsPropertyRequest: SetGoogleAnalyticsPropertyRequest;
|
|
334
|
+
}
|
|
335
|
+
export interface SetGroupScopeGrantsRequest {
|
|
336
|
+
id: string;
|
|
337
|
+
groupId: string;
|
|
338
|
+
setScopeGrantsRequest: SetScopeGrantsRequest;
|
|
339
|
+
}
|
|
340
|
+
export interface SetMeSettingsRequest {
|
|
341
|
+
employeeSettings: EmployeeSettings;
|
|
342
|
+
}
|
|
343
|
+
export interface SetOlafTeamsSettingsRequest {
|
|
344
|
+
id: string;
|
|
345
|
+
olafTeamsSettings: OlafTeamsSettings;
|
|
346
|
+
}
|
|
347
|
+
export interface SetPlatformSecretOperationRequest {
|
|
348
|
+
key: string;
|
|
349
|
+
setPlatformSecretRequest: SetPlatformSecretRequest;
|
|
350
|
+
}
|
|
351
|
+
export interface SetTeamsAuthStateRequest {
|
|
352
|
+
id: string;
|
|
353
|
+
body: object;
|
|
354
|
+
}
|
|
355
|
+
export interface SetWorkReposOperationRequest {
|
|
356
|
+
id: string;
|
|
357
|
+
setWorkReposRequest: SetWorkReposRequest;
|
|
358
|
+
}
|
|
359
|
+
export interface SetWorkspaceRepoOperationRequest {
|
|
360
|
+
id: string;
|
|
361
|
+
setWorkspaceRepoRequest: SetWorkspaceRepoRequest;
|
|
362
|
+
}
|
|
363
|
+
export interface SsoTokenExchangeRequest {
|
|
364
|
+
ssoExchangeRequest: SsoExchangeRequest;
|
|
365
|
+
}
|
|
366
|
+
export interface StartImpersonationOperationRequest {
|
|
367
|
+
startImpersonationRequest: StartImpersonationRequest;
|
|
368
|
+
}
|
|
369
|
+
export interface StartOAuthConnectRequest {
|
|
370
|
+
id: string;
|
|
371
|
+
provider: string;
|
|
372
|
+
returnTo?: string;
|
|
373
|
+
}
|
|
374
|
+
export interface StartPlatformOAuthConnectRequest {
|
|
375
|
+
provider: string;
|
|
376
|
+
returnTo?: string;
|
|
377
|
+
}
|
|
378
|
+
export interface StartPowerOfficeConnectRequest {
|
|
379
|
+
id: string;
|
|
380
|
+
returnTo?: string;
|
|
381
|
+
}
|
|
382
|
+
export interface UpdateAppsOperationRequest {
|
|
383
|
+
id: string;
|
|
384
|
+
updateAppsRequest: UpdateAppsRequest;
|
|
385
|
+
}
|
|
386
|
+
export interface UpdateSecretsOperationRequest {
|
|
387
|
+
id: string;
|
|
388
|
+
updateSecretsRequest: UpdateSecretsRequest;
|
|
389
|
+
}
|
|
390
|
+
export interface VerifyApiTokenOperationRequest {
|
|
391
|
+
verifyApiTokenRequest: VerifyApiTokenRequest;
|
|
392
|
+
}
|
|
393
|
+
export interface ViewAsBusinessRequest {
|
|
394
|
+
id: string;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
*/
|
|
399
|
+
export declare class PlatformClient extends runtime.BaseAPI {
|
|
400
|
+
/**
|
|
401
|
+
* Creates request options for addCustomDomain without sending the request
|
|
402
|
+
*/
|
|
403
|
+
addCustomDomainRequestOpts(requestParameters: AddCustomDomainOperationRequest): Promise<runtime.RequestOpts>;
|
|
404
|
+
/**
|
|
405
|
+
* Maps a custom domain to the business and returns the DNS records the customer must create.
|
|
406
|
+
* Add a custom domain
|
|
407
|
+
*/
|
|
408
|
+
addCustomDomainRaw(requestParameters: AddCustomDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDomainProvisioning>>;
|
|
409
|
+
/**
|
|
410
|
+
* Maps a custom domain to the business and returns the DNS records the customer must create.
|
|
411
|
+
* Add a custom domain
|
|
412
|
+
*/
|
|
413
|
+
addCustomDomain(requestParameters: AddCustomDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDomainProvisioning>;
|
|
414
|
+
/**
|
|
415
|
+
* Creates request options for approveDevice without sending the request
|
|
416
|
+
*/
|
|
417
|
+
approveDeviceRequestOpts(requestParameters: ApproveDeviceOperationRequest): Promise<runtime.RequestOpts>;
|
|
418
|
+
/**
|
|
419
|
+
* Mints a dashboards:read token for this business and hands it to the device on its next poll. The token is never part of this response.
|
|
420
|
+
* Approve a screen into this business
|
|
421
|
+
*/
|
|
422
|
+
approveDeviceRaw(requestParameters: ApproveDeviceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceScreen>>;
|
|
423
|
+
/**
|
|
424
|
+
* Mints a dashboards:read token for this business and hands it to the device on its next poll. The token is never part of this response.
|
|
425
|
+
* Approve a screen into this business
|
|
426
|
+
*/
|
|
427
|
+
approveDevice(requestParameters: ApproveDeviceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceScreen>;
|
|
428
|
+
/**
|
|
429
|
+
* Creates request options for assignBusinessEmployeeSystem without sending the request
|
|
430
|
+
*/
|
|
431
|
+
assignBusinessEmployeeSystemRequestOpts(requestParameters: AssignBusinessEmployeeSystemRequest): Promise<runtime.RequestOpts>;
|
|
432
|
+
/**
|
|
433
|
+
* Assigns the backing app-role via the tenant\'s employees API. Passing a different roleId than the current assignment replaces it.
|
|
434
|
+
* Grant an employee a seat in a third-party system
|
|
435
|
+
*/
|
|
436
|
+
assignBusinessEmployeeSystemRaw(requestParameters: AssignBusinessEmployeeSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmployeeSystemAccess>>;
|
|
437
|
+
/**
|
|
438
|
+
* Assigns the backing app-role via the tenant\'s employees API. Passing a different roleId than the current assignment replaces it.
|
|
439
|
+
* Grant an employee a seat in a third-party system
|
|
440
|
+
*/
|
|
441
|
+
assignBusinessEmployeeSystem(requestParameters: AssignBusinessEmployeeSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmployeeSystemAccess>;
|
|
442
|
+
/**
|
|
443
|
+
* Creates request options for backfillBridgeWebhook without sending the request
|
|
444
|
+
*/
|
|
445
|
+
backfillBridgeWebhookRequestOpts(requestParameters: BackfillBridgeWebhookRequest): Promise<runtime.RequestOpts>;
|
|
446
|
+
/**
|
|
447
|
+
* Removes any existing hooks targeting the broker and creates a fresh {abbr}-bridge-{env} hook authenticated with a managed sanity.webhook key.
|
|
448
|
+
* Re-create a business\'s Sanity bridge webhook with a managed API key
|
|
449
|
+
*/
|
|
450
|
+
backfillBridgeWebhookRaw(requestParameters: BackfillBridgeWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BridgeWebhookResult>>;
|
|
451
|
+
/**
|
|
452
|
+
* Removes any existing hooks targeting the broker and creates a fresh {abbr}-bridge-{env} hook authenticated with a managed sanity.webhook key.
|
|
453
|
+
* Re-create a business\'s Sanity bridge webhook with a managed API key
|
|
454
|
+
*/
|
|
455
|
+
backfillBridgeWebhook(requestParameters: BackfillBridgeWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BridgeWebhookResult>;
|
|
456
|
+
/**
|
|
457
|
+
* Creates request options for checkIntegration without sending the request
|
|
458
|
+
*/
|
|
459
|
+
checkIntegrationRequestOpts(requestParameters: CheckIntegrationRequest): Promise<runtime.RequestOpts>;
|
|
460
|
+
/**
|
|
461
|
+
* Runs a live read-only probe against the integration using stored credentials.
|
|
462
|
+
* Run a live integration connectivity check
|
|
463
|
+
*/
|
|
464
|
+
checkIntegrationRaw(requestParameters: CheckIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationCheckResult>>;
|
|
465
|
+
/**
|
|
466
|
+
* Runs a live read-only probe against the integration using stored credentials.
|
|
467
|
+
* Run a live integration connectivity check
|
|
468
|
+
*/
|
|
469
|
+
checkIntegration(requestParameters: CheckIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationCheckResult>;
|
|
470
|
+
/**
|
|
471
|
+
* Creates request options for checkPlatformIntegration without sending the request
|
|
472
|
+
*/
|
|
473
|
+
checkPlatformIntegrationRequestOpts(requestParameters: CheckPlatformIntegrationRequest): Promise<runtime.RequestOpts>;
|
|
474
|
+
/**
|
|
475
|
+
* Runs a live read-only connectivity probe against a platform-shared integration using the platform\'s own stored credentials.
|
|
476
|
+
* Live-probe a platform integration
|
|
477
|
+
*/
|
|
478
|
+
checkPlatformIntegrationRaw(requestParameters: CheckPlatformIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntegrationCheckResult>>;
|
|
479
|
+
/**
|
|
480
|
+
* Runs a live read-only connectivity probe against a platform-shared integration using the platform\'s own stored credentials.
|
|
481
|
+
* Live-probe a platform integration
|
|
482
|
+
*/
|
|
483
|
+
checkPlatformIntegration(requestParameters: CheckPlatformIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntegrationCheckResult>;
|
|
484
|
+
/**
|
|
485
|
+
* Creates request options for connectTenant without sending the request
|
|
486
|
+
*/
|
|
487
|
+
connectTenantRequestOpts(requestParameters: ConnectTenantRequest): Promise<runtime.RequestOpts>;
|
|
488
|
+
/**
|
|
489
|
+
* Claims an unclaimed business for the authenticated caller\'s Entra tenant. The signup id acts as a one-time claim token until connected; once connected the business is tenant-gated.
|
|
490
|
+
* Connect the caller\'s tenant to a business
|
|
491
|
+
*/
|
|
492
|
+
connectTenantRaw(requestParameters: ConnectTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
493
|
+
/**
|
|
494
|
+
* Claims an unclaimed business for the authenticated caller\'s Entra tenant. The signup id acts as a one-time claim token until connected; once connected the business is tenant-gated.
|
|
495
|
+
* Connect the caller\'s tenant to a business
|
|
496
|
+
*/
|
|
497
|
+
connectTenant(requestParameters: ConnectTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
498
|
+
/**
|
|
499
|
+
* Creates request options for createApiToken without sending the request
|
|
500
|
+
*/
|
|
501
|
+
createApiTokenRequestOpts(requestParameters: CreateApiTokenOperationRequest): Promise<runtime.RequestOpts>;
|
|
502
|
+
/**
|
|
503
|
+
* Issues a new customer API token. The raw token is returned ONCE and never again.
|
|
504
|
+
* Create an API token
|
|
505
|
+
*/
|
|
506
|
+
createApiTokenRaw(requestParameters: CreateApiTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedApiToken>>;
|
|
507
|
+
/**
|
|
508
|
+
* Issues a new customer API token. The raw token is returned ONCE and never again.
|
|
509
|
+
* Create an API token
|
|
510
|
+
*/
|
|
511
|
+
createApiToken(requestParameters: CreateApiTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedApiToken>;
|
|
512
|
+
/**
|
|
513
|
+
* Creates request options for createBillingCheckout without sending the request
|
|
514
|
+
*/
|
|
515
|
+
createBillingCheckoutRequestOpts(requestParameters: CreateBillingCheckoutRequest): Promise<runtime.RequestOpts>;
|
|
516
|
+
/**
|
|
517
|
+
* Creates a Stripe Checkout session for upgrading the business to the growth plan with card billing. Platform operators can start checkout for any business; tenant admins for their own.
|
|
518
|
+
* Start a subscription checkout
|
|
519
|
+
*/
|
|
520
|
+
createBillingCheckoutRaw(requestParameters: CreateBillingCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingSessionResponse>>;
|
|
521
|
+
/**
|
|
522
|
+
* Creates a Stripe Checkout session for upgrading the business to the growth plan with card billing. Platform operators can start checkout for any business; tenant admins for their own.
|
|
523
|
+
* Start a subscription checkout
|
|
524
|
+
*/
|
|
525
|
+
createBillingCheckout(requestParameters: CreateBillingCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingSessionResponse>;
|
|
526
|
+
/**
|
|
527
|
+
* Creates request options for createBillingPortal without sending the request
|
|
528
|
+
*/
|
|
529
|
+
createBillingPortalRequestOpts(requestParameters: CreateBillingPortalRequest): Promise<runtime.RequestOpts>;
|
|
530
|
+
/**
|
|
531
|
+
* Creates a Stripe billing portal session so the business can update its payment method or manage the subscription. Platform operators can open the portal for any business; tenant admins for their own.
|
|
532
|
+
* Open the Stripe billing portal
|
|
533
|
+
*/
|
|
534
|
+
createBillingPortalRaw(requestParameters: CreateBillingPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingSessionResponse>>;
|
|
535
|
+
/**
|
|
536
|
+
* Creates a Stripe billing portal session so the business can update its payment method or manage the subscription. Platform operators can open the portal for any business; tenant admins for their own.
|
|
537
|
+
* Open the Stripe billing portal
|
|
538
|
+
*/
|
|
539
|
+
createBillingPortal(requestParameters: CreateBillingPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingSessionResponse>;
|
|
540
|
+
/**
|
|
541
|
+
* Creates request options for createBusiness without sending the request
|
|
542
|
+
*/
|
|
543
|
+
createBusinessRequestOpts(requestParameters: CreateBusinessRequest): Promise<runtime.RequestOpts>;
|
|
544
|
+
/**
|
|
545
|
+
* Operator-driven creation of a business with full control over tenancy, domain and Sanity config. Used to onboard enterprise tenants that don\'t go through public self-serve signup.
|
|
546
|
+
* Onboard a business
|
|
547
|
+
*/
|
|
548
|
+
createBusinessRaw(requestParameters: CreateBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
549
|
+
/**
|
|
550
|
+
* Operator-driven creation of a business with full control over tenancy, domain and Sanity config. Used to onboard enterprise tenants that don\'t go through public self-serve signup.
|
|
551
|
+
* Onboard a business
|
|
552
|
+
*/
|
|
553
|
+
createBusiness(requestParameters: CreateBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
554
|
+
/**
|
|
555
|
+
* Creates request options for createUser without sending the request
|
|
556
|
+
*/
|
|
557
|
+
createUserRequestOpts(requestParameters: CreateUserOperationRequest): Promise<runtime.RequestOpts>;
|
|
558
|
+
/**
|
|
559
|
+
* Creates the tenant Sanity employee with the given scope grants and sends the activation invite so the user sets their own password + TOTP. Scoped to the caller\'s own business.
|
|
560
|
+
* Add a teammate to the tenant
|
|
561
|
+
*/
|
|
562
|
+
createUserRaw(requestParameters: CreateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CredentialSummary>>;
|
|
563
|
+
/**
|
|
564
|
+
* Creates the tenant Sanity employee with the given scope grants and sends the activation invite so the user sets their own password + TOTP. Scoped to the caller\'s own business.
|
|
565
|
+
* Add a teammate to the tenant
|
|
566
|
+
*/
|
|
567
|
+
createUser(requestParameters: CreateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CredentialSummary>;
|
|
568
|
+
/**
|
|
569
|
+
* Creates request options for deleteBusiness without sending the request
|
|
570
|
+
*/
|
|
571
|
+
deleteBusinessRequestOpts(requestParameters: DeleteBusinessRequest): Promise<runtime.RequestOpts>;
|
|
572
|
+
/**
|
|
573
|
+
* Deletes a business by ID.
|
|
574
|
+
* Delete a business
|
|
575
|
+
*/
|
|
576
|
+
deleteBusinessRaw(requestParameters: DeleteBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
577
|
+
/**
|
|
578
|
+
* Deletes a business by ID.
|
|
579
|
+
* Delete a business
|
|
580
|
+
*/
|
|
581
|
+
deleteBusiness(requestParameters: DeleteBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
582
|
+
/**
|
|
583
|
+
* Creates request options for deleteCustomDomain without sending the request
|
|
584
|
+
*/
|
|
585
|
+
deleteCustomDomainRequestOpts(requestParameters: DeleteCustomDomainRequest): Promise<runtime.RequestOpts>;
|
|
586
|
+
/**
|
|
587
|
+
* Removes a custom domain from the business.
|
|
588
|
+
* Remove a custom domain
|
|
589
|
+
*/
|
|
590
|
+
deleteCustomDomainRaw(requestParameters: DeleteCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
591
|
+
/**
|
|
592
|
+
* Removes a custom domain from the business.
|
|
593
|
+
* Remove a custom domain
|
|
594
|
+
*/
|
|
595
|
+
deleteCustomDomain(requestParameters: DeleteCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
596
|
+
/**
|
|
597
|
+
* Creates request options for devicePairPoll without sending the request
|
|
598
|
+
*/
|
|
599
|
+
devicePairPollRequestOpts(requestParameters: DevicePairPollRequest): Promise<runtime.RequestOpts>;
|
|
600
|
+
/**
|
|
601
|
+
* Returns the screen\'s token exactly once, on the first poll after approval. A wrong or unknown poll token is indistinguishable from an unknown device.
|
|
602
|
+
* Ask whether the code was approved
|
|
603
|
+
*/
|
|
604
|
+
devicePairPollRaw(requestParameters: DevicePairPollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DevicePairingStatus>>;
|
|
605
|
+
/**
|
|
606
|
+
* Returns the screen\'s token exactly once, on the first poll after approval. A wrong or unknown poll token is indistinguishable from an unknown device.
|
|
607
|
+
* Ask whether the code was approved
|
|
608
|
+
*/
|
|
609
|
+
devicePairPoll(requestParameters: DevicePairPollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DevicePairingStatus>;
|
|
610
|
+
/**
|
|
611
|
+
* Creates request options for devicePairRequest without sending the request
|
|
612
|
+
*/
|
|
613
|
+
devicePairRequestRequestOpts(requestParameters: DevicePairRequestRequest): Promise<runtime.RequestOpts>;
|
|
614
|
+
/**
|
|
615
|
+
* A screen asks for a code to display. The link belongs to no business until somebody signed in approves the code, so this grants nothing on its own.
|
|
616
|
+
* Ask for a pairing code
|
|
617
|
+
*/
|
|
618
|
+
devicePairRequestRaw(requestParameters: DevicePairRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DevicePairing>>;
|
|
619
|
+
/**
|
|
620
|
+
* A screen asks for a code to display. The link belongs to no business until somebody signed in approves the code, so this grants nothing on its own.
|
|
621
|
+
* Ask for a pairing code
|
|
622
|
+
*/
|
|
623
|
+
devicePairRequest(requestParameters?: DevicePairRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DevicePairing>;
|
|
624
|
+
/**
|
|
625
|
+
* Creates request options for disableCredential without sending the request
|
|
626
|
+
*/
|
|
627
|
+
disableCredentialRequestOpts(requestParameters: DisableCredentialRequest): Promise<runtime.RequestOpts>;
|
|
628
|
+
/**
|
|
629
|
+
* Disables the credential and revokes all of the user\'s refresh tokens.
|
|
630
|
+
* Disable a password credential
|
|
631
|
+
*/
|
|
632
|
+
disableCredentialRaw(requestParameters: DisableCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
633
|
+
/**
|
|
634
|
+
* Disables the credential and revokes all of the user\'s refresh tokens.
|
|
635
|
+
* Disable a password credential
|
|
636
|
+
*/
|
|
637
|
+
disableCredential(requestParameters: DisableCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
638
|
+
/**
|
|
639
|
+
* Creates request options for endImpersonation without sending the request
|
|
640
|
+
*/
|
|
641
|
+
endImpersonationRequestOpts(requestParameters: EndImpersonationRequest): Promise<runtime.RequestOpts>;
|
|
642
|
+
/**
|
|
643
|
+
* Writes the append-only session-end audit record. Token expiry auto-ends too.
|
|
644
|
+
* End a view-as-employee session
|
|
645
|
+
*/
|
|
646
|
+
endImpersonationRaw(requestParameters: EndImpersonationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
647
|
+
/**
|
|
648
|
+
* Writes the append-only session-end audit record. Token expiry auto-ends too.
|
|
649
|
+
* End a view-as-employee session
|
|
650
|
+
*/
|
|
651
|
+
endImpersonation(requestParameters: EndImpersonationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
652
|
+
/**
|
|
653
|
+
* Creates request options for exportBusinessData without sending the request
|
|
654
|
+
*/
|
|
655
|
+
exportBusinessDataRequestOpts(requestParameters: ExportBusinessDataRequest): Promise<runtime.RequestOpts>;
|
|
656
|
+
/**
|
|
657
|
+
* Assembles a machine-readable export of the tenant\'s data: the business record (without secrets), the tenant\'s Sanity documents and usage history. Streams as a downloadable JSON attachment. Rate-limited to about one export per business per hour (best effort, per app instance). Platform operators can export any business; tenant admins can export their own.
|
|
658
|
+
* Export a business\'s data (GDPR)
|
|
659
|
+
*/
|
|
660
|
+
exportBusinessDataRaw(requestParameters: ExportBusinessDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
661
|
+
/**
|
|
662
|
+
* Assembles a machine-readable export of the tenant\'s data: the business record (without secrets), the tenant\'s Sanity documents and usage history. Streams as a downloadable JSON attachment. Rate-limited to about one export per business per hour (best effort, per app instance). Platform operators can export any business; tenant admins can export their own.
|
|
663
|
+
* Export a business\'s data (GDPR)
|
|
664
|
+
*/
|
|
665
|
+
exportBusinessData(requestParameters: ExportBusinessDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
666
|
+
/**
|
|
667
|
+
* Creates request options for getApiScopes without sending the request
|
|
668
|
+
*/
|
|
669
|
+
getApiScopesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
670
|
+
/**
|
|
671
|
+
* Returns the catalog of customer-grantable API scopes (key, label, children). Single source of truth for the API-key UI.
|
|
672
|
+
* List grantable API scopes
|
|
673
|
+
*/
|
|
674
|
+
getApiScopesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ScopeDefinition>>>;
|
|
675
|
+
/**
|
|
676
|
+
* Returns the catalog of customer-grantable API scopes (key, label, children). Single source of truth for the API-key UI.
|
|
677
|
+
* List grantable API scopes
|
|
678
|
+
*/
|
|
679
|
+
getApiScopes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ScopeDefinition>>;
|
|
680
|
+
/**
|
|
681
|
+
* Creates request options for getBillingPaymentMethod without sending the request
|
|
682
|
+
*/
|
|
683
|
+
getBillingPaymentMethodRequestOpts(requestParameters: GetBillingPaymentMethodRequest): Promise<runtime.RequestOpts>;
|
|
684
|
+
/**
|
|
685
|
+
* Returns the business\'s billing method and, for card billing, the brand and last four digits of the default card in Stripe. Platform operators can read any business; tenant admins their own.
|
|
686
|
+
* Payment method on file
|
|
687
|
+
*/
|
|
688
|
+
getBillingPaymentMethodRaw(requestParameters: GetBillingPaymentMethodRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingPaymentMethod>>;
|
|
689
|
+
/**
|
|
690
|
+
* Returns the business\'s billing method and, for card billing, the brand and last four digits of the default card in Stripe. Platform operators can read any business; tenant admins their own.
|
|
691
|
+
* Payment method on file
|
|
692
|
+
*/
|
|
693
|
+
getBillingPaymentMethod(requestParameters: GetBillingPaymentMethodRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingPaymentMethod>;
|
|
694
|
+
/**
|
|
695
|
+
* Creates request options for getBusiness without sending the request
|
|
696
|
+
*/
|
|
697
|
+
getBusinessRequestOpts(requestParameters: GetBusinessRequest): Promise<runtime.RequestOpts>;
|
|
698
|
+
/**
|
|
699
|
+
* Retrieves a business by ID.
|
|
700
|
+
* Get a business
|
|
701
|
+
*/
|
|
702
|
+
getBusinessRaw(requestParameters: GetBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
703
|
+
/**
|
|
704
|
+
* Retrieves a business by ID.
|
|
705
|
+
* Get a business
|
|
706
|
+
*/
|
|
707
|
+
getBusiness(requestParameters: GetBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
708
|
+
/**
|
|
709
|
+
* Creates request options for getBusinessAccess without sending the request
|
|
710
|
+
*/
|
|
711
|
+
getBusinessAccessRequestOpts(requestParameters: GetBusinessAccessRequest): Promise<runtime.RequestOpts>;
|
|
712
|
+
/**
|
|
713
|
+
* Returns the business\'s Sanity groups and employees with the scopes each currently grants.
|
|
714
|
+
* List a business\'s scope-grant assignments
|
|
715
|
+
*/
|
|
716
|
+
getBusinessAccessRaw(requestParameters: GetBusinessAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessAccess>>;
|
|
717
|
+
/**
|
|
718
|
+
* Returns the business\'s Sanity groups and employees with the scopes each currently grants.
|
|
719
|
+
* List a business\'s scope-grant assignments
|
|
720
|
+
*/
|
|
721
|
+
getBusinessAccess(requestParameters: GetBusinessAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessAccess>;
|
|
722
|
+
/**
|
|
723
|
+
* Creates request options for getBusinessEmployeeSystemsConfig without sending the request
|
|
724
|
+
*/
|
|
725
|
+
getBusinessEmployeeSystemsConfigRequestOpts(requestParameters: GetBusinessEmployeeSystemsConfigRequest): Promise<runtime.RequestOpts>;
|
|
726
|
+
/**
|
|
727
|
+
* Which Enterprise App backs each registered system. Used by the Systemoppsett admin card.
|
|
728
|
+
* List the tenant\'s system registry with configuration
|
|
729
|
+
*/
|
|
730
|
+
getBusinessEmployeeSystemsConfigRaw(requestParameters: GetBusinessEmployeeSystemsConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<EmployeeSystemConfig>>>;
|
|
731
|
+
/**
|
|
732
|
+
* Which Enterprise App backs each registered system. Used by the Systemoppsett admin card.
|
|
733
|
+
* List the tenant\'s system registry with configuration
|
|
734
|
+
*/
|
|
735
|
+
getBusinessEmployeeSystemsConfig(requestParameters: GetBusinessEmployeeSystemsConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<EmployeeSystemConfig>>;
|
|
736
|
+
/**
|
|
737
|
+
* Creates request options for getBusinesses without sending the request
|
|
738
|
+
*/
|
|
739
|
+
getBusinessesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
740
|
+
/**
|
|
741
|
+
* Retrieves all registered businesses.
|
|
742
|
+
* List all businesses
|
|
743
|
+
*/
|
|
744
|
+
getBusinessesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Business>>>;
|
|
745
|
+
/**
|
|
746
|
+
* Retrieves all registered businesses.
|
|
747
|
+
* List all businesses
|
|
748
|
+
*/
|
|
749
|
+
getBusinesses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Business>>;
|
|
750
|
+
/**
|
|
751
|
+
* Creates request options for getCustomDomains without sending the request
|
|
752
|
+
*/
|
|
753
|
+
getCustomDomainsRequestOpts(requestParameters: GetCustomDomainsRequest): Promise<runtime.RequestOpts>;
|
|
754
|
+
/**
|
|
755
|
+
* Retrieves the custom domains mapped to a business.
|
|
756
|
+
* List custom domains
|
|
757
|
+
*/
|
|
758
|
+
getCustomDomainsRaw(requestParameters: GetCustomDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CustomDomainProvisioning>>>;
|
|
759
|
+
/**
|
|
760
|
+
* Retrieves the custom domains mapped to a business.
|
|
761
|
+
* List custom domains
|
|
762
|
+
*/
|
|
763
|
+
getCustomDomains(requestParameters: GetCustomDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CustomDomainProvisioning>>;
|
|
764
|
+
/**
|
|
765
|
+
* Creates request options for getDirectoryGroups without sending the request
|
|
766
|
+
*/
|
|
767
|
+
getDirectoryGroupsRequestOpts(requestParameters: GetDirectoryGroupsRequest): Promise<runtime.RequestOpts>;
|
|
768
|
+
/**
|
|
769
|
+
* Lists the groups in the business\'s connected Entra tenant, so an admin can choose which group new hires join during onboarding.
|
|
770
|
+
* List Entra groups for a business
|
|
771
|
+
*/
|
|
772
|
+
getDirectoryGroupsRaw(requestParameters: GetDirectoryGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectoryGroupsResponse>>;
|
|
773
|
+
/**
|
|
774
|
+
* Lists the groups in the business\'s connected Entra tenant, so an admin can choose which group new hires join during onboarding.
|
|
775
|
+
* List Entra groups for a business
|
|
776
|
+
*/
|
|
777
|
+
getDirectoryGroups(requestParameters: GetDirectoryGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectoryGroupsResponse>;
|
|
778
|
+
/**
|
|
779
|
+
* Creates request options for getDirectoryLicenses without sending the request
|
|
780
|
+
*/
|
|
781
|
+
getDirectoryLicensesRequestOpts(requestParameters: GetDirectoryLicensesRequest): Promise<runtime.RequestOpts>;
|
|
782
|
+
/**
|
|
783
|
+
* Lists the subscribed SKUs in the business\'s connected Entra tenant, so an admin can pin which license new hires get during onboarding.
|
|
784
|
+
* List Microsoft 365 licenses for a business
|
|
785
|
+
*/
|
|
786
|
+
getDirectoryLicensesRaw(requestParameters: GetDirectoryLicensesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectoryLicensesResponse>>;
|
|
787
|
+
/**
|
|
788
|
+
* Lists the subscribed SKUs in the business\'s connected Entra tenant, so an admin can pin which license new hires get during onboarding.
|
|
789
|
+
* List Microsoft 365 licenses for a business
|
|
790
|
+
*/
|
|
791
|
+
getDirectoryLicenses(requestParameters: GetDirectoryLicensesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectoryLicensesResponse>;
|
|
792
|
+
/**
|
|
793
|
+
* Creates request options for getDirectoryServicePrincipals without sending the request
|
|
794
|
+
*/
|
|
795
|
+
getDirectoryServicePrincipalsRequestOpts(requestParameters: GetDirectoryServicePrincipalsRequest): Promise<runtime.RequestOpts>;
|
|
796
|
+
/**
|
|
797
|
+
* Lists the enterprise applications in the business\'s connected Entra tenant that expose user-assignable app roles, so an admin can map an onboarding system (e.g. Salesforce) to a service principal + role.
|
|
798
|
+
* List enterprise apps with assignable app roles
|
|
799
|
+
*/
|
|
800
|
+
getDirectoryServicePrincipalsRaw(requestParameters: GetDirectoryServicePrincipalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DirectoryServicePrincipalsResponse>>;
|
|
801
|
+
/**
|
|
802
|
+
* Lists the enterprise applications in the business\'s connected Entra tenant that expose user-assignable app roles, so an admin can map an onboarding system (e.g. Salesforce) to a service principal + role.
|
|
803
|
+
* List enterprise apps with assignable app roles
|
|
804
|
+
*/
|
|
805
|
+
getDirectoryServicePrincipals(requestParameters: GetDirectoryServicePrincipalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DirectoryServicePrincipalsResponse>;
|
|
806
|
+
/**
|
|
807
|
+
* Creates request options for getFacebookSelectedAccount without sending the request
|
|
808
|
+
*/
|
|
809
|
+
getFacebookSelectedAccountRequestOpts(requestParameters: GetFacebookSelectedAccountRequest): Promise<runtime.RequestOpts>;
|
|
810
|
+
/**
|
|
811
|
+
* Returns the Facebook Page or Instagram account the business has chosen to post to, if any.
|
|
812
|
+
* Get the selected Facebook/Instagram posting account
|
|
813
|
+
*/
|
|
814
|
+
getFacebookSelectedAccountRaw(requestParameters: GetFacebookSelectedAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacebookAccount>>;
|
|
815
|
+
/**
|
|
816
|
+
* Returns the Facebook Page or Instagram account the business has chosen to post to, if any.
|
|
817
|
+
* Get the selected Facebook/Instagram posting account
|
|
818
|
+
*/
|
|
819
|
+
getFacebookSelectedAccount(requestParameters: GetFacebookSelectedAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacebookAccount | null | undefined>;
|
|
820
|
+
/**
|
|
821
|
+
* Creates request options for getFleetHealth without sending the request
|
|
822
|
+
*/
|
|
823
|
+
getFleetHealthRequestOpts(): Promise<runtime.RequestOpts>;
|
|
824
|
+
/**
|
|
825
|
+
* Per-business provisioning state and live integration health probes across the fleet. Probe failures are reported per integration, never thrown. Operator only.
|
|
826
|
+
* Get fleet-wide tenant health
|
|
827
|
+
*/
|
|
828
|
+
getFleetHealthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<BusinessHealth>>>;
|
|
829
|
+
/**
|
|
830
|
+
* Per-business provisioning state and live integration health probes across the fleet. Probe failures are reported per integration, never thrown. Operator only.
|
|
831
|
+
* Get fleet-wide tenant health
|
|
832
|
+
*/
|
|
833
|
+
getFleetHealth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<BusinessHealth>>;
|
|
834
|
+
/**
|
|
835
|
+
* Creates request options for getGoogleAnalyticsSelectedProperty without sending the request
|
|
836
|
+
*/
|
|
837
|
+
getGoogleAnalyticsSelectedPropertyRequestOpts(): Promise<runtime.RequestOpts>;
|
|
838
|
+
/**
|
|
839
|
+
* Returns the GA4 property the platform has chosen for analytics, if any.
|
|
840
|
+
* Get the selected Google Analytics property
|
|
841
|
+
*/
|
|
842
|
+
getGoogleAnalyticsSelectedPropertyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GoogleAnalyticsSelection>>;
|
|
843
|
+
/**
|
|
844
|
+
* Returns the GA4 property the platform has chosen for analytics, if any.
|
|
845
|
+
* Get the selected Google Analytics property
|
|
846
|
+
*/
|
|
847
|
+
getGoogleAnalyticsSelectedProperty(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GoogleAnalyticsSelection | null | undefined>;
|
|
848
|
+
/**
|
|
849
|
+
* Creates request options for getImpersonationHistory without sending the request
|
|
850
|
+
*/
|
|
851
|
+
getImpersonationHistoryRequestOpts(requestParameters: GetImpersonationHistoryRequest): Promise<runtime.RequestOpts>;
|
|
852
|
+
/**
|
|
853
|
+
* Operator-only. Returns the tamper-evident impersonation history, newest first, with a chainValid flag per record.
|
|
854
|
+
* Operator review of the impersonation audit log
|
|
855
|
+
*/
|
|
856
|
+
getImpersonationHistoryRaw(requestParameters: GetImpersonationHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ImpersonationHistoryEntry>>>;
|
|
857
|
+
/**
|
|
858
|
+
* Operator-only. Returns the tamper-evident impersonation history, newest first, with a chainValid flag per record.
|
|
859
|
+
* Operator review of the impersonation audit log
|
|
860
|
+
*/
|
|
861
|
+
getImpersonationHistory(requestParameters?: GetImpersonationHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ImpersonationHistoryEntry>>;
|
|
862
|
+
/**
|
|
863
|
+
* Creates request options for getMeApps without sending the request
|
|
864
|
+
*/
|
|
865
|
+
getMeAppsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
866
|
+
/**
|
|
867
|
+
* Resolved app links for the business the caller\'s Entra tenant belongs to. Lets a non-admin employee reach the apps their business has enabled even without an owned business.
|
|
868
|
+
* List apps for the signed-in employee
|
|
869
|
+
*/
|
|
870
|
+
getMeAppsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<MeApp>>>;
|
|
871
|
+
/**
|
|
872
|
+
* Resolved app links for the business the caller\'s Entra tenant belongs to. Lets a non-admin employee reach the apps their business has enabled even without an owned business.
|
|
873
|
+
* List apps for the signed-in employee
|
|
874
|
+
*/
|
|
875
|
+
getMeApps(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MeApp>>;
|
|
876
|
+
/**
|
|
877
|
+
* Creates request options for getMeSettings without sending the request
|
|
878
|
+
*/
|
|
879
|
+
getMeSettingsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
880
|
+
/**
|
|
881
|
+
* Reads the caller\'s own employee settings from the business their token belongs to. The control plane holds no tenant-scoped token, so it reads through the platform instead.
|
|
882
|
+
* Read the signed-in employee\'s settings
|
|
883
|
+
*/
|
|
884
|
+
getMeSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmployeeSettings>>;
|
|
885
|
+
/**
|
|
886
|
+
* Reads the caller\'s own employee settings from the business their token belongs to. The control plane holds no tenant-scoped token, so it reads through the platform instead.
|
|
887
|
+
* Read the signed-in employee\'s settings
|
|
888
|
+
*/
|
|
889
|
+
getMeSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmployeeSettings>;
|
|
890
|
+
/**
|
|
891
|
+
* Creates request options for getModules without sending the request
|
|
892
|
+
*/
|
|
893
|
+
getModulesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
894
|
+
/**
|
|
895
|
+
* Returns all available app modules.
|
|
896
|
+
* List available modules
|
|
897
|
+
*/
|
|
898
|
+
getModulesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AppModule>>>;
|
|
899
|
+
/**
|
|
900
|
+
* Returns all available app modules.
|
|
901
|
+
* List available modules
|
|
902
|
+
*/
|
|
903
|
+
getModules(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AppModule>>;
|
|
904
|
+
/**
|
|
905
|
+
* Creates request options for getMyBusinesses without sending the request
|
|
906
|
+
*/
|
|
907
|
+
getMyBusinessesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
908
|
+
/**
|
|
909
|
+
* Businesses owned by the signed-in user\'s organization.
|
|
910
|
+
* List my businesses
|
|
911
|
+
*/
|
|
912
|
+
getMyBusinessesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Business>>>;
|
|
913
|
+
/**
|
|
914
|
+
* Businesses owned by the signed-in user\'s organization.
|
|
915
|
+
* List my businesses
|
|
916
|
+
*/
|
|
917
|
+
getMyBusinesses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Business>>;
|
|
918
|
+
/**
|
|
919
|
+
* Creates request options for getOAuthAccessToken without sending the request
|
|
920
|
+
*/
|
|
921
|
+
getOAuthAccessTokenRequestOpts(requestParameters: GetOAuthAccessTokenRequest): Promise<runtime.RequestOpts>;
|
|
922
|
+
/**
|
|
923
|
+
* Service-to-service: refreshes the business\'s stored OAuth refresh token and returns a short-lived access token for the provider. Used by owning functions (e.g. accounting-function for Coinbase transfers).
|
|
924
|
+
* Mint a fresh OAuth access token
|
|
925
|
+
*/
|
|
926
|
+
getOAuthAccessTokenRaw(requestParameters: GetOAuthAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OAuthAccessTokenResponse>>;
|
|
927
|
+
/**
|
|
928
|
+
* Service-to-service: refreshes the business\'s stored OAuth refresh token and returns a short-lived access token for the provider. Used by owning functions (e.g. accounting-function for Coinbase transfers).
|
|
929
|
+
* Mint a fresh OAuth access token
|
|
930
|
+
*/
|
|
931
|
+
getOAuthAccessToken(requestParameters: GetOAuthAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthAccessTokenResponse>;
|
|
932
|
+
/**
|
|
933
|
+
* Creates request options for getOlafApiKey without sending the request
|
|
934
|
+
*/
|
|
935
|
+
getOlafApiKeyRequestOpts(requestParameters: GetOlafApiKeyRequest): Promise<runtime.RequestOpts>;
|
|
936
|
+
/**
|
|
937
|
+
* Returns the managed API key Olaf\'s gateway uses to call Snokam APIs as this business, minting it on first call. Managed, so it cannot be revoked from the UI.
|
|
938
|
+
* The business\'s Olaf API key
|
|
939
|
+
*/
|
|
940
|
+
getOlafApiKeyRaw(requestParameters: GetOlafApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OlafApiKeyResponse>>;
|
|
941
|
+
/**
|
|
942
|
+
* Returns the managed API key Olaf\'s gateway uses to call Snokam APIs as this business, minting it on first call. Managed, so it cannot be revoked from the UI.
|
|
943
|
+
* The business\'s Olaf API key
|
|
944
|
+
*/
|
|
945
|
+
getOlafApiKey(requestParameters: GetOlafApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OlafApiKeyResponse>;
|
|
946
|
+
/**
|
|
947
|
+
* Creates request options for getOlafTeamsSettings without sending the request
|
|
948
|
+
*/
|
|
949
|
+
getOlafTeamsSettingsRequestOpts(requestParameters: GetOlafTeamsSettingsRequest): Promise<runtime.RequestOpts>;
|
|
950
|
+
/**
|
|
951
|
+
* Returns the per-business Teams meeting-assistant settings (voice and future tuning knobs), with defaults when unset. Read by the business owner in the platform web and by the voice bridge (managed identity) when a meeting starts.
|
|
952
|
+
* Get the business\'s Olaf meeting-assistant settings
|
|
953
|
+
*/
|
|
954
|
+
getOlafTeamsSettingsRaw(requestParameters: GetOlafTeamsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OlafTeamsSettings>>;
|
|
955
|
+
/**
|
|
956
|
+
* Returns the per-business Teams meeting-assistant settings (voice and future tuning knobs), with defaults when unset. Read by the business owner in the platform web and by the voice bridge (managed identity) when a meeting starts.
|
|
957
|
+
* Get the business\'s Olaf meeting-assistant settings
|
|
958
|
+
*/
|
|
959
|
+
getOlafTeamsSettings(requestParameters: GetOlafTeamsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OlafTeamsSettings>;
|
|
960
|
+
/**
|
|
961
|
+
* Creates request options for getOnboardingConfig without sending the request
|
|
962
|
+
*/
|
|
963
|
+
getOnboardingConfigRequestOpts(requestParameters: GetOnboardingConfigRequest): Promise<runtime.RequestOpts>;
|
|
964
|
+
/**
|
|
965
|
+
* Returns the non-sensitive directory identifiers (Entra group, Microsoft 365 license SKU, Salesforce service principal and app role) chosen for automated onboarding, so the management UI can show the current selection.
|
|
966
|
+
* Get the saved onboarding directory selections for a business
|
|
967
|
+
*/
|
|
968
|
+
getOnboardingConfigRaw(requestParameters: GetOnboardingConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OnboardingConfig>>;
|
|
969
|
+
/**
|
|
970
|
+
* Returns the non-sensitive directory identifiers (Entra group, Microsoft 365 license SKU, Salesforce service principal and app role) chosen for automated onboarding, so the management UI can show the current selection.
|
|
971
|
+
* Get the saved onboarding directory selections for a business
|
|
972
|
+
*/
|
|
973
|
+
getOnboardingConfig(requestParameters: GetOnboardingConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OnboardingConfig>;
|
|
974
|
+
/**
|
|
975
|
+
* Creates request options for getOnboardingStatus without sending the request
|
|
976
|
+
*/
|
|
977
|
+
getOnboardingStatusRequestOpts(requestParameters: GetOnboardingStatusRequest): Promise<runtime.RequestOpts>;
|
|
978
|
+
/**
|
|
979
|
+
* Derives onboarding step statuses from actual state: configured domains, tenant Sanity branding and content, roster size, chosen modules and connected integrations. Platform operators can read any business; tenant admins can read their own.
|
|
980
|
+
* Get the onboarding checklist for a business
|
|
981
|
+
*/
|
|
982
|
+
getOnboardingStatusRaw(requestParameters: GetOnboardingStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OnboardingStatus>>;
|
|
983
|
+
/**
|
|
984
|
+
* Derives onboarding step statuses from actual state: configured domains, tenant Sanity branding and content, roster size, chosen modules and connected integrations. Platform operators can read any business; tenant admins can read their own.
|
|
985
|
+
* Get the onboarding checklist for a business
|
|
986
|
+
*/
|
|
987
|
+
getOnboardingStatus(requestParameters: GetOnboardingStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OnboardingStatus>;
|
|
988
|
+
/**
|
|
989
|
+
* Creates request options for getPlatformIntegrations without sending the request
|
|
990
|
+
*/
|
|
991
|
+
getPlatformIntegrationsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
992
|
+
/**
|
|
993
|
+
* Returns the shared integrations every business depends on, grouped by service, with whether each secret is configured. Values are never returned.
|
|
994
|
+
* List platform-shared integrations
|
|
995
|
+
*/
|
|
996
|
+
getPlatformIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PlatformIntegration>>>;
|
|
997
|
+
/**
|
|
998
|
+
* Returns the shared integrations every business depends on, grouped by service, with whether each secret is configured. Values are never returned.
|
|
999
|
+
* List platform-shared integrations
|
|
1000
|
+
*/
|
|
1001
|
+
getPlatformIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PlatformIntegration>>;
|
|
1002
|
+
/**
|
|
1003
|
+
* Creates request options for getPlatformOAuthAccessToken without sending the request
|
|
1004
|
+
*/
|
|
1005
|
+
getPlatformOAuthAccessTokenRequestOpts(requestParameters: GetPlatformOAuthAccessTokenRequest): Promise<runtime.RequestOpts>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Service-to-service: refreshes the platform\'s stored OAuth refresh token and returns a short-lived access token for a platform-connected provider (e.g. Google Analytics).
|
|
1008
|
+
* Mint a fresh platform OAuth access token
|
|
1009
|
+
*/
|
|
1010
|
+
getPlatformOAuthAccessTokenRaw(requestParameters: GetPlatformOAuthAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OAuthAccessTokenResponse>>;
|
|
1011
|
+
/**
|
|
1012
|
+
* Service-to-service: refreshes the platform\'s stored OAuth refresh token and returns a short-lived access token for a platform-connected provider (e.g. Google Analytics).
|
|
1013
|
+
* Mint a fresh platform OAuth access token
|
|
1014
|
+
*/
|
|
1015
|
+
getPlatformOAuthAccessToken(requestParameters: GetPlatformOAuthAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthAccessTokenResponse>;
|
|
1016
|
+
/**
|
|
1017
|
+
* Creates request options for getPlatformSecrets without sending the request
|
|
1018
|
+
*/
|
|
1019
|
+
getPlatformSecretsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1020
|
+
/**
|
|
1021
|
+
* Lists shared platform secret keys and whether each is configured. Values are never returned.
|
|
1022
|
+
* List shared platform secrets
|
|
1023
|
+
*/
|
|
1024
|
+
getPlatformSecretsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PlatformSecretStatus>>>;
|
|
1025
|
+
/**
|
|
1026
|
+
* Lists shared platform secret keys and whether each is configured. Values are never returned.
|
|
1027
|
+
* List shared platform secrets
|
|
1028
|
+
*/
|
|
1029
|
+
getPlatformSecrets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PlatformSecretStatus>>;
|
|
1030
|
+
/**
|
|
1031
|
+
* Creates request options for getProvisioningStatus without sending the request
|
|
1032
|
+
*/
|
|
1033
|
+
getProvisioningStatusRequestOpts(requestParameters: GetProvisioningStatusRequest): Promise<runtime.RequestOpts>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Returns the provisioning status and log for a business.
|
|
1036
|
+
* Get provisioning status
|
|
1037
|
+
*/
|
|
1038
|
+
getProvisioningStatusRaw(requestParameters: GetProvisioningStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
1039
|
+
/**
|
|
1040
|
+
* Returns the provisioning status and log for a business.
|
|
1041
|
+
* Get provisioning status
|
|
1042
|
+
*/
|
|
1043
|
+
getProvisioningStatus(requestParameters: GetProvisioningStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Creates request options for getTeamsAuthState without sending the request
|
|
1046
|
+
*/
|
|
1047
|
+
getTeamsAuthStateRequestOpts(requestParameters: GetTeamsAuthStateRequest): Promise<runtime.RequestOpts>;
|
|
1048
|
+
/**
|
|
1049
|
+
* Service-to-service: returns the stored Playwright storageState JSON for the business (teams-auth-state secret), or 404 when unset. Used by the Olaf realtime-tokens cron to deliver each business\'s session to the teams-client auth-state dir.
|
|
1050
|
+
* Read the business\'s stored Teams authenticated join session
|
|
1051
|
+
*/
|
|
1052
|
+
getTeamsAuthStateRaw(requestParameters: GetTeamsAuthStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TeamsAuthStateResponse>>;
|
|
1053
|
+
/**
|
|
1054
|
+
* Service-to-service: returns the stored Playwright storageState JSON for the business (teams-auth-state secret), or 404 when unset. Used by the Olaf realtime-tokens cron to deliver each business\'s session to the teams-client auth-state dir.
|
|
1055
|
+
* Read the business\'s stored Teams authenticated join session
|
|
1056
|
+
*/
|
|
1057
|
+
getTeamsAuthState(requestParameters: GetTeamsAuthStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TeamsAuthStateResponse>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Creates request options for getTeamsUserAcsToken without sending the request
|
|
1060
|
+
*/
|
|
1061
|
+
getTeamsUserAcsTokenRequestOpts(requestParameters: GetTeamsUserAcsTokenRequest): Promise<runtime.RequestOpts>;
|
|
1062
|
+
/**
|
|
1063
|
+
* Service-to-service: exchanges the business\'s stored Microsoft refresh token for an Azure Communication Services access token that lets the teams-client join Teams meetings authenticated as the connected org user (bypassing the lobby). Returns 404 when the Microsoft account is not connected or ACS is not configured.
|
|
1064
|
+
* Mint an ACS access token for the connected M365 user as a Teams user
|
|
1065
|
+
*/
|
|
1066
|
+
getTeamsUserAcsTokenRaw(requestParameters: GetTeamsUserAcsTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TeamsAcsTokenResponse>>;
|
|
1067
|
+
/**
|
|
1068
|
+
* Service-to-service: exchanges the business\'s stored Microsoft refresh token for an Azure Communication Services access token that lets the teams-client join Teams meetings authenticated as the connected org user (bypassing the lobby). Returns 404 when the Microsoft account is not connected or ACS is not configured.
|
|
1069
|
+
* Mint an ACS access token for the connected M365 user as a Teams user
|
|
1070
|
+
*/
|
|
1071
|
+
getTeamsUserAcsToken(requestParameters: GetTeamsUserAcsTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TeamsAcsTokenResponse>;
|
|
1072
|
+
/**
|
|
1073
|
+
* Creates request options for getTokenReconciliation without sending the request
|
|
1074
|
+
*/
|
|
1075
|
+
getTokenReconciliationRequestOpts(requestParameters: GetTokenReconciliationRequest): Promise<runtime.RequestOpts>;
|
|
1076
|
+
/**
|
|
1077
|
+
* Per-model comparison of the tokens we METERED (across every tenant) against the tokens Azure Monitor reports for the shared AI Foundry resource, for one month. Surfaces metering drift (registered < Azure = a metering hole; registered > Azure = over-counting). Operator only.
|
|
1078
|
+
* Reconcile registered AI tokens against Azure\'s reported tokens
|
|
1079
|
+
*/
|
|
1080
|
+
getTokenReconciliationRaw(requestParameters: GetTokenReconciliationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenReconciliationReport>>;
|
|
1081
|
+
/**
|
|
1082
|
+
* Per-model comparison of the tokens we METERED (across every tenant) against the tokens Azure Monitor reports for the shared AI Foundry resource, for one month. Surfaces metering drift (registered < Azure = a metering hole; registered > Azure = over-counting). Operator only.
|
|
1083
|
+
* Reconcile registered AI tokens against Azure\'s reported tokens
|
|
1084
|
+
*/
|
|
1085
|
+
getTokenReconciliation(requestParameters?: GetTokenReconciliationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenReconciliationReport>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Creates request options for getUsageDaily without sending the request
|
|
1088
|
+
*/
|
|
1089
|
+
getUsageDailyRequestOpts(requestParameters: GetUsageDailyRequest): Promise<runtime.RequestOpts>;
|
|
1090
|
+
/**
|
|
1091
|
+
* Per-meter daily quantities for a month, zero-filled up to today for the current month or to month-end for past months. Platform operators can read any business; tenant admins can read their own.
|
|
1092
|
+
* Get a month\'s usage as a daily series
|
|
1093
|
+
*/
|
|
1094
|
+
getUsageDailyRaw(requestParameters: GetUsageDailyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageDailySeries>>;
|
|
1095
|
+
/**
|
|
1096
|
+
* Per-meter daily quantities for a month, zero-filled up to today for the current month or to month-end for past months. Platform operators can read any business; tenant admins can read their own.
|
|
1097
|
+
* Get a month\'s usage as a daily series
|
|
1098
|
+
*/
|
|
1099
|
+
getUsageDaily(requestParameters: GetUsageDailyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageDailySeries>;
|
|
1100
|
+
/**
|
|
1101
|
+
* Creates request options for getUsageMeterDecision without sending the request
|
|
1102
|
+
*/
|
|
1103
|
+
getUsageMeterDecisionRequestOpts(requestParameters: GetUsageMeterDecisionRequest): Promise<runtime.RequestOpts>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Returns whether a tenant may perform another metered action on the given meter right now, computed from the current month\'s usage via the shared MeterPolicy. For out-of-process producers (the Olaf bridge) that can\'t run MeterGuard in-process. Operator only.
|
|
1106
|
+
* Request-time enforcement decision for one meter
|
|
1107
|
+
*/
|
|
1108
|
+
getUsageMeterDecisionRaw(requestParameters: GetUsageMeterDecisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MeterEnforcementDecision>>;
|
|
1109
|
+
/**
|
|
1110
|
+
* Returns whether a tenant may perform another metered action on the given meter right now, computed from the current month\'s usage via the shared MeterPolicy. For out-of-process producers (the Olaf bridge) that can\'t run MeterGuard in-process. Operator only.
|
|
1111
|
+
* Request-time enforcement decision for one meter
|
|
1112
|
+
*/
|
|
1113
|
+
getUsageMeterDecision(requestParameters: GetUsageMeterDecisionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MeterEnforcementDecision>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Creates request options for getUsageRollup without sending the request
|
|
1116
|
+
*/
|
|
1117
|
+
getUsageRollupRequestOpts(requestParameters: GetUsageRollupRequest): Promise<runtime.RequestOpts>;
|
|
1118
|
+
/**
|
|
1119
|
+
* Aggregates per-meter usage, overage and cost for every business in the fleet for one month. Operator only.
|
|
1120
|
+
* Get a month\'s usage rollup across all businesses
|
|
1121
|
+
*/
|
|
1122
|
+
getUsageRollupRaw(requestParameters: GetUsageRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageRollup>>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Aggregates per-meter usage, overage and cost for every business in the fleet for one month. Operator only.
|
|
1125
|
+
* Get a month\'s usage rollup across all businesses
|
|
1126
|
+
*/
|
|
1127
|
+
getUsageRollup(requestParameters?: GetUsageRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageRollup>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Creates request options for getUsageSummary without sending the request
|
|
1130
|
+
*/
|
|
1131
|
+
getUsageSummaryRequestOpts(requestParameters: GetUsageSummaryRequest): Promise<runtime.RequestOpts>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Per-meter usage for a month with entitlement limits, overage and cost preview. Platform operators can read any business; tenant admins can read their own.
|
|
1134
|
+
* Get a month\'s usage summary
|
|
1135
|
+
*/
|
|
1136
|
+
getUsageSummaryRaw(requestParameters: GetUsageSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageSummary>>;
|
|
1137
|
+
/**
|
|
1138
|
+
* Per-meter usage for a month with entitlement limits, overage and cost preview. Platform operators can read any business; tenant admins can read their own.
|
|
1139
|
+
* Get a month\'s usage summary
|
|
1140
|
+
*/
|
|
1141
|
+
getUsageSummary(requestParameters: GetUsageSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageSummary>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Creates request options for getWorkRepos without sending the request
|
|
1144
|
+
*/
|
|
1145
|
+
getWorkReposRequestOpts(requestParameters: GetWorkReposRequest): Promise<runtime.RequestOpts>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Returns the GitHub repos the business has chosen for Olaf to clone into its VM and work on.
|
|
1148
|
+
* Get the repos Olaf works on
|
|
1149
|
+
*/
|
|
1150
|
+
getWorkReposRaw(requestParameters: GetWorkReposRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkReposSelection>>;
|
|
1151
|
+
/**
|
|
1152
|
+
* Returns the GitHub repos the business has chosen for Olaf to clone into its VM and work on.
|
|
1153
|
+
* Get the repos Olaf works on
|
|
1154
|
+
*/
|
|
1155
|
+
getWorkRepos(requestParameters: GetWorkReposRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkReposSelection>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Creates request options for getWorkspaceRepo without sending the request
|
|
1158
|
+
*/
|
|
1159
|
+
getWorkspaceRepoRequestOpts(requestParameters: GetWorkspaceRepoRequest): Promise<runtime.RequestOpts>;
|
|
1160
|
+
/**
|
|
1161
|
+
* Returns the GitHub repo the business has chosen for syncing its Olaf workspace, if any.
|
|
1162
|
+
* Get the selected workspace repository
|
|
1163
|
+
*/
|
|
1164
|
+
getWorkspaceRepoRaw(requestParameters: GetWorkspaceRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceRepoSelection>>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Returns the GitHub repo the business has chosen for syncing its Olaf workspace, if any.
|
|
1167
|
+
* Get the selected workspace repository
|
|
1168
|
+
*/
|
|
1169
|
+
getWorkspaceRepo(requestParameters: GetWorkspaceRepoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceRepoSelection | null | undefined>;
|
|
1170
|
+
/**
|
|
1171
|
+
* Creates request options for ingestUsageEvents without sending the request
|
|
1172
|
+
*/
|
|
1173
|
+
ingestUsageEventsRequestOpts(requestParameters: IngestUsageEventsRequest): Promise<runtime.RequestOpts>;
|
|
1174
|
+
/**
|
|
1175
|
+
* Accepts a batch of usage events from pooled backends and aggregates them into per-tenant/meter/day counters. Accepts platform service principals (managed-identity tokens) and platform operators (delegated tokens) so local development flushes through the developer\'s az session.
|
|
1176
|
+
* Ingest usage events
|
|
1177
|
+
*/
|
|
1178
|
+
ingestUsageEventsRaw(requestParameters: IngestUsageEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1179
|
+
/**
|
|
1180
|
+
* Accepts a batch of usage events from pooled backends and aggregates them into per-tenant/meter/day counters. Accepts platform service principals (managed-identity tokens) and platform operators (delegated tokens) so local development flushes through the developer\'s az session.
|
|
1181
|
+
* Ingest usage events
|
|
1182
|
+
*/
|
|
1183
|
+
ingestUsageEvents(requestParameters: IngestUsageEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1184
|
+
/**
|
|
1185
|
+
* Creates request options for inviteCredential without sending the request
|
|
1186
|
+
*/
|
|
1187
|
+
inviteCredentialRequestOpts(requestParameters: InviteCredentialOperationRequest): Promise<runtime.RequestOpts>;
|
|
1188
|
+
/**
|
|
1189
|
+
* Creates (or re-invites) a password credential for the e-mail and sends the activation link. Already-activated credentials are returned unchanged without a new e-mail.
|
|
1190
|
+
* Invite a user to password login
|
|
1191
|
+
*/
|
|
1192
|
+
inviteCredentialRaw(requestParameters: InviteCredentialOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CredentialSummary>>;
|
|
1193
|
+
/**
|
|
1194
|
+
* Creates (or re-invites) a password credential for the e-mail and sends the activation link. Already-activated credentials are returned unchanged without a new e-mail.
|
|
1195
|
+
* Invite a user to password login
|
|
1196
|
+
*/
|
|
1197
|
+
inviteCredential(requestParameters: InviteCredentialOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CredentialSummary>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Creates request options for listAccountingProducts without sending the request
|
|
1200
|
+
*/
|
|
1201
|
+
listAccountingProductsRequestOpts(requestParameters: ListAccountingProductsRequest): Promise<runtime.RequestOpts>;
|
|
1202
|
+
/**
|
|
1203
|
+
* Returns the connected accounting client\'s products (code + name) and the currently selected re-invoice product code, for the dropdown.
|
|
1204
|
+
* List accounting products
|
|
1205
|
+
*/
|
|
1206
|
+
listAccountingProductsRaw(requestParameters: ListAccountingProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PowerOfficeProductsResponse>>;
|
|
1207
|
+
/**
|
|
1208
|
+
* Returns the connected accounting client\'s products (code + name) and the currently selected re-invoice product code, for the dropdown.
|
|
1209
|
+
* List accounting products
|
|
1210
|
+
*/
|
|
1211
|
+
listAccountingProducts(requestParameters: ListAccountingProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PowerOfficeProductsResponse>;
|
|
1212
|
+
/**
|
|
1213
|
+
* Creates request options for listAccountingProjects without sending the request
|
|
1214
|
+
*/
|
|
1215
|
+
listAccountingProjectsRequestOpts(requestParameters: ListAccountingProjectsRequest): Promise<runtime.RequestOpts>;
|
|
1216
|
+
/**
|
|
1217
|
+
* Returns the connected accounting client\'s projects (code + name) and the currently selected gadgets project code, for the dropdown.
|
|
1218
|
+
* List accounting projects
|
|
1219
|
+
*/
|
|
1220
|
+
listAccountingProjectsRaw(requestParameters: ListAccountingProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PowerOfficeProjectsResponse>>;
|
|
1221
|
+
/**
|
|
1222
|
+
* Returns the connected accounting client\'s projects (code + name) and the currently selected gadgets project code, for the dropdown.
|
|
1223
|
+
* List accounting projects
|
|
1224
|
+
*/
|
|
1225
|
+
listAccountingProjects(requestParameters: ListAccountingProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PowerOfficeProjectsResponse>;
|
|
1226
|
+
/**
|
|
1227
|
+
* Creates request options for listApiTokens without sending the request
|
|
1228
|
+
*/
|
|
1229
|
+
listApiTokensRequestOpts(requestParameters: ListApiTokensRequest): Promise<runtime.RequestOpts>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Lists a business\'s API tokens by fingerprint. Never returns the raw token.
|
|
1232
|
+
* List API tokens
|
|
1233
|
+
*/
|
|
1234
|
+
listApiTokensRaw(requestParameters: ListApiTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiTokenSummary>>>;
|
|
1235
|
+
/**
|
|
1236
|
+
* Lists a business\'s API tokens by fingerprint. Never returns the raw token.
|
|
1237
|
+
* List API tokens
|
|
1238
|
+
*/
|
|
1239
|
+
listApiTokens(requestParameters: ListApiTokensRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiTokenSummary>>;
|
|
1240
|
+
/**
|
|
1241
|
+
* Creates request options for listApps without sending the request
|
|
1242
|
+
*/
|
|
1243
|
+
listAppsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1244
|
+
/**
|
|
1245
|
+
* Static metadata for every product app (subdomain, type, env-key, module). The single source of the app→subdomain mapping for frontends and the operator UI.
|
|
1246
|
+
* List the product app catalog
|
|
1247
|
+
*/
|
|
1248
|
+
listAppsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AppCatalogEntry>>>;
|
|
1249
|
+
/**
|
|
1250
|
+
* Static metadata for every product app (subdomain, type, env-key, module). The single source of the app→subdomain mapping for frontends and the operator UI.
|
|
1251
|
+
* List the product app catalog
|
|
1252
|
+
*/
|
|
1253
|
+
listApps(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AppCatalogEntry>>;
|
|
1254
|
+
/**
|
|
1255
|
+
* Creates request options for listBusinessEmployeeSystems without sending the request
|
|
1256
|
+
*/
|
|
1257
|
+
listBusinessEmployeeSystemsRequestOpts(requestParameters: ListBusinessEmployeeSystemsRequest): Promise<runtime.RequestOpts>;
|
|
1258
|
+
/**
|
|
1259
|
+
* Proxies the tenant\'s employees API: per registered system (e.g. Salesforce), whether the employee has a seat, which app-role backs it, and the selectable roles.
|
|
1260
|
+
* List an employee\'s third-party system access
|
|
1261
|
+
*/
|
|
1262
|
+
listBusinessEmployeeSystemsRaw(requestParameters: ListBusinessEmployeeSystemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<EmployeeSystemAccess>>>;
|
|
1263
|
+
/**
|
|
1264
|
+
* Proxies the tenant\'s employees API: per registered system (e.g. Salesforce), whether the employee has a seat, which app-role backs it, and the selectable roles.
|
|
1265
|
+
* List an employee\'s third-party system access
|
|
1266
|
+
*/
|
|
1267
|
+
listBusinessEmployeeSystems(requestParameters: ListBusinessEmployeeSystemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<EmployeeSystemAccess>>;
|
|
1268
|
+
/**
|
|
1269
|
+
* Creates request options for listBusinessEmployees without sending the request
|
|
1270
|
+
*/
|
|
1271
|
+
listBusinessEmployeesRequestOpts(requestParameters: ListBusinessEmployeesRequest): Promise<runtime.RequestOpts>;
|
|
1272
|
+
/**
|
|
1273
|
+
* Returns the business\'s Sanity employees with the fields the control plane renders and edits.
|
|
1274
|
+
* List a business\'s employees
|
|
1275
|
+
*/
|
|
1276
|
+
listBusinessEmployeesRaw(requestParameters: ListBusinessEmployeesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProtectedEmployee>>>;
|
|
1277
|
+
/**
|
|
1278
|
+
* Returns the business\'s Sanity employees with the fields the control plane renders and edits.
|
|
1279
|
+
* List a business\'s employees
|
|
1280
|
+
*/
|
|
1281
|
+
listBusinessEmployees(requestParameters: ListBusinessEmployeesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProtectedEmployee>>;
|
|
1282
|
+
/**
|
|
1283
|
+
* Creates request options for listCredentials without sending the request
|
|
1284
|
+
*/
|
|
1285
|
+
listCredentialsRequestOpts(requestParameters: ListCredentialsRequest): Promise<runtime.RequestOpts>;
|
|
1286
|
+
/**
|
|
1287
|
+
* Lists the business\'s password credentials. Never returns hashes or TOTP material.
|
|
1288
|
+
* List password credentials
|
|
1289
|
+
*/
|
|
1290
|
+
listCredentialsRaw(requestParameters: ListCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CredentialSummary>>>;
|
|
1291
|
+
/**
|
|
1292
|
+
* Lists the business\'s password credentials. Never returns hashes or TOTP material.
|
|
1293
|
+
* List password credentials
|
|
1294
|
+
*/
|
|
1295
|
+
listCredentials(requestParameters: ListCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CredentialSummary>>;
|
|
1296
|
+
/**
|
|
1297
|
+
* Creates request options for listDevices without sending the request
|
|
1298
|
+
*/
|
|
1299
|
+
listDevicesRequestOpts(requestParameters: ListDevicesRequest): Promise<runtime.RequestOpts>;
|
|
1300
|
+
/**
|
|
1301
|
+
* Screens paired to this business
|
|
1302
|
+
*/
|
|
1303
|
+
listDevicesRaw(requestParameters: ListDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<DeviceScreen>>>;
|
|
1304
|
+
/**
|
|
1305
|
+
* Screens paired to this business
|
|
1306
|
+
*/
|
|
1307
|
+
listDevices(requestParameters: ListDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<DeviceScreen>>;
|
|
1308
|
+
/**
|
|
1309
|
+
* Creates request options for listFacebookAccounts without sending the request
|
|
1310
|
+
*/
|
|
1311
|
+
listFacebookAccountsRequestOpts(requestParameters: ListFacebookAccountsRequest): Promise<runtime.RequestOpts>;
|
|
1312
|
+
/**
|
|
1313
|
+
* Lists the Facebook Pages and linked Instagram Business accounts the connected user can post to, fetched live from the Graph API using the business\'s stored Facebook token.
|
|
1314
|
+
* List connectable Facebook Pages and Instagram accounts
|
|
1315
|
+
*/
|
|
1316
|
+
listFacebookAccountsRaw(requestParameters: ListFacebookAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FacebookAccount>>>;
|
|
1317
|
+
/**
|
|
1318
|
+
* Lists the Facebook Pages and linked Instagram Business accounts the connected user can post to, fetched live from the Graph API using the business\'s stored Facebook token.
|
|
1319
|
+
* List connectable Facebook Pages and Instagram accounts
|
|
1320
|
+
*/
|
|
1321
|
+
listFacebookAccounts(requestParameters: ListFacebookAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FacebookAccount>>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Creates request options for listGitHubRepos without sending the request
|
|
1324
|
+
*/
|
|
1325
|
+
listGitHubReposRequestOpts(requestParameters: ListGitHubReposRequest): Promise<runtime.RequestOpts>;
|
|
1326
|
+
/**
|
|
1327
|
+
* Lists repositories the connected GitHub account can access, fetched live from the GitHub API using the business\'s stored token. Used by the workspace repo picker.
|
|
1328
|
+
* List the business\'s GitHub repositories
|
|
1329
|
+
*/
|
|
1330
|
+
listGitHubReposRaw(requestParameters: ListGitHubReposRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GitHubRepo>>>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Lists repositories the connected GitHub account can access, fetched live from the GitHub API using the business\'s stored token. Used by the workspace repo picker.
|
|
1333
|
+
* List the business\'s GitHub repositories
|
|
1334
|
+
*/
|
|
1335
|
+
listGitHubRepos(requestParameters: ListGitHubReposRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GitHubRepo>>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Creates request options for listGoogleAnalyticsProperties without sending the request
|
|
1338
|
+
*/
|
|
1339
|
+
listGoogleAnalyticsPropertiesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1340
|
+
/**
|
|
1341
|
+
* Lists the GA4 properties the platform\'s connected Google account can read, fetched live from the Google Analytics Admin API using the platform\'s stored Google token.
|
|
1342
|
+
* List connectable Google Analytics properties
|
|
1343
|
+
*/
|
|
1344
|
+
listGoogleAnalyticsPropertiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GoogleAnalyticsProperty>>>;
|
|
1345
|
+
/**
|
|
1346
|
+
* Lists the GA4 properties the platform\'s connected Google account can read, fetched live from the Google Analytics Admin API using the platform\'s stored Google token.
|
|
1347
|
+
* List connectable Google Analytics properties
|
|
1348
|
+
*/
|
|
1349
|
+
listGoogleAnalyticsProperties(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GoogleAnalyticsProperty>>;
|
|
1350
|
+
/**
|
|
1351
|
+
* Creates request options for listIntegrations without sending the request
|
|
1352
|
+
*/
|
|
1353
|
+
listIntegrationsRequestOpts(requestParameters: ListIntegrationsRequest): Promise<runtime.RequestOpts>;
|
|
1354
|
+
/**
|
|
1355
|
+
* Returns the available integrations for a business with per-integration configuration status.
|
|
1356
|
+
* List integrations and config status
|
|
1357
|
+
*/
|
|
1358
|
+
listIntegrationsRaw(requestParameters: ListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntegrationSummary>>>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Returns the available integrations for a business with per-integration configuration status.
|
|
1361
|
+
* List integrations and config status
|
|
1362
|
+
*/
|
|
1363
|
+
listIntegrations(requestParameters: ListIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntegrationSummary>>;
|
|
1364
|
+
/**
|
|
1365
|
+
* Creates request options for listMailboxes without sending the request
|
|
1366
|
+
*/
|
|
1367
|
+
listMailboxesRequestOpts(requestParameters: ListMailboxesRequest): Promise<runtime.RequestOpts>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Mailboxes from the business\'s connected mail provider (Microsoft 365, later Google Workspace), for picking the provisjon inbox.
|
|
1370
|
+
* List the business\'s mailboxes
|
|
1371
|
+
*/
|
|
1372
|
+
listMailboxesRaw(requestParameters: ListMailboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<DirectoryMailbox>>>;
|
|
1373
|
+
/**
|
|
1374
|
+
* Mailboxes from the business\'s connected mail provider (Microsoft 365, later Google Workspace), for picking the provisjon inbox.
|
|
1375
|
+
* List the business\'s mailboxes
|
|
1376
|
+
*/
|
|
1377
|
+
listMailboxes(requestParameters: ListMailboxesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<DirectoryMailbox>>;
|
|
1378
|
+
/**
|
|
1379
|
+
* Creates request options for oAuthCallback without sending the request
|
|
1380
|
+
*/
|
|
1381
|
+
oAuthCallbackRequestOpts(requestParameters: OAuthCallbackRequest): Promise<runtime.RequestOpts>;
|
|
1382
|
+
/**
|
|
1383
|
+
* Exchanges the authorization code for a token and stores it in the business Key Vault. Authenticated by the signed state, not a bearer token.
|
|
1384
|
+
* OAuth provider redirect callback
|
|
1385
|
+
*/
|
|
1386
|
+
oAuthCallbackRaw(requestParameters: OAuthCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1387
|
+
/**
|
|
1388
|
+
* Exchanges the authorization code for a token and stores it in the business Key Vault. Authenticated by the signed state, not a bearer token.
|
|
1389
|
+
* OAuth provider redirect callback
|
|
1390
|
+
*/
|
|
1391
|
+
oAuthCallback(requestParameters: OAuthCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Creates request options for passwordActivate without sending the request
|
|
1394
|
+
*/
|
|
1395
|
+
passwordActivateRequestOpts(requestParameters: PasswordActivateRequest): Promise<runtime.RequestOpts>;
|
|
1396
|
+
/**
|
|
1397
|
+
* Consumes a single-use activation token from the invite e-mail, sets the password and returns the TOTP enrolment payload (otpauth URI + enrolment token).
|
|
1398
|
+
* Activate an invited credential
|
|
1399
|
+
*/
|
|
1400
|
+
passwordActivateRaw(requestParameters: PasswordActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActivateResult>>;
|
|
1401
|
+
/**
|
|
1402
|
+
* Consumes a single-use activation token from the invite e-mail, sets the password and returns the TOTP enrolment payload (otpauth URI + enrolment token).
|
|
1403
|
+
* Activate an invited credential
|
|
1404
|
+
*/
|
|
1405
|
+
passwordActivate(requestParameters: PasswordActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActivateResult>;
|
|
1406
|
+
/**
|
|
1407
|
+
* Creates request options for passwordAuthJwks without sending the request
|
|
1408
|
+
*/
|
|
1409
|
+
passwordAuthJwksRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1410
|
+
/**
|
|
1411
|
+
* Public signing keys for platform-issued access tokens.
|
|
1412
|
+
* JWKS for the platform issuer
|
|
1413
|
+
*/
|
|
1414
|
+
passwordAuthJwksRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
1415
|
+
/**
|
|
1416
|
+
* Public signing keys for platform-issued access tokens.
|
|
1417
|
+
* JWKS for the platform issuer
|
|
1418
|
+
*/
|
|
1419
|
+
passwordAuthJwks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Creates request options for passwordAuthLoginConfig without sending the request
|
|
1422
|
+
*/
|
|
1423
|
+
passwordAuthLoginConfigRequestOpts(requestParameters: PasswordAuthLoginConfigRequest): Promise<runtime.RequestOpts>;
|
|
1424
|
+
/**
|
|
1425
|
+
* Tells the central login page which methods to render: password is always on; Microsoft Entra SSO only when the tenant\'s plan includes it.
|
|
1426
|
+
* Login methods for a tenant host
|
|
1427
|
+
*/
|
|
1428
|
+
passwordAuthLoginConfigRaw(requestParameters: PasswordAuthLoginConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginConfig>>;
|
|
1429
|
+
/**
|
|
1430
|
+
* Tells the central login page which methods to render: password is always on; Microsoft Entra SSO only when the tenant\'s plan includes it.
|
|
1431
|
+
* Login methods for a tenant host
|
|
1432
|
+
*/
|
|
1433
|
+
passwordAuthLoginConfig(requestParameters: PasswordAuthLoginConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginConfig>;
|
|
1434
|
+
/**
|
|
1435
|
+
* Creates request options for passwordAuthOpenIdConfiguration without sending the request
|
|
1436
|
+
*/
|
|
1437
|
+
passwordAuthOpenIdConfigurationRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1438
|
+
/**
|
|
1439
|
+
* Backends point their additive JwtBearer scheme at this document.
|
|
1440
|
+
* OIDC discovery for the platform issuer
|
|
1441
|
+
*/
|
|
1442
|
+
passwordAuthOpenIdConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
1443
|
+
/**
|
|
1444
|
+
* Backends point their additive JwtBearer scheme at this document.
|
|
1445
|
+
* OIDC discovery for the platform issuer
|
|
1446
|
+
*/
|
|
1447
|
+
passwordAuthOpenIdConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
1448
|
+
/**
|
|
1449
|
+
* Creates request options for passwordAuthSignupConfig without sending the request
|
|
1450
|
+
*/
|
|
1451
|
+
passwordAuthSignupConfigRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1452
|
+
/**
|
|
1453
|
+
* Host-independent flag the marketing signup form reads to decide whether to show the inline password + 2FA fields. Always true — password signup is the only signup.
|
|
1454
|
+
* Whether password-first signup is enabled
|
|
1455
|
+
*/
|
|
1456
|
+
passwordAuthSignupConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignupConfig>>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Host-independent flag the marketing signup form reads to decide whether to show the inline password + 2FA fields. Always true — password signup is the only signup.
|
|
1459
|
+
* Whether password-first signup is enabled
|
|
1460
|
+
*/
|
|
1461
|
+
passwordAuthSignupConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignupConfig>;
|
|
1462
|
+
/**
|
|
1463
|
+
* Creates request options for passwordEnrollTotp without sending the request
|
|
1464
|
+
*/
|
|
1465
|
+
passwordEnrollTotpRequestOpts(requestParameters: PasswordEnrollTotpRequest): Promise<runtime.RequestOpts>;
|
|
1466
|
+
/**
|
|
1467
|
+
* Verifies the first authenticator code against the enrolment token, enables TOTP, and returns the single-view recovery codes plus a login bundle.
|
|
1468
|
+
* Confirm TOTP enrolment
|
|
1469
|
+
*/
|
|
1470
|
+
passwordEnrollTotpRaw(requestParameters: PasswordEnrollTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TotpEnrollResult>>;
|
|
1471
|
+
/**
|
|
1472
|
+
* Verifies the first authenticator code against the enrolment token, enables TOTP, and returns the single-view recovery codes plus a login bundle.
|
|
1473
|
+
* Confirm TOTP enrolment
|
|
1474
|
+
*/
|
|
1475
|
+
passwordEnrollTotp(requestParameters: PasswordEnrollTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotpEnrollResult>;
|
|
1476
|
+
/**
|
|
1477
|
+
* Creates request options for passwordLogin without sending the request
|
|
1478
|
+
*/
|
|
1479
|
+
passwordLoginRequestOpts(requestParameters: PasswordLoginOperationRequest): Promise<runtime.RequestOpts>;
|
|
1480
|
+
/**
|
|
1481
|
+
* Verifies tenant-user credentials for the business serving the given host. Returns a refresh token on success; flat error codes otherwise (no account enumeration).
|
|
1482
|
+
* Log in with email, password and TOTP code
|
|
1483
|
+
*/
|
|
1484
|
+
passwordLoginRaw(requestParameters: PasswordLoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasswordLoginResult>>;
|
|
1485
|
+
/**
|
|
1486
|
+
* Verifies tenant-user credentials for the business serving the given host. Returns a refresh token on success; flat error codes otherwise (no account enumeration).
|
|
1487
|
+
* Log in with email, password and TOTP code
|
|
1488
|
+
*/
|
|
1489
|
+
passwordLogin(requestParameters: PasswordLoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasswordLoginResult>;
|
|
1490
|
+
/**
|
|
1491
|
+
* Creates request options for passwordResetConfirm without sending the request
|
|
1492
|
+
*/
|
|
1493
|
+
passwordResetConfirmRequestOpts(requestParameters: PasswordResetConfirmRequest): Promise<runtime.RequestOpts>;
|
|
1494
|
+
/**
|
|
1495
|
+
* Consumes a single-use reset token. When TOTP is enrolled, a valid authenticator code or recovery code is required. Revokes all refresh tokens on success.
|
|
1496
|
+
* Set a new password with a reset token
|
|
1497
|
+
*/
|
|
1498
|
+
passwordResetConfirmRaw(requestParameters: PasswordResetConfirmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Consumes a single-use reset token. When TOTP is enrolled, a valid authenticator code or recovery code is required. Revokes all refresh tokens on success.
|
|
1501
|
+
* Set a new password with a reset token
|
|
1502
|
+
*/
|
|
1503
|
+
passwordResetConfirm(requestParameters: PasswordResetConfirmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1504
|
+
/**
|
|
1505
|
+
* Creates request options for passwordResetRequest without sending the request
|
|
1506
|
+
*/
|
|
1507
|
+
passwordResetRequestRequestOpts(requestParameters: PasswordResetRequestRequest): Promise<runtime.RequestOpts>;
|
|
1508
|
+
/**
|
|
1509
|
+
* Always returns 202 regardless of whether the account exists (no enumeration). Active credentials receive a single-use, one-hour reset link.
|
|
1510
|
+
* Request a password-reset e-mail
|
|
1511
|
+
*/
|
|
1512
|
+
passwordResetRequestRaw(requestParameters: PasswordResetRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1513
|
+
/**
|
|
1514
|
+
* Always returns 202 regardless of whether the account exists (no enumeration). Active credentials receive a single-use, one-hour reset link.
|
|
1515
|
+
* Request a password-reset e-mail
|
|
1516
|
+
*/
|
|
1517
|
+
passwordResetRequest(requestParameters: PasswordResetRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1518
|
+
/**
|
|
1519
|
+
* Creates request options for passwordSessionBootstrap without sending the request
|
|
1520
|
+
*/
|
|
1521
|
+
passwordSessionBootstrapRequestOpts(requestParameters: PasswordSessionBootstrapRequest): Promise<runtime.RequestOpts>;
|
|
1522
|
+
/**
|
|
1523
|
+
* Trades the short-lived single-use bootstrap token from TOTP enrolment for a durable session (refresh token). Called server-side by the auth layer so the refresh token never reaches browser JavaScript.
|
|
1524
|
+
* Redeem an enrolment bootstrap token
|
|
1525
|
+
*/
|
|
1526
|
+
passwordSessionBootstrapRaw(requestParameters: PasswordSessionBootstrapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasswordLoginResult>>;
|
|
1527
|
+
/**
|
|
1528
|
+
* Trades the short-lived single-use bootstrap token from TOTP enrolment for a durable session (refresh token). Called server-side by the auth layer so the refresh token never reaches browser JavaScript.
|
|
1529
|
+
* Redeem an enrolment bootstrap token
|
|
1530
|
+
*/
|
|
1531
|
+
passwordSessionBootstrap(requestParameters: PasswordSessionBootstrapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasswordLoginResult>;
|
|
1532
|
+
/**
|
|
1533
|
+
* Creates request options for passwordTokenExchange without sending the request
|
|
1534
|
+
*/
|
|
1535
|
+
passwordTokenExchangeRequestOpts(requestParameters: PasswordTokenExchangeRequest): Promise<runtime.RequestOpts>;
|
|
1536
|
+
/**
|
|
1537
|
+
* Returns a one-hour platform-issued JWT that backends accept additively next to Entra.
|
|
1538
|
+
* Exchange a refresh token for an access token
|
|
1539
|
+
*/
|
|
1540
|
+
passwordTokenExchangeRaw(requestParameters: PasswordTokenExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenExchangeResult>>;
|
|
1541
|
+
/**
|
|
1542
|
+
* Returns a one-hour platform-issued JWT that backends accept additively next to Entra.
|
|
1543
|
+
* Exchange a refresh token for an access token
|
|
1544
|
+
*/
|
|
1545
|
+
passwordTokenExchange(requestParameters: PasswordTokenExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenExchangeResult>;
|
|
1546
|
+
/**
|
|
1547
|
+
* Creates request options for passwordTokenRevoke without sending the request
|
|
1548
|
+
*/
|
|
1549
|
+
passwordTokenRevokeRequestOpts(requestParameters: PasswordTokenRevokeRequest): Promise<runtime.RequestOpts>;
|
|
1550
|
+
/**
|
|
1551
|
+
* Idempotent; always returns 204.
|
|
1552
|
+
* Revoke a refresh token
|
|
1553
|
+
*/
|
|
1554
|
+
passwordTokenRevokeRaw(requestParameters: PasswordTokenRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1555
|
+
/**
|
|
1556
|
+
* Idempotent; always returns 204.
|
|
1557
|
+
* Revoke a refresh token
|
|
1558
|
+
*/
|
|
1559
|
+
passwordTokenRevoke(requestParameters: PasswordTokenRevokeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1560
|
+
/**
|
|
1561
|
+
* Creates request options for patchBusiness without sending the request
|
|
1562
|
+
*/
|
|
1563
|
+
patchBusinessRequestOpts(requestParameters: PatchBusinessOperationRequest): Promise<runtime.RequestOpts>;
|
|
1564
|
+
/**
|
|
1565
|
+
* Partially updates a business.
|
|
1566
|
+
* Update a business
|
|
1567
|
+
*/
|
|
1568
|
+
patchBusinessRaw(requestParameters: PatchBusinessOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
1569
|
+
/**
|
|
1570
|
+
* Partially updates a business.
|
|
1571
|
+
* Update a business
|
|
1572
|
+
*/
|
|
1573
|
+
patchBusiness(requestParameters: PatchBusinessOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
1574
|
+
/**
|
|
1575
|
+
* Creates request options for patchBusinessEmployee without sending the request
|
|
1576
|
+
*/
|
|
1577
|
+
patchBusinessEmployeeRequestOpts(requestParameters: PatchBusinessEmployeeRequest): Promise<runtime.RequestOpts>;
|
|
1578
|
+
/**
|
|
1579
|
+
* Update an employee\'s status or group membership
|
|
1580
|
+
*/
|
|
1581
|
+
patchBusinessEmployeeRaw(requestParameters: PatchBusinessEmployeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProtectedEmployee>>;
|
|
1582
|
+
/**
|
|
1583
|
+
* Update an employee\'s status or group membership
|
|
1584
|
+
*/
|
|
1585
|
+
patchBusinessEmployee(requestParameters: PatchBusinessEmployeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProtectedEmployee>;
|
|
1586
|
+
/**
|
|
1587
|
+
* Creates request options for powerOfficeOnboardingCallback without sending the request
|
|
1588
|
+
*/
|
|
1589
|
+
powerOfficeOnboardingCallbackRequestOpts(requestParameters: PowerOfficeOnboardingCallbackRequest): Promise<runtime.RequestOpts>;
|
|
1590
|
+
/**
|
|
1591
|
+
* Server-to-server: PowerOffice posts the approved client key here. Authenticated by the signed reference in the path, not a bearer token.
|
|
1592
|
+
* PowerOffice onboarding callback
|
|
1593
|
+
*/
|
|
1594
|
+
powerOfficeOnboardingCallbackRaw(requestParameters: PowerOfficeOnboardingCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1595
|
+
/**
|
|
1596
|
+
* Server-to-server: PowerOffice posts the approved client key here. Authenticated by the signed reference in the path, not a bearer token.
|
|
1597
|
+
* PowerOffice onboarding callback
|
|
1598
|
+
*/
|
|
1599
|
+
powerOfficeOnboardingCallback(requestParameters: PowerOfficeOnboardingCallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1600
|
+
/**
|
|
1601
|
+
* Creates request options for powerOfficeOnboardingReturn without sending the request
|
|
1602
|
+
*/
|
|
1603
|
+
powerOfficeOnboardingReturnRequestOpts(requestParameters: PowerOfficeOnboardingReturnRequest): Promise<runtime.RequestOpts>;
|
|
1604
|
+
/**
|
|
1605
|
+
* Browser landing after the customer approves. Redirects back to the management surface.
|
|
1606
|
+
* PowerOffice onboarding return
|
|
1607
|
+
*/
|
|
1608
|
+
powerOfficeOnboardingReturnRaw(requestParameters: PowerOfficeOnboardingReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1609
|
+
/**
|
|
1610
|
+
* Browser landing after the customer approves. Redirects back to the management surface.
|
|
1611
|
+
* PowerOffice onboarding return
|
|
1612
|
+
*/
|
|
1613
|
+
powerOfficeOnboardingReturn(requestParameters: PowerOfficeOnboardingReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1614
|
+
/**
|
|
1615
|
+
* Creates request options for previewBillingInvoice without sending the request
|
|
1616
|
+
*/
|
|
1617
|
+
previewBillingInvoiceRequestOpts(requestParameters: PreviewBillingInvoiceRequest): Promise<runtime.RequestOpts>;
|
|
1618
|
+
/**
|
|
1619
|
+
* Computes the invoice basis (plan seat line and metered overage lines) for a business and month without creating anything in PowerOffice. Operator only.
|
|
1620
|
+
* Preview a month\'s invoice basis
|
|
1621
|
+
*/
|
|
1622
|
+
previewBillingInvoiceRaw(requestParameters: PreviewBillingInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceBasis>>;
|
|
1623
|
+
/**
|
|
1624
|
+
* Computes the invoice basis (plan seat line and metered overage lines) for a business and month without creating anything in PowerOffice. Operator only.
|
|
1625
|
+
* Preview a month\'s invoice basis
|
|
1626
|
+
*/
|
|
1627
|
+
previewBillingInvoice(requestParameters: PreviewBillingInvoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceBasis>;
|
|
1628
|
+
/**
|
|
1629
|
+
* Creates request options for previewDevice without sending the request
|
|
1630
|
+
*/
|
|
1631
|
+
previewDeviceRequestOpts(requestParameters: PreviewDeviceRequest): Promise<runtime.RequestOpts>;
|
|
1632
|
+
/**
|
|
1633
|
+
* Shows what is being approved so it is never a blind confirmation. Unknown, expired and already-approved codes all return 404.
|
|
1634
|
+
* Look up a pairing code before approving
|
|
1635
|
+
*/
|
|
1636
|
+
previewDeviceRaw(requestParameters: PreviewDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PendingDevicePreview>>;
|
|
1637
|
+
/**
|
|
1638
|
+
* Shows what is being approved so it is never a blind confirmation. Unknown, expired and already-approved codes all return 404.
|
|
1639
|
+
* Look up a pairing code before approving
|
|
1640
|
+
*/
|
|
1641
|
+
previewDevice(requestParameters: PreviewDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingDevicePreview>;
|
|
1642
|
+
/**
|
|
1643
|
+
* Creates request options for provisionBusiness without sending the request
|
|
1644
|
+
*/
|
|
1645
|
+
provisionBusinessRequestOpts(requestParameters: ProvisionBusinessRequest): Promise<runtime.RequestOpts>;
|
|
1646
|
+
/**
|
|
1647
|
+
* Triggers the provisioning workflow for a business.
|
|
1648
|
+
* Provision a business
|
|
1649
|
+
*/
|
|
1650
|
+
provisionBusinessRaw(requestParameters: ProvisionBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
1651
|
+
/**
|
|
1652
|
+
* Triggers the provisioning workflow for a business.
|
|
1653
|
+
* Provision a business
|
|
1654
|
+
*/
|
|
1655
|
+
provisionBusiness(requestParameters: ProvisionBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
1656
|
+
/**
|
|
1657
|
+
* Creates request options for publicCapabilities without sending the request
|
|
1658
|
+
*/
|
|
1659
|
+
publicCapabilitiesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1660
|
+
/**
|
|
1661
|
+
* Returns the capabilities that modules depend on, each fulfilled by one or more integration providers.
|
|
1662
|
+
* Get capabilities
|
|
1663
|
+
*/
|
|
1664
|
+
publicCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Capability>>>;
|
|
1665
|
+
/**
|
|
1666
|
+
* Returns the capabilities that modules depend on, each fulfilled by one or more integration providers.
|
|
1667
|
+
* Get capabilities
|
|
1668
|
+
*/
|
|
1669
|
+
publicCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Capability>>;
|
|
1670
|
+
/**
|
|
1671
|
+
* Creates request options for publicModules without sending the request
|
|
1672
|
+
*/
|
|
1673
|
+
publicModulesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1674
|
+
/**
|
|
1675
|
+
* Returns all available app modules for business signup.
|
|
1676
|
+
* Get available modules
|
|
1677
|
+
*/
|
|
1678
|
+
publicModulesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AppModule>>>;
|
|
1679
|
+
/**
|
|
1680
|
+
* Returns all available app modules for business signup.
|
|
1681
|
+
* Get available modules
|
|
1682
|
+
*/
|
|
1683
|
+
publicModules(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AppModule>>;
|
|
1684
|
+
/**
|
|
1685
|
+
* Creates request options for publicPlans without sending the request
|
|
1686
|
+
*/
|
|
1687
|
+
publicPlansRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1688
|
+
/**
|
|
1689
|
+
* Returns all plans with their user limits, module access and meter entitlements, straight from the entitlements table.
|
|
1690
|
+
* Get available plans
|
|
1691
|
+
*/
|
|
1692
|
+
publicPlansRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PlanInfo>>>;
|
|
1693
|
+
/**
|
|
1694
|
+
* Returns all plans with their user limits, module access and meter entitlements, straight from the entitlements table.
|
|
1695
|
+
* Get available plans
|
|
1696
|
+
*/
|
|
1697
|
+
publicPlans(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PlanInfo>>;
|
|
1698
|
+
/**
|
|
1699
|
+
* Creates request options for publicSignup without sending the request
|
|
1700
|
+
*/
|
|
1701
|
+
publicSignupRequestOpts(requestParameters: PublicSignupRequest): Promise<runtime.RequestOpts>;
|
|
1702
|
+
/**
|
|
1703
|
+
* Creates a new business, its Key Vault, and the founder\'s password credential, and returns the TOTP enrolment payload so 2FA is set up before the account is usable. A password is required.
|
|
1704
|
+
* Submit business signup
|
|
1705
|
+
*/
|
|
1706
|
+
publicSignupRaw(requestParameters: PublicSignupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignupResult>>;
|
|
1707
|
+
/**
|
|
1708
|
+
* Creates a new business, its Key Vault, and the founder\'s password credential, and returns the TOTP enrolment payload so 2FA is set up before the account is usable. A password is required.
|
|
1709
|
+
* Submit business signup
|
|
1710
|
+
*/
|
|
1711
|
+
publicSignup(requestParameters: PublicSignupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignupResult>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Creates request options for recordImpersonationActivity without sending the request
|
|
1714
|
+
*/
|
|
1715
|
+
recordImpersonationActivityRequestOpts(requestParameters: RecordImpersonationActivityOperationRequest): Promise<runtime.RequestOpts>;
|
|
1716
|
+
/**
|
|
1717
|
+
* Service-to-service only. Backends call this for every request made with an impersonation token, so the audit log holds the actions, not just the session.
|
|
1718
|
+
* Record one action performed in a view-as-employee session
|
|
1719
|
+
*/
|
|
1720
|
+
recordImpersonationActivityRaw(requestParameters: RecordImpersonationActivityOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1721
|
+
/**
|
|
1722
|
+
* Service-to-service only. Backends call this for every request made with an impersonation token, so the audit log holds the actions, not just the session.
|
|
1723
|
+
* Record one action performed in a view-as-employee session
|
|
1724
|
+
*/
|
|
1725
|
+
recordImpersonationActivity(requestParameters: RecordImpersonationActivityOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1726
|
+
/**
|
|
1727
|
+
* Creates request options for renameDevice without sending the request
|
|
1728
|
+
*/
|
|
1729
|
+
renameDeviceRequestOpts(requestParameters: RenameDeviceOperationRequest): Promise<runtime.RequestOpts>;
|
|
1730
|
+
/**
|
|
1731
|
+
* Rename a screen
|
|
1732
|
+
*/
|
|
1733
|
+
renameDeviceRaw(requestParameters: RenameDeviceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1734
|
+
/**
|
|
1735
|
+
* Rename a screen
|
|
1736
|
+
*/
|
|
1737
|
+
renameDevice(requestParameters: RenameDeviceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1738
|
+
/**
|
|
1739
|
+
* Creates request options for requestUpgrade without sending the request
|
|
1740
|
+
*/
|
|
1741
|
+
requestUpgradeRequestOpts(requestParameters: RequestUpgradeRequest): Promise<runtime.RequestOpts>;
|
|
1742
|
+
/**
|
|
1743
|
+
* Records interest in Enterprise so the team can open a billing conversation; an operator activates the plan afterwards.
|
|
1744
|
+
* Request an Enterprise upgrade
|
|
1745
|
+
*/
|
|
1746
|
+
requestUpgradeRaw(requestParameters: RequestUpgradeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
1747
|
+
/**
|
|
1748
|
+
* Records interest in Enterprise so the team can open a billing conversation; an operator activates the plan afterwards.
|
|
1749
|
+
* Request an Enterprise upgrade
|
|
1750
|
+
*/
|
|
1751
|
+
requestUpgrade(requestParameters: RequestUpgradeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
1752
|
+
/**
|
|
1753
|
+
* Creates request options for resetCredential without sending the request
|
|
1754
|
+
*/
|
|
1755
|
+
resetCredentialRequestOpts(requestParameters: ResetCredentialRequest): Promise<runtime.RequestOpts>;
|
|
1756
|
+
/**
|
|
1757
|
+
* Sends a password-reset e-mail to an activated user in the caller\'s business. The reset still requires the user\'s own second factor to complete.
|
|
1758
|
+
* Admin-initiated password reset
|
|
1759
|
+
*/
|
|
1760
|
+
resetCredentialRaw(requestParameters: ResetCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Sends a password-reset e-mail to an activated user in the caller\'s business. The reset still requires the user\'s own second factor to complete.
|
|
1763
|
+
* Admin-initiated password reset
|
|
1764
|
+
*/
|
|
1765
|
+
resetCredential(requestParameters: ResetCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1766
|
+
/**
|
|
1767
|
+
* Creates request options for resolvePlatformSanityConfig without sending the request
|
|
1768
|
+
*/
|
|
1769
|
+
resolvePlatformSanityConfigRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1770
|
+
/**
|
|
1771
|
+
* Returns the shared platform Sanity project, dataset, studio URL and read token used as the content fallback layer for every tenant. All four values live in platform Key Vault (editable in platform-web), so nothing Sanity-related is baked onto frontends. This is a render-path config endpoint, so it accepts any principal from the platform Entra tenant — the platform managed identity in production, or a Snøkam developer\'s az session locally — with no operator role required.
|
|
1772
|
+
* Resolve the platform Sanity read config
|
|
1773
|
+
*/
|
|
1774
|
+
resolvePlatformSanityConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlatformSanityConfig>>;
|
|
1775
|
+
/**
|
|
1776
|
+
* Returns the shared platform Sanity project, dataset, studio URL and read token used as the content fallback layer for every tenant. All four values live in platform Key Vault (editable in platform-web), so nothing Sanity-related is baked onto frontends. This is a render-path config endpoint, so it accepts any principal from the platform Entra tenant — the platform managed identity in production, or a Snøkam developer\'s az session locally — with no operator role required.
|
|
1777
|
+
* Resolve the platform Sanity read config
|
|
1778
|
+
*/
|
|
1779
|
+
resolvePlatformSanityConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlatformSanityConfig>;
|
|
1780
|
+
/**
|
|
1781
|
+
* Creates request options for resolveStudioSanityConfig without sending the request
|
|
1782
|
+
*/
|
|
1783
|
+
resolveStudioSanityConfigRequestOpts(requestParameters: ResolveStudioSanityConfigRequest): Promise<runtime.RequestOpts>;
|
|
1784
|
+
/**
|
|
1785
|
+
* Returns the non-secret Sanity project id and dataset a studio should point at for the given host. A tenant host returns that tenant\'s project; a host that belongs to no business (the platform host) returns the shared platform project. No read/write token is returned — the studio authenticates the user via Sanity login — so this is a public endpoint safe to call from a browser.
|
|
1786
|
+
* Resolve the Sanity Studio project/dataset for a host
|
|
1787
|
+
*/
|
|
1788
|
+
resolveStudioSanityConfigRaw(requestParameters: ResolveStudioSanityConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudioSanityConfig>>;
|
|
1789
|
+
/**
|
|
1790
|
+
* Returns the non-secret Sanity project id and dataset a studio should point at for the given host. A tenant host returns that tenant\'s project; a host that belongs to no business (the platform host) returns the shared platform project. No read/write token is returned — the studio authenticates the user via Sanity login — so this is a public endpoint safe to call from a browser.
|
|
1791
|
+
* Resolve the Sanity Studio project/dataset for a host
|
|
1792
|
+
*/
|
|
1793
|
+
resolveStudioSanityConfig(requestParameters: ResolveStudioSanityConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudioSanityConfig>;
|
|
1794
|
+
/**
|
|
1795
|
+
* Creates request options for resolveTenant without sending the request
|
|
1796
|
+
*/
|
|
1797
|
+
resolveTenantRequestOpts(requestParameters: ResolveTenantRequest): Promise<runtime.RequestOpts>;
|
|
1798
|
+
/**
|
|
1799
|
+
* Resolve a business to its full TenantInfo by exactly one of host, businessId or entraTenantId. Accepts platform service principals (managed-identity tokens) and platform operators (delegated tokens with the platform-operator role) so local development resolves tenants through the developer\'s az session.
|
|
1800
|
+
* Resolve a tenant
|
|
1801
|
+
*/
|
|
1802
|
+
resolveTenantRaw(requestParameters: ResolveTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantInfo>>;
|
|
1803
|
+
/**
|
|
1804
|
+
* Resolve a business to its full TenantInfo by exactly one of host, businessId or entraTenantId. Accepts platform service principals (managed-identity tokens) and platform operators (delegated tokens with the platform-operator role) so local development resolves tenants through the developer\'s az session.
|
|
1805
|
+
* Resolve a tenant
|
|
1806
|
+
*/
|
|
1807
|
+
resolveTenant(requestParameters?: ResolveTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantInfo>;
|
|
1808
|
+
/**
|
|
1809
|
+
* Creates request options for resolveTenantSanityCredentials without sending the request
|
|
1810
|
+
*/
|
|
1811
|
+
resolveTenantSanityCredentialsRequestOpts(requestParameters: ResolveTenantSanityCredentialsRequest): Promise<runtime.RequestOpts>;
|
|
1812
|
+
/**
|
|
1813
|
+
* Returns the tenant\'s Sanity project, dataset and read token for server-side content reads. This is a render-path config endpoint, so it accepts any principal from the platform Entra tenant — the platform managed identity in production, or a Snøkam developer\'s az session locally — with no operator role required.
|
|
1814
|
+
* Resolve a tenant\'s Sanity read credentials by host
|
|
1815
|
+
*/
|
|
1816
|
+
resolveTenantSanityCredentialsRaw(requestParameters: ResolveTenantSanityCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantSanityCredentials>>;
|
|
1817
|
+
/**
|
|
1818
|
+
* Returns the tenant\'s Sanity project, dataset and read token for server-side content reads. This is a render-path config endpoint, so it accepts any principal from the platform Entra tenant — the platform managed identity in production, or a Snøkam developer\'s az session locally — with no operator role required.
|
|
1819
|
+
* Resolve a tenant\'s Sanity read credentials by host
|
|
1820
|
+
*/
|
|
1821
|
+
resolveTenantSanityCredentials(requestParameters: ResolveTenantSanityCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantSanityCredentials>;
|
|
1822
|
+
/**
|
|
1823
|
+
* Creates request options for revokeApiToken without sending the request
|
|
1824
|
+
*/
|
|
1825
|
+
revokeApiTokenRequestOpts(requestParameters: RevokeApiTokenRequest): Promise<runtime.RequestOpts>;
|
|
1826
|
+
/**
|
|
1827
|
+
* Permanently revokes the token with the given fingerprint.
|
|
1828
|
+
* Revoke an API token
|
|
1829
|
+
*/
|
|
1830
|
+
revokeApiTokenRaw(requestParameters: RevokeApiTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Permanently revokes the token with the given fingerprint.
|
|
1833
|
+
* Revoke an API token
|
|
1834
|
+
*/
|
|
1835
|
+
revokeApiToken(requestParameters: RevokeApiTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1836
|
+
/**
|
|
1837
|
+
* Creates request options for revokeBusinessEmployeeSystem without sending the request
|
|
1838
|
+
*/
|
|
1839
|
+
revokeBusinessEmployeeSystemRequestOpts(requestParameters: RevokeBusinessEmployeeSystemRequest): Promise<runtime.RequestOpts>;
|
|
1840
|
+
/**
|
|
1841
|
+
* Revoke an employee\'s seat in a third-party system
|
|
1842
|
+
*/
|
|
1843
|
+
revokeBusinessEmployeeSystemRaw(requestParameters: RevokeBusinessEmployeeSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmployeeSystemAccess>>;
|
|
1844
|
+
/**
|
|
1845
|
+
* Revoke an employee\'s seat in a third-party system
|
|
1846
|
+
*/
|
|
1847
|
+
revokeBusinessEmployeeSystem(requestParameters: RevokeBusinessEmployeeSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmployeeSystemAccess>;
|
|
1848
|
+
/**
|
|
1849
|
+
* Creates request options for revokeDevice without sending the request
|
|
1850
|
+
*/
|
|
1851
|
+
revokeDeviceRequestOpts(requestParameters: RevokeDeviceRequest): Promise<runtime.RequestOpts>;
|
|
1852
|
+
/**
|
|
1853
|
+
* Revokes the screen\'s token. The screen falls back to showing a fresh pairing code by itself the next time it calls.
|
|
1854
|
+
* Revoke a screen
|
|
1855
|
+
*/
|
|
1856
|
+
revokeDeviceRaw(requestParameters: RevokeDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1857
|
+
/**
|
|
1858
|
+
* Revokes the screen\'s token. The screen falls back to showing a fresh pairing code by itself the next time it calls.
|
|
1859
|
+
* Revoke a screen
|
|
1860
|
+
*/
|
|
1861
|
+
revokeDevice(requestParameters: RevokeDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1862
|
+
/**
|
|
1863
|
+
* Creates request options for setAccountingGadgetsProject without sending the request
|
|
1864
|
+
*/
|
|
1865
|
+
setAccountingGadgetsProjectRequestOpts(requestParameters: SetAccountingGadgetsProjectRequest): Promise<runtime.RequestOpts>;
|
|
1866
|
+
/**
|
|
1867
|
+
* Stores the selected accounting gadgets project code for the business.
|
|
1868
|
+
* Set the gadgets project code
|
|
1869
|
+
*/
|
|
1870
|
+
setAccountingGadgetsProjectRaw(requestParameters: SetAccountingGadgetsProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Stores the selected accounting gadgets project code for the business.
|
|
1873
|
+
* Set the gadgets project code
|
|
1874
|
+
*/
|
|
1875
|
+
setAccountingGadgetsProject(requestParameters: SetAccountingGadgetsProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1876
|
+
/**
|
|
1877
|
+
* Creates request options for setAccountingReinvoiceProduct without sending the request
|
|
1878
|
+
*/
|
|
1879
|
+
setAccountingReinvoiceProductRequestOpts(requestParameters: SetAccountingReinvoiceProductRequest): Promise<runtime.RequestOpts>;
|
|
1880
|
+
/**
|
|
1881
|
+
* Stores the selected accounting product used for subcontractor re-invoice lines (carries the VAT).
|
|
1882
|
+
* Set the re-invoice product code
|
|
1883
|
+
*/
|
|
1884
|
+
setAccountingReinvoiceProductRaw(requestParameters: SetAccountingReinvoiceProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1885
|
+
/**
|
|
1886
|
+
* Stores the selected accounting product used for subcontractor re-invoice lines (carries the VAT).
|
|
1887
|
+
* Set the re-invoice product code
|
|
1888
|
+
*/
|
|
1889
|
+
setAccountingReinvoiceProduct(requestParameters: SetAccountingReinvoiceProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1890
|
+
/**
|
|
1891
|
+
* Creates request options for setActiveProvider without sending the request
|
|
1892
|
+
*/
|
|
1893
|
+
setActiveProviderRequestOpts(requestParameters: SetActiveProviderOperationRequest): Promise<runtime.RequestOpts>;
|
|
1894
|
+
/**
|
|
1895
|
+
* When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
|
|
1896
|
+
* Choose the active provider for a capability
|
|
1897
|
+
*/
|
|
1898
|
+
setActiveProviderRaw(requestParameters: SetActiveProviderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
1899
|
+
/**
|
|
1900
|
+
* When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
|
|
1901
|
+
* Choose the active provider for a capability
|
|
1902
|
+
*/
|
|
1903
|
+
setActiveProvider(requestParameters: SetActiveProviderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
1904
|
+
/**
|
|
1905
|
+
* Creates request options for setBusinessEmployeePhoto without sending the request
|
|
1906
|
+
*/
|
|
1907
|
+
setBusinessEmployeePhotoRequestOpts(requestParameters: SetBusinessEmployeePhotoRequest): Promise<runtime.RequestOpts>;
|
|
1908
|
+
/**
|
|
1909
|
+
* Forwards the raw image bytes to the business\'s employees API, which stores the photo and a blurred variant.
|
|
1910
|
+
* Upload an employee\'s profile photo
|
|
1911
|
+
*/
|
|
1912
|
+
setBusinessEmployeePhotoRaw(requestParameters: SetBusinessEmployeePhotoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProtectedEmployee>>;
|
|
1913
|
+
/**
|
|
1914
|
+
* Forwards the raw image bytes to the business\'s employees API, which stores the photo and a blurred variant.
|
|
1915
|
+
* Upload an employee\'s profile photo
|
|
1916
|
+
*/
|
|
1917
|
+
setBusinessEmployeePhoto(requestParameters: SetBusinessEmployeePhotoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProtectedEmployee>;
|
|
1918
|
+
/**
|
|
1919
|
+
* Creates request options for setEmployeeScopeGrants without sending the request
|
|
1920
|
+
*/
|
|
1921
|
+
setEmployeeScopeGrantsRequestOpts(requestParameters: SetEmployeeScopeGrantsRequest): Promise<runtime.RequestOpts>;
|
|
1922
|
+
/**
|
|
1923
|
+
* Set the scopes granted directly to an employee
|
|
1924
|
+
*/
|
|
1925
|
+
setEmployeeScopeGrantsRaw(requestParameters: SetEmployeeScopeGrantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1926
|
+
/**
|
|
1927
|
+
* Set the scopes granted directly to an employee
|
|
1928
|
+
*/
|
|
1929
|
+
setEmployeeScopeGrants(requestParameters: SetEmployeeScopeGrantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1930
|
+
/**
|
|
1931
|
+
* Creates request options for setFacebookSelectedAccount without sending the request
|
|
1932
|
+
*/
|
|
1933
|
+
setFacebookSelectedAccountRequestOpts(requestParameters: SetFacebookSelectedAccountRequest): Promise<runtime.RequestOpts>;
|
|
1934
|
+
/**
|
|
1935
|
+
* Persists the chosen Facebook Page or Instagram account to the business Key Vault.
|
|
1936
|
+
* Set the selected Facebook/Instagram posting account
|
|
1937
|
+
*/
|
|
1938
|
+
setFacebookSelectedAccountRaw(requestParameters: SetFacebookSelectedAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacebookAccount>>;
|
|
1939
|
+
/**
|
|
1940
|
+
* Persists the chosen Facebook Page or Instagram account to the business Key Vault.
|
|
1941
|
+
* Set the selected Facebook/Instagram posting account
|
|
1942
|
+
*/
|
|
1943
|
+
setFacebookSelectedAccount(requestParameters: SetFacebookSelectedAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacebookAccount>;
|
|
1944
|
+
/**
|
|
1945
|
+
* Creates request options for setGoogleAnalyticsSelectedProperty without sending the request
|
|
1946
|
+
*/
|
|
1947
|
+
setGoogleAnalyticsSelectedPropertyRequestOpts(requestParameters: SetGoogleAnalyticsSelectedPropertyRequest): Promise<runtime.RequestOpts>;
|
|
1948
|
+
/**
|
|
1949
|
+
* Persists the chosen GA4 property id to the platform Key Vault.
|
|
1950
|
+
* Set the selected Google Analytics property
|
|
1951
|
+
*/
|
|
1952
|
+
setGoogleAnalyticsSelectedPropertyRaw(requestParameters: SetGoogleAnalyticsSelectedPropertyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GoogleAnalyticsSelection>>;
|
|
1953
|
+
/**
|
|
1954
|
+
* Persists the chosen GA4 property id to the platform Key Vault.
|
|
1955
|
+
* Set the selected Google Analytics property
|
|
1956
|
+
*/
|
|
1957
|
+
setGoogleAnalyticsSelectedProperty(requestParameters: SetGoogleAnalyticsSelectedPropertyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GoogleAnalyticsSelection>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Creates request options for setGroupScopeGrants without sending the request
|
|
1960
|
+
*/
|
|
1961
|
+
setGroupScopeGrantsRequestOpts(requestParameters: SetGroupScopeGrantsRequest): Promise<runtime.RequestOpts>;
|
|
1962
|
+
/**
|
|
1963
|
+
* Set the scopes a group grants
|
|
1964
|
+
*/
|
|
1965
|
+
setGroupScopeGrantsRaw(requestParameters: SetGroupScopeGrantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1966
|
+
/**
|
|
1967
|
+
* Set the scopes a group grants
|
|
1968
|
+
*/
|
|
1969
|
+
setGroupScopeGrants(requestParameters: SetGroupScopeGrantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1970
|
+
/**
|
|
1971
|
+
* Creates request options for setMeSettings without sending the request
|
|
1972
|
+
*/
|
|
1973
|
+
setMeSettingsRequestOpts(requestParameters: SetMeSettingsRequest): Promise<runtime.RequestOpts>;
|
|
1974
|
+
/**
|
|
1975
|
+
* Writes the caller\'s own employee settings. A caller without an employee record is a no-op.
|
|
1976
|
+
* Update the signed-in employee\'s settings
|
|
1977
|
+
*/
|
|
1978
|
+
setMeSettingsRaw(requestParameters: SetMeSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmployeeSettings>>;
|
|
1979
|
+
/**
|
|
1980
|
+
* Writes the caller\'s own employee settings. A caller without an employee record is a no-op.
|
|
1981
|
+
* Update the signed-in employee\'s settings
|
|
1982
|
+
*/
|
|
1983
|
+
setMeSettings(requestParameters: SetMeSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmployeeSettings>;
|
|
1984
|
+
/**
|
|
1985
|
+
* Creates request options for setOlafTeamsSettings without sending the request
|
|
1986
|
+
*/
|
|
1987
|
+
setOlafTeamsSettingsRequestOpts(requestParameters: SetOlafTeamsSettingsRequest): Promise<runtime.RequestOpts>;
|
|
1988
|
+
/**
|
|
1989
|
+
* Persists the per-business Teams meeting-assistant settings. An empty voice clears the override so the bridge falls back to its deploy-time default.
|
|
1990
|
+
* Update the business\'s Olaf meeting-assistant settings
|
|
1991
|
+
*/
|
|
1992
|
+
setOlafTeamsSettingsRaw(requestParameters: SetOlafTeamsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OlafTeamsSettings>>;
|
|
1993
|
+
/**
|
|
1994
|
+
* Persists the per-business Teams meeting-assistant settings. An empty voice clears the override so the bridge falls back to its deploy-time default.
|
|
1995
|
+
* Update the business\'s Olaf meeting-assistant settings
|
|
1996
|
+
*/
|
|
1997
|
+
setOlafTeamsSettings(requestParameters: SetOlafTeamsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OlafTeamsSettings>;
|
|
1998
|
+
/**
|
|
1999
|
+
* Creates request options for setPlatformSecret without sending the request
|
|
2000
|
+
*/
|
|
2001
|
+
setPlatformSecretRequestOpts(requestParameters: SetPlatformSecretOperationRequest): Promise<runtime.RequestOpts>;
|
|
2002
|
+
/**
|
|
2003
|
+
* Sets the value of a shared platform secret. An empty value clears it.
|
|
2004
|
+
* Set a shared platform secret
|
|
2005
|
+
*/
|
|
2006
|
+
setPlatformSecretRaw(requestParameters: SetPlatformSecretOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlatformSecretStatus>>;
|
|
2007
|
+
/**
|
|
2008
|
+
* Sets the value of a shared platform secret. An empty value clears it.
|
|
2009
|
+
* Set a shared platform secret
|
|
2010
|
+
*/
|
|
2011
|
+
setPlatformSecret(requestParameters: SetPlatformSecretOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlatformSecretStatus>;
|
|
2012
|
+
/**
|
|
2013
|
+
* Creates request options for setTeamsAuthState without sending the request
|
|
2014
|
+
*/
|
|
2015
|
+
setTeamsAuthStateRequestOpts(requestParameters: SetTeamsAuthStateRequest): Promise<runtime.RequestOpts>;
|
|
2016
|
+
/**
|
|
2017
|
+
* Persists a Playwright storageState JSON blob to the business Key Vault as the teams-auth-state secret. The pooled teams-client sidecar joins Teams meetings as this signed-in org user (bypassing the lobby) using the per-business session pulled to its auth-state dir.
|
|
2018
|
+
* Store the business\'s Teams authenticated join session
|
|
2019
|
+
*/
|
|
2020
|
+
setTeamsAuthStateRaw(requestParameters: SetTeamsAuthStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
2021
|
+
/**
|
|
2022
|
+
* Persists a Playwright storageState JSON blob to the business Key Vault as the teams-auth-state secret. The pooled teams-client sidecar joins Teams meetings as this signed-in org user (bypassing the lobby) using the per-business session pulled to its auth-state dir.
|
|
2023
|
+
* Store the business\'s Teams authenticated join session
|
|
2024
|
+
*/
|
|
2025
|
+
setTeamsAuthState(requestParameters: SetTeamsAuthStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2026
|
+
/**
|
|
2027
|
+
* Creates request options for setWorkRepos without sending the request
|
|
2028
|
+
*/
|
|
2029
|
+
setWorkReposRequestOpts(requestParameters: SetWorkReposOperationRequest): Promise<runtime.RequestOpts>;
|
|
2030
|
+
/**
|
|
2031
|
+
* Persists the GitHub repos (owner/name) the Olaf deploy clones into the business VM for Olaf to work on.
|
|
2032
|
+
* Set the repos Olaf works on
|
|
2033
|
+
*/
|
|
2034
|
+
setWorkReposRaw(requestParameters: SetWorkReposOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkReposSelection>>;
|
|
2035
|
+
/**
|
|
2036
|
+
* Persists the GitHub repos (owner/name) the Olaf deploy clones into the business VM for Olaf to work on.
|
|
2037
|
+
* Set the repos Olaf works on
|
|
2038
|
+
*/
|
|
2039
|
+
setWorkRepos(requestParameters: SetWorkReposOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkReposSelection>;
|
|
2040
|
+
/**
|
|
2041
|
+
* Creates request options for setWorkspaceRepo without sending the request
|
|
2042
|
+
*/
|
|
2043
|
+
setWorkspaceRepoRequestOpts(requestParameters: SetWorkspaceRepoOperationRequest): Promise<runtime.RequestOpts>;
|
|
2044
|
+
/**
|
|
2045
|
+
* Persists the chosen GitHub repo (owner/name) the Olaf deploy pushes the workspace to.
|
|
2046
|
+
* Set the workspace repository
|
|
2047
|
+
*/
|
|
2048
|
+
setWorkspaceRepoRaw(requestParameters: SetWorkspaceRepoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceRepoSelection>>;
|
|
2049
|
+
/**
|
|
2050
|
+
* Persists the chosen GitHub repo (owner/name) the Olaf deploy pushes the workspace to.
|
|
2051
|
+
* Set the workspace repository
|
|
2052
|
+
*/
|
|
2053
|
+
setWorkspaceRepo(requestParameters: SetWorkspaceRepoOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceRepoSelection>;
|
|
2054
|
+
/**
|
|
2055
|
+
* Creates request options for ssoTokenExchange without sending the request
|
|
2056
|
+
*/
|
|
2057
|
+
ssoTokenExchangeRequestOpts(requestParameters: SsoTokenExchangeRequest): Promise<runtime.RequestOpts>;
|
|
2058
|
+
/**
|
|
2059
|
+
* Validates a token from a linked identity provider (Entra, Google) and returns a platform-issued access token for the matching business.
|
|
2060
|
+
* Exchange an SSO token for a platform token
|
|
2061
|
+
*/
|
|
2062
|
+
ssoTokenExchangeRaw(requestParameters: SsoTokenExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenExchangeResult>>;
|
|
2063
|
+
/**
|
|
2064
|
+
* Validates a token from a linked identity provider (Entra, Google) and returns a platform-issued access token for the matching business.
|
|
2065
|
+
* Exchange an SSO token for a platform token
|
|
2066
|
+
*/
|
|
2067
|
+
ssoTokenExchange(requestParameters: SsoTokenExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenExchangeResult>;
|
|
2068
|
+
/**
|
|
2069
|
+
* Creates request options for startImpersonation without sending the request
|
|
2070
|
+
*/
|
|
2071
|
+
startImpersonationRequestOpts(requestParameters: StartImpersonationOperationRequest): Promise<runtime.RequestOpts>;
|
|
2072
|
+
/**
|
|
2073
|
+
* Operator-only. Requires a typed reason. Mints a short-lived, read-only impersonation token presenting as the target employee, writes a tamper-evident audit record, and posts to Slack. Finance surfaces are unlocked only when the operator also holds platform.impersonate.finance.
|
|
2074
|
+
* Start a read-only view-as-employee session
|
|
2075
|
+
*/
|
|
2076
|
+
startImpersonationRaw(requestParameters: StartImpersonationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StartImpersonationResult>>;
|
|
2077
|
+
/**
|
|
2078
|
+
* Operator-only. Requires a typed reason. Mints a short-lived, read-only impersonation token presenting as the target employee, writes a tamper-evident audit record, and posts to Slack. Finance surfaces are unlocked only when the operator also holds platform.impersonate.finance.
|
|
2079
|
+
* Start a read-only view-as-employee session
|
|
2080
|
+
*/
|
|
2081
|
+
startImpersonation(requestParameters: StartImpersonationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StartImpersonationResult>;
|
|
2082
|
+
/**
|
|
2083
|
+
* Creates request options for startOAuthConnect without sending the request
|
|
2084
|
+
*/
|
|
2085
|
+
startOAuthConnectRequestOpts(requestParameters: StartOAuthConnectRequest): Promise<runtime.RequestOpts>;
|
|
2086
|
+
/**
|
|
2087
|
+
* Returns the provider authorize URL the browser should redirect to. The callback stores the token in the business Key Vault.
|
|
2088
|
+
* Begin an OAuth connect flow
|
|
2089
|
+
*/
|
|
2090
|
+
startOAuthConnectRaw(requestParameters: StartOAuthConnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OAuthStartResponse>>;
|
|
2091
|
+
/**
|
|
2092
|
+
* Returns the provider authorize URL the browser should redirect to. The callback stores the token in the business Key Vault.
|
|
2093
|
+
* Begin an OAuth connect flow
|
|
2094
|
+
*/
|
|
2095
|
+
startOAuthConnect(requestParameters: StartOAuthConnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthStartResponse>;
|
|
2096
|
+
/**
|
|
2097
|
+
* Creates request options for startPlatformOAuthConnect without sending the request
|
|
2098
|
+
*/
|
|
2099
|
+
startPlatformOAuthConnectRequestOpts(requestParameters: StartPlatformOAuthConnectRequest): Promise<runtime.RequestOpts>;
|
|
2100
|
+
/**
|
|
2101
|
+
* Operator-only. Connects the platform\'s own account for a provider (e.g. Slack workspace, GitHub org); the callback stores the token in the platform Key Vault.
|
|
2102
|
+
* Begin a platform-level OAuth connect flow
|
|
2103
|
+
*/
|
|
2104
|
+
startPlatformOAuthConnectRaw(requestParameters: StartPlatformOAuthConnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OAuthStartResponse>>;
|
|
2105
|
+
/**
|
|
2106
|
+
* Operator-only. Connects the platform\'s own account for a provider (e.g. Slack workspace, GitHub org); the callback stores the token in the platform Key Vault.
|
|
2107
|
+
* Begin a platform-level OAuth connect flow
|
|
2108
|
+
*/
|
|
2109
|
+
startPlatformOAuthConnect(requestParameters: StartPlatformOAuthConnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthStartResponse>;
|
|
2110
|
+
/**
|
|
2111
|
+
* Creates request options for startPowerOfficeConnect without sending the request
|
|
2112
|
+
*/
|
|
2113
|
+
startPowerOfficeConnectRequestOpts(requestParameters: StartPowerOfficeConnectRequest): Promise<runtime.RequestOpts>;
|
|
2114
|
+
/**
|
|
2115
|
+
* Mints a PowerOffice approval URL for the customer\'s organisation. The customer approves in PowerOffice Go; PowerOffice then posts the client key to our callback, which stores it in the business Key Vault.
|
|
2116
|
+
* Begin PowerOffice onboarding
|
|
2117
|
+
*/
|
|
2118
|
+
startPowerOfficeConnectRaw(requestParameters: StartPowerOfficeConnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PowerOfficeConnectResponse>>;
|
|
2119
|
+
/**
|
|
2120
|
+
* Mints a PowerOffice approval URL for the customer\'s organisation. The customer approves in PowerOffice Go; PowerOffice then posts the client key to our callback, which stores it in the business Key Vault.
|
|
2121
|
+
* Begin PowerOffice onboarding
|
|
2122
|
+
*/
|
|
2123
|
+
startPowerOfficeConnect(requestParameters: StartPowerOfficeConnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PowerOfficeConnectResponse>;
|
|
2124
|
+
/**
|
|
2125
|
+
* Creates request options for stripeWebhookReceiver without sending the request
|
|
2126
|
+
*/
|
|
2127
|
+
stripeWebhookReceiverRequestOpts(): Promise<runtime.RequestOpts>;
|
|
2128
|
+
/**
|
|
2129
|
+
* Signature-verified receiver for Stripe billing events. Idempotent per event id; unknown event types are acknowledged.
|
|
2130
|
+
* Receive Stripe webhook events
|
|
2131
|
+
*/
|
|
2132
|
+
stripeWebhookReceiverRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
2133
|
+
/**
|
|
2134
|
+
* Signature-verified receiver for Stripe billing events. Idempotent per event id; unknown event types are acknowledged.
|
|
2135
|
+
* Receive Stripe webhook events
|
|
2136
|
+
*/
|
|
2137
|
+
stripeWebhookReceiver(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2138
|
+
/**
|
|
2139
|
+
* Creates request options for updateApps without sending the request
|
|
2140
|
+
*/
|
|
2141
|
+
updateAppsRequestOpts(requestParameters: UpdateAppsOperationRequest): Promise<runtime.RequestOpts>;
|
|
2142
|
+
/**
|
|
2143
|
+
* Updates the enabled modules and resolves apps for a business.
|
|
2144
|
+
* Update enabled modules/apps
|
|
2145
|
+
*/
|
|
2146
|
+
updateAppsRaw(requestParameters: UpdateAppsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
2147
|
+
/**
|
|
2148
|
+
* Updates the enabled modules and resolves apps for a business.
|
|
2149
|
+
* Update enabled modules/apps
|
|
2150
|
+
*/
|
|
2151
|
+
updateApps(requestParameters: UpdateAppsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
2152
|
+
/**
|
|
2153
|
+
* Creates request options for updateSecrets without sending the request
|
|
2154
|
+
*/
|
|
2155
|
+
updateSecretsRequestOpts(requestParameters: UpdateSecretsOperationRequest): Promise<runtime.RequestOpts>;
|
|
2156
|
+
/**
|
|
2157
|
+
* Updates secrets for a business and regenerates tfvars.
|
|
2158
|
+
* Update business secrets
|
|
2159
|
+
*/
|
|
2160
|
+
updateSecretsRaw(requestParameters: UpdateSecretsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
2161
|
+
/**
|
|
2162
|
+
* Updates secrets for a business and regenerates tfvars.
|
|
2163
|
+
* Update business secrets
|
|
2164
|
+
*/
|
|
2165
|
+
updateSecrets(requestParameters: UpdateSecretsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
2166
|
+
/**
|
|
2167
|
+
* Creates request options for verifyApiToken without sending the request
|
|
2168
|
+
*/
|
|
2169
|
+
verifyApiTokenRequestOpts(requestParameters: VerifyApiTokenOperationRequest): Promise<runtime.RequestOpts>;
|
|
2170
|
+
/**
|
|
2171
|
+
* Service-to-service only. Returns validity + businessId + scopes for a presented token.
|
|
2172
|
+
* Verify a customer API token
|
|
2173
|
+
*/
|
|
2174
|
+
verifyApiTokenRaw(requestParameters: VerifyApiTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiTokenVerifyResult>>;
|
|
2175
|
+
/**
|
|
2176
|
+
* Service-to-service only. Returns validity + businessId + scopes for a presented token.
|
|
2177
|
+
* Verify a customer API token
|
|
2178
|
+
*/
|
|
2179
|
+
verifyApiToken(requestParameters: VerifyApiTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiTokenVerifyResult>;
|
|
2180
|
+
/**
|
|
2181
|
+
* Creates request options for viewAsBusiness without sending the request
|
|
2182
|
+
*/
|
|
2183
|
+
viewAsBusinessRequestOpts(requestParameters: ViewAsBusinessRequest): Promise<runtime.RequestOpts>;
|
|
2184
|
+
/**
|
|
2185
|
+
* Operator-only. Records an audit entry that the calling operator has entered read-only view-as mode for the target business, and returns that business so the /manage surface can render the tenant\'s own view. Non-operators are rejected with 403.
|
|
2186
|
+
* Enter view-as mode for a business
|
|
2187
|
+
*/
|
|
2188
|
+
viewAsBusinessRaw(requestParameters: ViewAsBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>>;
|
|
2189
|
+
/**
|
|
2190
|
+
* Operator-only. Records an audit entry that the calling operator has entered read-only view-as mode for the target business, and returns that business so the /manage surface can render the tenant\'s own view. Non-operators are rejected with 403.
|
|
2191
|
+
* Enter view-as mode for a business
|
|
2192
|
+
*/
|
|
2193
|
+
viewAsBusiness(requestParameters: ViewAsBusinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business>;
|
|
2194
|
+
}
|