@snokam/platform-client 2.0.0 → 3.1.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/CHANGELOG.md +221 -0
- package/README.md +10 -2
- package/dist/apis/PlatformClient.d.ts +51 -3
- package/dist/apis/PlatformClient.js +135 -2
- package/dist/esm/apis/PlatformClient.d.ts +51 -3
- package/dist/esm/apis/PlatformClient.js +135 -2
- package/dist/esm/models/index.d.ts +159 -12
- package/dist/models/index.d.ts +159 -12
- package/docs/AuthorizationPreview.md +15 -0
- package/docs/AuthorizationRequest.md +18 -0
- package/docs/BusinessConfig.md +1 -0
- package/docs/IntegrationSummary.md +1 -0
- package/docs/IssuedAuthorizationCode.md +14 -0
- package/docs/PatchEmployee.md +1 -1
- package/docs/PlatformClient.md +211 -1
- package/docs/ProtectedEmployee.md +1 -1
- package/docs/ProviderCatalogEntry.md +18 -0
- package/docs/ProviderCatalogResponse.md +14 -0
- package/docs/SanityEmployeeGroupsInner.md +1 -0
- package/docs/TenantInfo.md +1 -0
- package/package.json +1 -1
- package/src/apis/PlatformClient.ts +166 -2
- package/src/models/index.ts +155 -12
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
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, ChooseProviderRequest, 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, 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';
|
|
13
|
+
import type { ActivateRequest, ActivateResult, AddCustomDomainRequest, ApiTokenSummary, ApiTokenVerifyResult, AppCatalogEntry, AppModule, ApproveDeviceRequest, AuthorizationPreview, AuthorizationRequest, BillingPaymentMethod, BillingSessionRequest, BillingSessionResponse, BridgeWebhookResult, Business, BusinessAccess, BusinessHealth, Capability, ChooseProviderRequest, 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, IssuedAuthorizationCode, 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, ProviderCatalogResponse, RecordImpersonationActivityRequest, RenameDeviceRequest, ResetConfirmRequest, ResetRequest, RevokeRequest, ScopeDefinition, SessionBootstrapRequest, 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
14
|
export interface AddCustomDomainOperationRequest {
|
|
15
15
|
id: string;
|
|
16
16
|
addCustomDomainRequest: AddCustomDomainRequest;
|
|
@@ -19,6 +19,9 @@ export interface ApproveDeviceOperationRequest {
|
|
|
19
19
|
id: string;
|
|
20
20
|
approveDeviceRequest: ApproveDeviceRequest;
|
|
21
21
|
}
|
|
22
|
+
export interface ApproveOAuthAuthorizationRequest {
|
|
23
|
+
authorizationRequest: AuthorizationRequest;
|
|
24
|
+
}
|
|
22
25
|
export interface AssignBusinessEmployeeSystemRequest {
|
|
23
26
|
id: string;
|
|
24
27
|
upn: string;
|
|
@@ -266,6 +269,9 @@ export interface PreviewDeviceRequest {
|
|
|
266
269
|
id: string;
|
|
267
270
|
code: string;
|
|
268
271
|
}
|
|
272
|
+
export interface PreviewOAuthAuthorizationRequest {
|
|
273
|
+
authorizationRequest: AuthorizationRequest;
|
|
274
|
+
}
|
|
269
275
|
export interface ProvisionBusinessRequest {
|
|
270
276
|
id: string;
|
|
271
277
|
}
|
|
@@ -429,6 +435,20 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
429
435
|
* Approve a screen into this business
|
|
430
436
|
*/
|
|
431
437
|
approveDevice(requestParameters: ApproveDeviceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceScreen>;
|
|
438
|
+
/**
|
|
439
|
+
* Creates request options for approveOAuthAuthorization without sending the request
|
|
440
|
+
*/
|
|
441
|
+
approveOAuthAuthorizationRequestOpts(requestParameters: ApproveOAuthAuthorizationRequest): Promise<runtime.RequestOpts>;
|
|
442
|
+
/**
|
|
443
|
+
* Issues a single-use authorization code the client redeems at the token endpoint.
|
|
444
|
+
* Approve an authorization request as the signed-in user
|
|
445
|
+
*/
|
|
446
|
+
approveOAuthAuthorizationRaw(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssuedAuthorizationCode>>;
|
|
447
|
+
/**
|
|
448
|
+
* Issues a single-use authorization code the client redeems at the token endpoint.
|
|
449
|
+
* Approve an authorization request as the signed-in user
|
|
450
|
+
*/
|
|
451
|
+
approveOAuthAuthorization(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssuedAuthorizationCode>;
|
|
432
452
|
/**
|
|
433
453
|
* Creates request options for assignBusinessEmployeeSystem without sending the request
|
|
434
454
|
*/
|
|
@@ -1059,6 +1079,20 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
1059
1079
|
* List shared platform secrets
|
|
1060
1080
|
*/
|
|
1061
1081
|
getPlatformSecrets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PlatformSecretStatus>>;
|
|
1082
|
+
/**
|
|
1083
|
+
* Creates request options for getProviderCatalog without sending the request
|
|
1084
|
+
*/
|
|
1085
|
+
getProviderCatalogRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
|
|
1088
|
+
* List provider brand catalog
|
|
1089
|
+
*/
|
|
1090
|
+
getProviderCatalogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProviderCatalogResponse>>;
|
|
1091
|
+
/**
|
|
1092
|
+
* Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
|
|
1093
|
+
* List provider brand catalog
|
|
1094
|
+
*/
|
|
1095
|
+
getProviderCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProviderCatalogResponse>;
|
|
1062
1096
|
/**
|
|
1063
1097
|
* Creates request options for getProvisioningStatus without sending the request
|
|
1064
1098
|
*/
|
|
@@ -1671,6 +1705,20 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
1671
1705
|
* Look up a pairing code before approving
|
|
1672
1706
|
*/
|
|
1673
1707
|
previewDevice(requestParameters: PreviewDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingDevicePreview>;
|
|
1708
|
+
/**
|
|
1709
|
+
* Creates request options for previewOAuthAuthorization without sending the request
|
|
1710
|
+
*/
|
|
1711
|
+
previewOAuthAuthorizationRequestOpts(requestParameters: PreviewOAuthAuthorizationRequest): Promise<runtime.RequestOpts>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Validates the client, redirect URI and resource for the signed-in user and names the client.
|
|
1714
|
+
* Describe an authorization request before the user approves it
|
|
1715
|
+
*/
|
|
1716
|
+
previewOAuthAuthorizationRaw(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthorizationPreview>>;
|
|
1717
|
+
/**
|
|
1718
|
+
* Validates the client, redirect URI and resource for the signed-in user and names the client.
|
|
1719
|
+
* Describe an authorization request before the user approves it
|
|
1720
|
+
*/
|
|
1721
|
+
previewOAuthAuthorization(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthorizationPreview>;
|
|
1674
1722
|
/**
|
|
1675
1723
|
* Creates request options for provisionBusiness without sending the request
|
|
1676
1724
|
*/
|
|
@@ -1800,12 +1848,12 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
1800
1848
|
*/
|
|
1801
1849
|
resolvePlatformSanityConfigRequestOpts(): Promise<runtime.RequestOpts>;
|
|
1802
1850
|
/**
|
|
1803
|
-
* 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.
|
|
1851
|
+
* 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. The answer is cached in-process for five minutes and served stale if Key Vault is briefly unreachable. 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.
|
|
1804
1852
|
* Resolve the platform Sanity read config
|
|
1805
1853
|
*/
|
|
1806
1854
|
resolvePlatformSanityConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlatformSanityConfig>>;
|
|
1807
1855
|
/**
|
|
1808
|
-
* 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.
|
|
1856
|
+
* 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. The answer is cached in-process for five minutes and served stale if Key Vault is briefly unreachable. 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.
|
|
1809
1857
|
* Resolve the platform Sanity read config
|
|
1810
1858
|
*/
|
|
1811
1859
|
resolvePlatformSanityConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlatformSanityConfig>;
|
|
@@ -125,6 +125,52 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
125
125
|
return yield response.value();
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* Creates request options for approveOAuthAuthorization without sending the request
|
|
130
|
+
*/
|
|
131
|
+
approveOAuthAuthorizationRequestOpts(requestParameters) {
|
|
132
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
133
|
+
if (requestParameters['authorizationRequest'] == null) {
|
|
134
|
+
throw new runtime.RequiredError('authorizationRequest', 'Required parameter "authorizationRequest" was null or undefined when calling approveOAuthAuthorization().');
|
|
135
|
+
}
|
|
136
|
+
const queryParameters = {};
|
|
137
|
+
const headerParameters = {};
|
|
138
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
139
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
140
|
+
// oauth required
|
|
141
|
+
headerParameters["Authorization"] = yield this.configuration.accessToken("Implicit", []);
|
|
142
|
+
}
|
|
143
|
+
let urlPath = `/v1.0/protected/oauth/authorization`;
|
|
144
|
+
return {
|
|
145
|
+
path: urlPath,
|
|
146
|
+
method: 'POST',
|
|
147
|
+
headers: headerParameters,
|
|
148
|
+
query: queryParameters,
|
|
149
|
+
body: requestParameters['authorizationRequest'],
|
|
150
|
+
};
|
|
151
|
+
});
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Issues a single-use authorization code the client redeems at the token endpoint.
|
|
155
|
+
* Approve an authorization request as the signed-in user
|
|
156
|
+
*/
|
|
157
|
+
approveOAuthAuthorizationRaw(requestParameters, initOverrides) {
|
|
158
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
159
|
+
const requestOptions = yield this.approveOAuthAuthorizationRequestOpts(requestParameters);
|
|
160
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
161
|
+
return new runtime.JSONApiResponse(response);
|
|
162
|
+
});
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Issues a single-use authorization code the client redeems at the token endpoint.
|
|
166
|
+
* Approve an authorization request as the signed-in user
|
|
167
|
+
*/
|
|
168
|
+
approveOAuthAuthorization(requestParameters, initOverrides) {
|
|
169
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
170
|
+
const response = yield this.approveOAuthAuthorizationRaw(requestParameters, initOverrides);
|
|
171
|
+
return yield response.value();
|
|
172
|
+
});
|
|
173
|
+
}
|
|
128
174
|
/**
|
|
129
175
|
* Creates request options for assignBusinessEmployeeSystem without sending the request
|
|
130
176
|
*/
|
|
@@ -2168,6 +2214,47 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
2168
2214
|
return yield response.value();
|
|
2169
2215
|
});
|
|
2170
2216
|
}
|
|
2217
|
+
/**
|
|
2218
|
+
* Creates request options for getProviderCatalog without sending the request
|
|
2219
|
+
*/
|
|
2220
|
+
getProviderCatalogRequestOpts() {
|
|
2221
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2222
|
+
const queryParameters = {};
|
|
2223
|
+
const headerParameters = {};
|
|
2224
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
2225
|
+
// oauth required
|
|
2226
|
+
headerParameters["Authorization"] = yield this.configuration.accessToken("Implicit", []);
|
|
2227
|
+
}
|
|
2228
|
+
let urlPath = `/v1.0/protected/catalog/providers`;
|
|
2229
|
+
return {
|
|
2230
|
+
path: urlPath,
|
|
2231
|
+
method: 'GET',
|
|
2232
|
+
headers: headerParameters,
|
|
2233
|
+
query: queryParameters,
|
|
2234
|
+
};
|
|
2235
|
+
});
|
|
2236
|
+
}
|
|
2237
|
+
/**
|
|
2238
|
+
* Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
|
|
2239
|
+
* List provider brand catalog
|
|
2240
|
+
*/
|
|
2241
|
+
getProviderCatalogRaw(initOverrides) {
|
|
2242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2243
|
+
const requestOptions = yield this.getProviderCatalogRequestOpts();
|
|
2244
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
2245
|
+
return new runtime.JSONApiResponse(response);
|
|
2246
|
+
});
|
|
2247
|
+
}
|
|
2248
|
+
/**
|
|
2249
|
+
* Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
|
|
2250
|
+
* List provider brand catalog
|
|
2251
|
+
*/
|
|
2252
|
+
getProviderCatalog(initOverrides) {
|
|
2253
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2254
|
+
const response = yield this.getProviderCatalogRaw(initOverrides);
|
|
2255
|
+
return yield response.value();
|
|
2256
|
+
});
|
|
2257
|
+
}
|
|
2171
2258
|
/**
|
|
2172
2259
|
* Creates request options for getProvisioningStatus without sending the request
|
|
2173
2260
|
*/
|
|
@@ -4123,6 +4210,52 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
4123
4210
|
return yield response.value();
|
|
4124
4211
|
});
|
|
4125
4212
|
}
|
|
4213
|
+
/**
|
|
4214
|
+
* Creates request options for previewOAuthAuthorization without sending the request
|
|
4215
|
+
*/
|
|
4216
|
+
previewOAuthAuthorizationRequestOpts(requestParameters) {
|
|
4217
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4218
|
+
if (requestParameters['authorizationRequest'] == null) {
|
|
4219
|
+
throw new runtime.RequiredError('authorizationRequest', 'Required parameter "authorizationRequest" was null or undefined when calling previewOAuthAuthorization().');
|
|
4220
|
+
}
|
|
4221
|
+
const queryParameters = {};
|
|
4222
|
+
const headerParameters = {};
|
|
4223
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
4224
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
4225
|
+
// oauth required
|
|
4226
|
+
headerParameters["Authorization"] = yield this.configuration.accessToken("Implicit", []);
|
|
4227
|
+
}
|
|
4228
|
+
let urlPath = `/v1.0/protected/oauth/authorization/preview`;
|
|
4229
|
+
return {
|
|
4230
|
+
path: urlPath,
|
|
4231
|
+
method: 'POST',
|
|
4232
|
+
headers: headerParameters,
|
|
4233
|
+
query: queryParameters,
|
|
4234
|
+
body: requestParameters['authorizationRequest'],
|
|
4235
|
+
};
|
|
4236
|
+
});
|
|
4237
|
+
}
|
|
4238
|
+
/**
|
|
4239
|
+
* Validates the client, redirect URI and resource for the signed-in user and names the client.
|
|
4240
|
+
* Describe an authorization request before the user approves it
|
|
4241
|
+
*/
|
|
4242
|
+
previewOAuthAuthorizationRaw(requestParameters, initOverrides) {
|
|
4243
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4244
|
+
const requestOptions = yield this.previewOAuthAuthorizationRequestOpts(requestParameters);
|
|
4245
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
4246
|
+
return new runtime.JSONApiResponse(response);
|
|
4247
|
+
});
|
|
4248
|
+
}
|
|
4249
|
+
/**
|
|
4250
|
+
* Validates the client, redirect URI and resource for the signed-in user and names the client.
|
|
4251
|
+
* Describe an authorization request before the user approves it
|
|
4252
|
+
*/
|
|
4253
|
+
previewOAuthAuthorization(requestParameters, initOverrides) {
|
|
4254
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4255
|
+
const response = yield this.previewOAuthAuthorizationRaw(requestParameters, initOverrides);
|
|
4256
|
+
return yield response.value();
|
|
4257
|
+
});
|
|
4258
|
+
}
|
|
4126
4259
|
/**
|
|
4127
4260
|
* Creates request options for provisionBusiness without sending the request
|
|
4128
4261
|
*/
|
|
@@ -4531,7 +4664,7 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
4531
4664
|
});
|
|
4532
4665
|
}
|
|
4533
4666
|
/**
|
|
4534
|
-
* 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.
|
|
4667
|
+
* 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. The answer is cached in-process for five minutes and served stale if Key Vault is briefly unreachable. 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.
|
|
4535
4668
|
* Resolve the platform Sanity read config
|
|
4536
4669
|
*/
|
|
4537
4670
|
resolvePlatformSanityConfigRaw(initOverrides) {
|
|
@@ -4542,7 +4675,7 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
4542
4675
|
});
|
|
4543
4676
|
}
|
|
4544
4677
|
/**
|
|
4545
|
-
* 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.
|
|
4678
|
+
* 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. The answer is cached in-process for five minutes and served stale if Key Vault is briefly unreachable. 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.
|
|
4546
4679
|
* Resolve the platform Sanity read config
|
|
4547
4680
|
*/
|
|
4548
4681
|
resolvePlatformSanityConfig(initOverrides) {
|
|
@@ -277,6 +277,62 @@ export interface ApproveDeviceRequest {
|
|
|
277
277
|
*/
|
|
278
278
|
name?: string | null;
|
|
279
279
|
}
|
|
280
|
+
/**
|
|
281
|
+
*
|
|
282
|
+
* @export
|
|
283
|
+
* @interface AuthorizationPreview
|
|
284
|
+
*/
|
|
285
|
+
export interface AuthorizationPreview {
|
|
286
|
+
/**
|
|
287
|
+
*
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof AuthorizationPreview
|
|
290
|
+
*/
|
|
291
|
+
businessName?: string | null;
|
|
292
|
+
/**
|
|
293
|
+
*
|
|
294
|
+
* @type {string}
|
|
295
|
+
* @memberof AuthorizationPreview
|
|
296
|
+
*/
|
|
297
|
+
clientName?: string | null;
|
|
298
|
+
}
|
|
299
|
+
/**
|
|
300
|
+
*
|
|
301
|
+
* @export
|
|
302
|
+
* @interface AuthorizationRequest
|
|
303
|
+
*/
|
|
304
|
+
export interface AuthorizationRequest {
|
|
305
|
+
/**
|
|
306
|
+
*
|
|
307
|
+
* @type {string}
|
|
308
|
+
* @memberof AuthorizationRequest
|
|
309
|
+
*/
|
|
310
|
+
clientId?: string | null;
|
|
311
|
+
/**
|
|
312
|
+
*
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof AuthorizationRequest
|
|
315
|
+
*/
|
|
316
|
+
codeChallenge?: string | null;
|
|
317
|
+
/**
|
|
318
|
+
*
|
|
319
|
+
* @type {string}
|
|
320
|
+
* @memberof AuthorizationRequest
|
|
321
|
+
*/
|
|
322
|
+
codeChallengeMethod?: string | null;
|
|
323
|
+
/**
|
|
324
|
+
*
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof AuthorizationRequest
|
|
327
|
+
*/
|
|
328
|
+
redirectUri?: string | null;
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @type {string}
|
|
332
|
+
* @memberof AuthorizationRequest
|
|
333
|
+
*/
|
|
334
|
+
resource?: string | null;
|
|
335
|
+
}
|
|
280
336
|
/**
|
|
281
337
|
*
|
|
282
338
|
* @export
|
|
@@ -741,6 +797,14 @@ export interface BusinessConfig {
|
|
|
741
797
|
* @memberof BusinessConfig
|
|
742
798
|
*/
|
|
743
799
|
olafTeamsSettings?: OlafTeamsSettings;
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @type {{ [key: string]: string; }}
|
|
803
|
+
* @memberof BusinessConfig
|
|
804
|
+
*/
|
|
805
|
+
onboardingActivateUrlOverrides?: {
|
|
806
|
+
[key: string]: string;
|
|
807
|
+
} | null;
|
|
744
808
|
/**
|
|
745
809
|
*
|
|
746
810
|
* @type {string}
|
|
@@ -2221,6 +2285,12 @@ export interface IntegrationSummary {
|
|
|
2221
2285
|
* @memberof IntegrationSummary
|
|
2222
2286
|
*/
|
|
2223
2287
|
key?: string | null;
|
|
2288
|
+
/**
|
|
2289
|
+
*
|
|
2290
|
+
* @type {string}
|
|
2291
|
+
* @memberof IntegrationSummary
|
|
2292
|
+
*/
|
|
2293
|
+
logoUrl?: string | null;
|
|
2224
2294
|
/**
|
|
2225
2295
|
*
|
|
2226
2296
|
* @type {Array<string>}
|
|
@@ -2373,6 +2443,19 @@ export interface InvoiceBasisLine {
|
|
|
2373
2443
|
*/
|
|
2374
2444
|
unitPriceOre?: number | null;
|
|
2375
2445
|
}
|
|
2446
|
+
/**
|
|
2447
|
+
*
|
|
2448
|
+
* @export
|
|
2449
|
+
* @interface IssuedAuthorizationCode
|
|
2450
|
+
*/
|
|
2451
|
+
export interface IssuedAuthorizationCode {
|
|
2452
|
+
/**
|
|
2453
|
+
*
|
|
2454
|
+
* @type {string}
|
|
2455
|
+
* @memberof IssuedAuthorizationCode
|
|
2456
|
+
*/
|
|
2457
|
+
code?: string | null;
|
|
2458
|
+
}
|
|
2376
2459
|
/**
|
|
2377
2460
|
*
|
|
2378
2461
|
* @export
|
|
@@ -3309,6 +3392,12 @@ export interface PatchEmployee {
|
|
|
3309
3392
|
* @memberof PatchEmployee
|
|
3310
3393
|
*/
|
|
3311
3394
|
isSeekingProject?: boolean | null;
|
|
3395
|
+
/**
|
|
3396
|
+
*
|
|
3397
|
+
* @type {boolean}
|
|
3398
|
+
* @memberof PatchEmployee
|
|
3399
|
+
*/
|
|
3400
|
+
leadershipGroupMember?: boolean | null;
|
|
3312
3401
|
/**
|
|
3313
3402
|
*
|
|
3314
3403
|
* @type {string}
|
|
@@ -3359,12 +3448,6 @@ export interface PatchEmployee {
|
|
|
3359
3448
|
* @memberof PatchEmployee
|
|
3360
3449
|
*/
|
|
3361
3450
|
parentalLeaveCoverage?: PatchEmployeeParentalLeaveCoverageEnum | null;
|
|
3362
|
-
/**
|
|
3363
|
-
*
|
|
3364
|
-
* @type {string}
|
|
3365
|
-
* @memberof PatchEmployee
|
|
3366
|
-
*/
|
|
3367
|
-
parentalLeaveStartDate?: string;
|
|
3368
3451
|
/**
|
|
3369
3452
|
*
|
|
3370
3453
|
* @type {string}
|
|
@@ -4078,6 +4161,12 @@ export interface ProtectedEmployee {
|
|
|
4078
4161
|
* @memberof ProtectedEmployee
|
|
4079
4162
|
*/
|
|
4080
4163
|
isSeekingProject?: boolean;
|
|
4164
|
+
/**
|
|
4165
|
+
*
|
|
4166
|
+
* @type {boolean}
|
|
4167
|
+
* @memberof ProtectedEmployee
|
|
4168
|
+
*/
|
|
4169
|
+
leadershipGroupMember?: boolean;
|
|
4081
4170
|
/**
|
|
4082
4171
|
*
|
|
4083
4172
|
* @type {string}
|
|
@@ -4128,12 +4217,6 @@ export interface ProtectedEmployee {
|
|
|
4128
4217
|
* @memberof ProtectedEmployee
|
|
4129
4218
|
*/
|
|
4130
4219
|
parentalLeaveCoverage?: ProtectedEmployeeParentalLeaveCoverageEnum | null;
|
|
4131
|
-
/**
|
|
4132
|
-
*
|
|
4133
|
-
* @type {string}
|
|
4134
|
-
* @memberof ProtectedEmployee
|
|
4135
|
-
*/
|
|
4136
|
-
parentalLeaveStartDate?: string;
|
|
4137
4220
|
/**
|
|
4138
4221
|
*
|
|
4139
4222
|
* @type {string}
|
|
@@ -4264,6 +4347,56 @@ export declare const ProtectedEmployeeSanityTypeEnum: {
|
|
|
4264
4347
|
readonly Employee: "employee";
|
|
4265
4348
|
};
|
|
4266
4349
|
export type ProtectedEmployeeSanityTypeEnum = typeof ProtectedEmployeeSanityTypeEnum[keyof typeof ProtectedEmployeeSanityTypeEnum];
|
|
4350
|
+
/**
|
|
4351
|
+
*
|
|
4352
|
+
* @export
|
|
4353
|
+
* @interface ProviderCatalogEntry
|
|
4354
|
+
*/
|
|
4355
|
+
export interface ProviderCatalogEntry {
|
|
4356
|
+
/**
|
|
4357
|
+
*
|
|
4358
|
+
* @type {string}
|
|
4359
|
+
* @memberof ProviderCatalogEntry
|
|
4360
|
+
*/
|
|
4361
|
+
capability?: string | null;
|
|
4362
|
+
/**
|
|
4363
|
+
*
|
|
4364
|
+
* @type {string}
|
|
4365
|
+
* @memberof ProviderCatalogEntry
|
|
4366
|
+
*/
|
|
4367
|
+
description?: string | null;
|
|
4368
|
+
/**
|
|
4369
|
+
*
|
|
4370
|
+
* @type {string}
|
|
4371
|
+
* @memberof ProviderCatalogEntry
|
|
4372
|
+
*/
|
|
4373
|
+
key?: string | null;
|
|
4374
|
+
/**
|
|
4375
|
+
*
|
|
4376
|
+
* @type {string}
|
|
4377
|
+
* @memberof ProviderCatalogEntry
|
|
4378
|
+
*/
|
|
4379
|
+
logoUrl?: string | null;
|
|
4380
|
+
/**
|
|
4381
|
+
*
|
|
4382
|
+
* @type {string}
|
|
4383
|
+
* @memberof ProviderCatalogEntry
|
|
4384
|
+
*/
|
|
4385
|
+
title?: string | null;
|
|
4386
|
+
}
|
|
4387
|
+
/**
|
|
4388
|
+
*
|
|
4389
|
+
* @export
|
|
4390
|
+
* @interface ProviderCatalogResponse
|
|
4391
|
+
*/
|
|
4392
|
+
export interface ProviderCatalogResponse {
|
|
4393
|
+
/**
|
|
4394
|
+
*
|
|
4395
|
+
* @type {Array<ProviderCatalogEntry>}
|
|
4396
|
+
* @memberof ProviderCatalogResponse
|
|
4397
|
+
*/
|
|
4398
|
+
providers?: Array<ProviderCatalogEntry> | null;
|
|
4399
|
+
}
|
|
4267
4400
|
/**
|
|
4268
4401
|
*
|
|
4269
4402
|
* @export
|
|
@@ -4835,6 +4968,12 @@ export interface SanityEmployeeGroupsInner {
|
|
|
4835
4968
|
* @memberof SanityEmployeeGroupsInner
|
|
4836
4969
|
*/
|
|
4837
4970
|
scopeGrants?: Array<string>;
|
|
4971
|
+
/**
|
|
4972
|
+
*
|
|
4973
|
+
* @type {string}
|
|
4974
|
+
* @memberof SanityEmployeeGroupsInner
|
|
4975
|
+
*/
|
|
4976
|
+
slackChannel?: string;
|
|
4838
4977
|
}
|
|
4839
4978
|
/**
|
|
4840
4979
|
* @export
|
|
@@ -5995,6 +6134,14 @@ export interface TenantInfo {
|
|
|
5995
6134
|
* @memberof TenantInfo
|
|
5996
6135
|
*/
|
|
5997
6136
|
keyVaultName?: string | null;
|
|
6137
|
+
/**
|
|
6138
|
+
*
|
|
6139
|
+
* @type {{ [key: string]: string; }}
|
|
6140
|
+
* @memberof TenantInfo
|
|
6141
|
+
*/
|
|
6142
|
+
onboardingActivateUrlOverrides?: {
|
|
6143
|
+
[key: string]: string;
|
|
6144
|
+
} | null;
|
|
5998
6145
|
/**
|
|
5999
6146
|
*
|
|
6000
6147
|
* @type {string}
|