@snokam/platform-client 1.0.0 → 3.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/CHANGELOG.md +349 -0
- package/README.md +7 -3
- package/dist/apis/PlatformClient.d.ts +55 -23
- package/dist/apis/PlatformClient.js +144 -54
- package/dist/esm/apis/PlatformClient.d.ts +55 -23
- package/dist/esm/apis/PlatformClient.js +144 -54
- package/dist/esm/models/index.d.ts +101 -21
- package/dist/models/index.d.ts +101 -21
- package/docs/BusinessConfig.md +1 -0
- package/docs/{SetActiveProviderRequest.md → ChooseProviderRequest.md} +1 -1
- package/docs/IntegrationSummary.md +2 -1
- package/docs/PlatformClient.md +219 -79
- package/docs/ProviderCatalogEntry.md +18 -0
- package/docs/ProviderCatalogResponse.md +14 -0
- package/docs/StudioSanityConfig.md +1 -0
- package/docs/TenantInfo.md +1 -0
- package/package.json +1 -1
- package/src/apis/PlatformClient.ts +182 -72
- package/src/models/index.ts +95 -21
|
@@ -741,6 +741,14 @@ export interface BusinessConfig {
|
|
|
741
741
|
* @memberof BusinessConfig
|
|
742
742
|
*/
|
|
743
743
|
olafTeamsSettings?: OlafTeamsSettings;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {{ [key: string]: string; }}
|
|
747
|
+
* @memberof BusinessConfig
|
|
748
|
+
*/
|
|
749
|
+
onboardingActivateUrlOverrides?: {
|
|
750
|
+
[key: string]: string;
|
|
751
|
+
} | null;
|
|
744
752
|
/**
|
|
745
753
|
*
|
|
746
754
|
* @type {string}
|
|
@@ -945,6 +953,25 @@ export interface Capability {
|
|
|
945
953
|
*/
|
|
946
954
|
platformProvided?: boolean | null;
|
|
947
955
|
}
|
|
956
|
+
/**
|
|
957
|
+
*
|
|
958
|
+
* @export
|
|
959
|
+
* @interface ChooseProviderRequest
|
|
960
|
+
*/
|
|
961
|
+
export interface ChooseProviderRequest {
|
|
962
|
+
/**
|
|
963
|
+
*
|
|
964
|
+
* @type {string}
|
|
965
|
+
* @memberof ChooseProviderRequest
|
|
966
|
+
*/
|
|
967
|
+
capability?: string | null;
|
|
968
|
+
/**
|
|
969
|
+
*
|
|
970
|
+
* @type {string}
|
|
971
|
+
* @memberof ChooseProviderRequest
|
|
972
|
+
*/
|
|
973
|
+
integrationKey?: string | null;
|
|
974
|
+
}
|
|
948
975
|
/**
|
|
949
976
|
*
|
|
950
977
|
* @export
|
|
@@ -2189,19 +2216,25 @@ export interface IntegrationSummary {
|
|
|
2189
2216
|
* @type {boolean}
|
|
2190
2217
|
* @memberof IntegrationSummary
|
|
2191
2218
|
*/
|
|
2192
|
-
|
|
2219
|
+
isConfigured?: boolean | null;
|
|
2193
2220
|
/**
|
|
2194
2221
|
*
|
|
2195
2222
|
* @type {boolean}
|
|
2196
2223
|
* @memberof IntegrationSummary
|
|
2197
2224
|
*/
|
|
2198
|
-
|
|
2225
|
+
isInUse?: boolean | null;
|
|
2199
2226
|
/**
|
|
2200
2227
|
*
|
|
2201
2228
|
* @type {string}
|
|
2202
2229
|
* @memberof IntegrationSummary
|
|
2203
2230
|
*/
|
|
2204
2231
|
key?: string | null;
|
|
2232
|
+
/**
|
|
2233
|
+
*
|
|
2234
|
+
* @type {string}
|
|
2235
|
+
* @memberof IntegrationSummary
|
|
2236
|
+
*/
|
|
2237
|
+
logoUrl?: string | null;
|
|
2205
2238
|
/**
|
|
2206
2239
|
*
|
|
2207
2240
|
* @type {Array<string>}
|
|
@@ -4245,6 +4278,56 @@ export declare const ProtectedEmployeeSanityTypeEnum: {
|
|
|
4245
4278
|
readonly Employee: "employee";
|
|
4246
4279
|
};
|
|
4247
4280
|
export type ProtectedEmployeeSanityTypeEnum = typeof ProtectedEmployeeSanityTypeEnum[keyof typeof ProtectedEmployeeSanityTypeEnum];
|
|
4281
|
+
/**
|
|
4282
|
+
*
|
|
4283
|
+
* @export
|
|
4284
|
+
* @interface ProviderCatalogEntry
|
|
4285
|
+
*/
|
|
4286
|
+
export interface ProviderCatalogEntry {
|
|
4287
|
+
/**
|
|
4288
|
+
*
|
|
4289
|
+
* @type {string}
|
|
4290
|
+
* @memberof ProviderCatalogEntry
|
|
4291
|
+
*/
|
|
4292
|
+
capability?: string | null;
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4295
|
+
* @type {string}
|
|
4296
|
+
* @memberof ProviderCatalogEntry
|
|
4297
|
+
*/
|
|
4298
|
+
description?: string | null;
|
|
4299
|
+
/**
|
|
4300
|
+
*
|
|
4301
|
+
* @type {string}
|
|
4302
|
+
* @memberof ProviderCatalogEntry
|
|
4303
|
+
*/
|
|
4304
|
+
key?: string | null;
|
|
4305
|
+
/**
|
|
4306
|
+
*
|
|
4307
|
+
* @type {string}
|
|
4308
|
+
* @memberof ProviderCatalogEntry
|
|
4309
|
+
*/
|
|
4310
|
+
logoUrl?: string | null;
|
|
4311
|
+
/**
|
|
4312
|
+
*
|
|
4313
|
+
* @type {string}
|
|
4314
|
+
* @memberof ProviderCatalogEntry
|
|
4315
|
+
*/
|
|
4316
|
+
title?: string | null;
|
|
4317
|
+
}
|
|
4318
|
+
/**
|
|
4319
|
+
*
|
|
4320
|
+
* @export
|
|
4321
|
+
* @interface ProviderCatalogResponse
|
|
4322
|
+
*/
|
|
4323
|
+
export interface ProviderCatalogResponse {
|
|
4324
|
+
/**
|
|
4325
|
+
*
|
|
4326
|
+
* @type {Array<ProviderCatalogEntry>}
|
|
4327
|
+
* @memberof ProviderCatalogResponse
|
|
4328
|
+
*/
|
|
4329
|
+
providers?: Array<ProviderCatalogEntry> | null;
|
|
4330
|
+
}
|
|
4248
4331
|
/**
|
|
4249
4332
|
*
|
|
4250
4333
|
* @export
|
|
@@ -5443,25 +5526,6 @@ export interface SessionBootstrapRequest {
|
|
|
5443
5526
|
*/
|
|
5444
5527
|
bootstrapToken?: string | null;
|
|
5445
5528
|
}
|
|
5446
|
-
/**
|
|
5447
|
-
*
|
|
5448
|
-
* @export
|
|
5449
|
-
* @interface SetActiveProviderRequest
|
|
5450
|
-
*/
|
|
5451
|
-
export interface SetActiveProviderRequest {
|
|
5452
|
-
/**
|
|
5453
|
-
*
|
|
5454
|
-
* @type {string}
|
|
5455
|
-
* @memberof SetActiveProviderRequest
|
|
5456
|
-
*/
|
|
5457
|
-
capability?: string | null;
|
|
5458
|
-
/**
|
|
5459
|
-
*
|
|
5460
|
-
* @type {string}
|
|
5461
|
-
* @memberof SetActiveProviderRequest
|
|
5462
|
-
*/
|
|
5463
|
-
integrationKey?: string | null;
|
|
5464
|
-
}
|
|
5465
5529
|
/**
|
|
5466
5530
|
*
|
|
5467
5531
|
* @export
|
|
@@ -5794,6 +5858,14 @@ export interface StartImpersonationResult {
|
|
|
5794
5858
|
* @interface StudioSanityConfig
|
|
5795
5859
|
*/
|
|
5796
5860
|
export interface StudioSanityConfig {
|
|
5861
|
+
/**
|
|
5862
|
+
*
|
|
5863
|
+
* @type {{ [key: string]: string; }}
|
|
5864
|
+
* @memberof StudioSanityConfig
|
|
5865
|
+
*/
|
|
5866
|
+
appUrls?: {
|
|
5867
|
+
[key: string]: string;
|
|
5868
|
+
} | null;
|
|
5797
5869
|
/**
|
|
5798
5870
|
*
|
|
5799
5871
|
* @type {string}
|
|
@@ -5987,6 +6059,14 @@ export interface TenantInfo {
|
|
|
5987
6059
|
* @memberof TenantInfo
|
|
5988
6060
|
*/
|
|
5989
6061
|
keyVaultName?: string | null;
|
|
6062
|
+
/**
|
|
6063
|
+
*
|
|
6064
|
+
* @type {{ [key: string]: string; }}
|
|
6065
|
+
* @memberof TenantInfo
|
|
6066
|
+
*/
|
|
6067
|
+
onboardingActivateUrlOverrides?: {
|
|
6068
|
+
[key: string]: string;
|
|
6069
|
+
} | null;
|
|
5990
6070
|
/**
|
|
5991
6071
|
*
|
|
5992
6072
|
* @type {string}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -741,6 +741,14 @@ export interface BusinessConfig {
|
|
|
741
741
|
* @memberof BusinessConfig
|
|
742
742
|
*/
|
|
743
743
|
olafTeamsSettings?: OlafTeamsSettings;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {{ [key: string]: string; }}
|
|
747
|
+
* @memberof BusinessConfig
|
|
748
|
+
*/
|
|
749
|
+
onboardingActivateUrlOverrides?: {
|
|
750
|
+
[key: string]: string;
|
|
751
|
+
} | null;
|
|
744
752
|
/**
|
|
745
753
|
*
|
|
746
754
|
* @type {string}
|
|
@@ -945,6 +953,25 @@ export interface Capability {
|
|
|
945
953
|
*/
|
|
946
954
|
platformProvided?: boolean | null;
|
|
947
955
|
}
|
|
956
|
+
/**
|
|
957
|
+
*
|
|
958
|
+
* @export
|
|
959
|
+
* @interface ChooseProviderRequest
|
|
960
|
+
*/
|
|
961
|
+
export interface ChooseProviderRequest {
|
|
962
|
+
/**
|
|
963
|
+
*
|
|
964
|
+
* @type {string}
|
|
965
|
+
* @memberof ChooseProviderRequest
|
|
966
|
+
*/
|
|
967
|
+
capability?: string | null;
|
|
968
|
+
/**
|
|
969
|
+
*
|
|
970
|
+
* @type {string}
|
|
971
|
+
* @memberof ChooseProviderRequest
|
|
972
|
+
*/
|
|
973
|
+
integrationKey?: string | null;
|
|
974
|
+
}
|
|
948
975
|
/**
|
|
949
976
|
*
|
|
950
977
|
* @export
|
|
@@ -2189,19 +2216,25 @@ export interface IntegrationSummary {
|
|
|
2189
2216
|
* @type {boolean}
|
|
2190
2217
|
* @memberof IntegrationSummary
|
|
2191
2218
|
*/
|
|
2192
|
-
|
|
2219
|
+
isConfigured?: boolean | null;
|
|
2193
2220
|
/**
|
|
2194
2221
|
*
|
|
2195
2222
|
* @type {boolean}
|
|
2196
2223
|
* @memberof IntegrationSummary
|
|
2197
2224
|
*/
|
|
2198
|
-
|
|
2225
|
+
isInUse?: boolean | null;
|
|
2199
2226
|
/**
|
|
2200
2227
|
*
|
|
2201
2228
|
* @type {string}
|
|
2202
2229
|
* @memberof IntegrationSummary
|
|
2203
2230
|
*/
|
|
2204
2231
|
key?: string | null;
|
|
2232
|
+
/**
|
|
2233
|
+
*
|
|
2234
|
+
* @type {string}
|
|
2235
|
+
* @memberof IntegrationSummary
|
|
2236
|
+
*/
|
|
2237
|
+
logoUrl?: string | null;
|
|
2205
2238
|
/**
|
|
2206
2239
|
*
|
|
2207
2240
|
* @type {Array<string>}
|
|
@@ -4245,6 +4278,56 @@ export declare const ProtectedEmployeeSanityTypeEnum: {
|
|
|
4245
4278
|
readonly Employee: "employee";
|
|
4246
4279
|
};
|
|
4247
4280
|
export type ProtectedEmployeeSanityTypeEnum = typeof ProtectedEmployeeSanityTypeEnum[keyof typeof ProtectedEmployeeSanityTypeEnum];
|
|
4281
|
+
/**
|
|
4282
|
+
*
|
|
4283
|
+
* @export
|
|
4284
|
+
* @interface ProviderCatalogEntry
|
|
4285
|
+
*/
|
|
4286
|
+
export interface ProviderCatalogEntry {
|
|
4287
|
+
/**
|
|
4288
|
+
*
|
|
4289
|
+
* @type {string}
|
|
4290
|
+
* @memberof ProviderCatalogEntry
|
|
4291
|
+
*/
|
|
4292
|
+
capability?: string | null;
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4295
|
+
* @type {string}
|
|
4296
|
+
* @memberof ProviderCatalogEntry
|
|
4297
|
+
*/
|
|
4298
|
+
description?: string | null;
|
|
4299
|
+
/**
|
|
4300
|
+
*
|
|
4301
|
+
* @type {string}
|
|
4302
|
+
* @memberof ProviderCatalogEntry
|
|
4303
|
+
*/
|
|
4304
|
+
key?: string | null;
|
|
4305
|
+
/**
|
|
4306
|
+
*
|
|
4307
|
+
* @type {string}
|
|
4308
|
+
* @memberof ProviderCatalogEntry
|
|
4309
|
+
*/
|
|
4310
|
+
logoUrl?: string | null;
|
|
4311
|
+
/**
|
|
4312
|
+
*
|
|
4313
|
+
* @type {string}
|
|
4314
|
+
* @memberof ProviderCatalogEntry
|
|
4315
|
+
*/
|
|
4316
|
+
title?: string | null;
|
|
4317
|
+
}
|
|
4318
|
+
/**
|
|
4319
|
+
*
|
|
4320
|
+
* @export
|
|
4321
|
+
* @interface ProviderCatalogResponse
|
|
4322
|
+
*/
|
|
4323
|
+
export interface ProviderCatalogResponse {
|
|
4324
|
+
/**
|
|
4325
|
+
*
|
|
4326
|
+
* @type {Array<ProviderCatalogEntry>}
|
|
4327
|
+
* @memberof ProviderCatalogResponse
|
|
4328
|
+
*/
|
|
4329
|
+
providers?: Array<ProviderCatalogEntry> | null;
|
|
4330
|
+
}
|
|
4248
4331
|
/**
|
|
4249
4332
|
*
|
|
4250
4333
|
* @export
|
|
@@ -5443,25 +5526,6 @@ export interface SessionBootstrapRequest {
|
|
|
5443
5526
|
*/
|
|
5444
5527
|
bootstrapToken?: string | null;
|
|
5445
5528
|
}
|
|
5446
|
-
/**
|
|
5447
|
-
*
|
|
5448
|
-
* @export
|
|
5449
|
-
* @interface SetActiveProviderRequest
|
|
5450
|
-
*/
|
|
5451
|
-
export interface SetActiveProviderRequest {
|
|
5452
|
-
/**
|
|
5453
|
-
*
|
|
5454
|
-
* @type {string}
|
|
5455
|
-
* @memberof SetActiveProviderRequest
|
|
5456
|
-
*/
|
|
5457
|
-
capability?: string | null;
|
|
5458
|
-
/**
|
|
5459
|
-
*
|
|
5460
|
-
* @type {string}
|
|
5461
|
-
* @memberof SetActiveProviderRequest
|
|
5462
|
-
*/
|
|
5463
|
-
integrationKey?: string | null;
|
|
5464
|
-
}
|
|
5465
5529
|
/**
|
|
5466
5530
|
*
|
|
5467
5531
|
* @export
|
|
@@ -5794,6 +5858,14 @@ export interface StartImpersonationResult {
|
|
|
5794
5858
|
* @interface StudioSanityConfig
|
|
5795
5859
|
*/
|
|
5796
5860
|
export interface StudioSanityConfig {
|
|
5861
|
+
/**
|
|
5862
|
+
*
|
|
5863
|
+
* @type {{ [key: string]: string; }}
|
|
5864
|
+
* @memberof StudioSanityConfig
|
|
5865
|
+
*/
|
|
5866
|
+
appUrls?: {
|
|
5867
|
+
[key: string]: string;
|
|
5868
|
+
} | null;
|
|
5797
5869
|
/**
|
|
5798
5870
|
*
|
|
5799
5871
|
* @type {string}
|
|
@@ -5987,6 +6059,14 @@ export interface TenantInfo {
|
|
|
5987
6059
|
* @memberof TenantInfo
|
|
5988
6060
|
*/
|
|
5989
6061
|
keyVaultName?: string | null;
|
|
6062
|
+
/**
|
|
6063
|
+
*
|
|
6064
|
+
* @type {{ [key: string]: string; }}
|
|
6065
|
+
* @memberof TenantInfo
|
|
6066
|
+
*/
|
|
6067
|
+
onboardingActivateUrlOverrides?: {
|
|
6068
|
+
[key: string]: string;
|
|
6069
|
+
} | null;
|
|
5990
6070
|
/**
|
|
5991
6071
|
*
|
|
5992
6072
|
* @type {string}
|
package/docs/BusinessConfig.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
`activeProviders` | { [key: string]: string; }
|
|
10
10
|
`cvPartnerBaseUrl` | string
|
|
11
11
|
`olafTeamsSettings` | [OlafTeamsSettings](OlafTeamsSettings.md)
|
|
12
|
+
`onboardingActivateUrlOverrides` | { [key: string]: string; }
|
|
12
13
|
`sanityDataset` | string
|
|
13
14
|
`sanityProjectId` | string
|
|
14
15
|
|
|
@@ -13,9 +13,10 @@ Name | Type
|
|
|
13
13
|
`connectedSecretKey` | string
|
|
14
14
|
`description` | string
|
|
15
15
|
`displayName` | string
|
|
16
|
-
`isActive` | boolean
|
|
17
16
|
`isConfigured` | boolean
|
|
17
|
+
`isInUse` | boolean
|
|
18
18
|
`key` | string
|
|
19
|
+
`logoUrl` | string
|
|
19
20
|
`missingSecretKeys` | Array<string>
|
|
20
21
|
`operatorOnly` | boolean
|
|
21
22
|
`secrets` | [Array<IntegrationSecret>](IntegrationSecret.md)
|