@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.
@@ -10,6 +10,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
10
10
  | [**backfillBridgeWebhook**](PlatformClient.md#backfillbridgewebhook) | **POST** /v1.0/protected/businesses/{id}/bridge-webhook | Re-create a business\'s Sanity bridge webhook with a managed API key |
11
11
  | [**checkIntegration**](PlatformClient.md#checkintegration) | **POST** /v1.0/protected/businesses/{id}/integrations/{key}/check | Run a live integration connectivity check |
12
12
  | [**checkPlatformIntegration**](PlatformClient.md#checkplatformintegration) | **POST** /v1.0/protected/platform/integrations/{key}/check | Live-probe a platform integration |
13
+ | [**chooseProvider**](PlatformClient.md#chooseprovideroperation) | **PUT** /v1.0/protected/businesses/{id}/integrations/chosen | Choose the active provider for a capability |
13
14
  | [**connectTenant**](PlatformClient.md#connecttenant) | **POST** /v1.0/protected/businesses/{id}/connect | Connect the caller\'s tenant to a business |
14
15
  | [**createApiToken**](PlatformClient.md#createapitokenoperation) | **POST** /v1.0/protected/businesses/{id}/tokens | Create an API token |
15
16
  | [**createBillingCheckout**](PlatformClient.md#createbillingcheckout) | **POST** /v1.0/protected/businesses/{id}/billing/checkout | Start a subscription checkout |
@@ -21,6 +22,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
21
22
  | [**devicePairPoll**](PlatformClient.md#devicepairpoll) | **POST** /v1.0/public/devices/poll | Ask whether the code was approved |
22
23
  | [**devicePairRequest**](PlatformClient.md#devicepairrequest) | **POST** /v1.0/public/devices/pair | Ask for a pairing code |
23
24
  | [**disableCredential**](PlatformClient.md#disablecredential) | **DELETE** /v1.0/protected/businesses/{id}/credentials/{credentialId} | Disable a password credential |
25
+ | [**disconnectIntegration**](PlatformClient.md#disconnectintegration) | **DELETE** /v1.0/protected/businesses/{id}/integrations/{key} | Disconnect an integration |
24
26
  | [**endImpersonation**](PlatformClient.md#endimpersonation) | **POST** /v1.0/protected/impersonate/{tokenId}/end | End a view-as-employee session |
25
27
  | [**exportBusinessData**](PlatformClient.md#exportbusinessdata) | **POST** /v1.0/protected/businesses/{id}/export | Export a business\'s data (GDPR) |
26
28
  | [**getApiScopes**](PlatformClient.md#getapiscopes) | **GET** /v1.0/protected/scopes | List grantable API scopes |
@@ -49,6 +51,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
49
51
  | [**getPlatformIntegrations**](PlatformClient.md#getplatformintegrations) | **GET** /v1.0/protected/platform/integrations | List platform-shared integrations |
50
52
  | [**getPlatformOAuthAccessToken**](PlatformClient.md#getplatformoauthaccesstoken) | **GET** /v1.0/protected/platform/oauth/{provider}/access-token | Mint a fresh platform OAuth access token |
51
53
  | [**getPlatformSecrets**](PlatformClient.md#getplatformsecrets) | **GET** /v1.0/protected/platform/secrets | List shared platform secrets |
54
+ | [**getProviderCatalog**](PlatformClient.md#getprovidercatalog) | **GET** /v1.0/protected/catalog/providers | List provider brand catalog |
52
55
  | [**getProvisioningStatus**](PlatformClient.md#getprovisioningstatus) | **GET** /v1.0/protected/businesses/{id}/status | Get provisioning status |
53
56
  | [**getTeamsAuthState**](PlatformClient.md#getteamsauthstate) | **GET** /v1.0/protected/businesses/{id}/teams/auth-state | Read the business\'s stored Teams authenticated join session |
54
57
  | [**getTeamsUserAcsToken**](PlatformClient.md#getteamsuseracstoken) | **GET** /v1.0/protected/businesses/{id}/teams/acs-token | Mint an ACS access token for the connected M365 user as a Teams user |
@@ -103,7 +106,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
103
106
  | [**requestUpgrade**](PlatformClient.md#requestupgrade) | **POST** /v1.0/protected/businesses/{id}/request-upgrade | Request an Enterprise upgrade |
104
107
  | [**resetCredential**](PlatformClient.md#resetcredential) | **POST** /v1.0/protected/businesses/{id}/credentials/{credentialId}/reset | Admin-initiated password reset |
105
108
  | [**resolvePlatformSanityConfig**](PlatformClient.md#resolveplatformsanityconfig) | **GET** /v1.0/protected/sanity/platform | Resolve the platform Sanity read config |
106
- | [**resolveStudioSanityConfig**](PlatformClient.md#resolvestudiosanityconfig) | **GET** /v1.0/public/sanity-config | Resolve the Sanity Studio project/dataset for a host |
109
+ | [**resolveStudioSanityConfig**](PlatformClient.md#resolvestudiosanityconfig) | **GET** /v1.0/public/sanity-config | Resolve the Sanity Studio project/dataset and frontend URLs for a host |
107
110
  | [**resolveTenant**](PlatformClient.md#resolvetenant) | **GET** /v1.0/protected/tenant | Resolve a tenant |
108
111
  | [**resolveTenantSanityCredentials**](PlatformClient.md#resolvetenantsanitycredentials) | **GET** /v1.0/protected/businesses/by-host/{host}/sanity | Resolve a tenant\'s Sanity read credentials by host |
109
112
  | [**revokeApiToken**](PlatformClient.md#revokeapitoken) | **DELETE** /v1.0/protected/businesses/{id}/tokens/{fingerprint} | Revoke an API token |
@@ -111,7 +114,6 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
111
114
  | [**revokeDevice**](PlatformClient.md#revokedevice) | **DELETE** /v1.0/protected/businesses/{id}/devices/{deviceId} | Revoke a screen |
112
115
  | [**setAccountingGadgetsProject**](PlatformClient.md#setaccountinggadgetsproject) | **POST** /v1.0/protected/businesses/{id}/accounting/gadgets-project | Set the gadgets project code |
113
116
  | [**setAccountingReinvoiceProduct**](PlatformClient.md#setaccountingreinvoiceproduct) | **POST** /v1.0/protected/businesses/{id}/accounting/reinvoice-product | Set the re-invoice product code |
114
- | [**setActiveProvider**](PlatformClient.md#setactiveprovideroperation) | **PUT** /v1.0/protected/businesses/{id}/integrations/active | Choose the active provider for a capability |
115
117
  | [**setBusinessEmployeePhoto**](PlatformClient.md#setbusinessemployeephoto) | **POST** /v1.0/protected/businesses/{id}/employees/{employeeId}/photo | Upload an employee\'s profile photo |
116
118
  | [**setEmployeeScopeGrants**](PlatformClient.md#setemployeescopegrants) | **PUT** /v1.0/protected/businesses/{id}/access/employees/{employeeId} | Set the scopes granted directly to an employee |
117
119
  | [**setFacebookSelectedAccount**](PlatformClient.md#setfacebookselectedaccount) | **PUT** /v1.0/protected/businesses/{id}/oauth/facebook/account | Set the selected Facebook/Instagram posting account |
@@ -585,6 +587,81 @@ example().catch(console.error);
585
587
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
586
588
 
587
589
 
590
+ ## chooseProvider
591
+
592
+ > Business chooseProvider(id, chooseProviderRequest)
593
+
594
+ Choose the active provider for a capability
595
+
596
+ When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
597
+
598
+ ### Example
599
+
600
+ ```ts
601
+ import {
602
+ Configuration,
603
+ PlatformClient,
604
+ } from '@snokam/platform-client';
605
+ import type { ChooseProviderOperationRequest } from '@snokam/platform-client';
606
+
607
+ async function example() {
608
+ console.log("🚀 Testing @snokam/platform-client SDK...");
609
+ const config = new Configuration({
610
+ // To configure OAuth2 access token for authorization: Implicit implicit
611
+ accessToken: "YOUR ACCESS TOKEN",
612
+ });
613
+ const api = new PlatformClient(config);
614
+
615
+ const body = {
616
+ // string
617
+ id: id_example,
618
+ // ChooseProviderRequest
619
+ chooseProviderRequest: ...,
620
+ } satisfies ChooseProviderOperationRequest;
621
+
622
+ try {
623
+ const data = await api.chooseProvider(body);
624
+ console.log(data);
625
+ } catch (error) {
626
+ console.error(error);
627
+ }
628
+ }
629
+
630
+ // Run the test
631
+ example().catch(console.error);
632
+ ```
633
+
634
+ ### Parameters
635
+
636
+
637
+ | Name | Type | Description | Notes |
638
+ |------------- | ------------- | ------------- | -------------|
639
+ | **id** | `string` | | [Defaults to `undefined`] |
640
+ | **chooseProviderRequest** | [ChooseProviderRequest](ChooseProviderRequest.md) | | |
641
+
642
+ ### Return type
643
+
644
+ [**Business**](Business.md)
645
+
646
+ ### Authorization
647
+
648
+ [Implicit implicit](../README.md#Implicit-implicit)
649
+
650
+ ### HTTP request headers
651
+
652
+ - **Content-Type**: `application/json`
653
+ - **Accept**: `application/json`
654
+
655
+
656
+ ### HTTP response details
657
+ | Status code | Description | Response headers |
658
+ |-------------|-------------|------------------|
659
+ | **200** | Payload of Business | - |
660
+ | **404** | No description | - |
661
+
662
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
663
+
664
+
588
665
  ## connectTenant
589
666
 
590
667
  > Business connectTenant(id)
@@ -1392,6 +1469,81 @@ example().catch(console.error);
1392
1469
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1393
1470
 
1394
1471
 
1472
+ ## disconnectIntegration
1473
+
1474
+ > Business disconnectIntegration(id, key)
1475
+
1476
+ Disconnect an integration
1477
+
1478
+ Deletes every secret the integration stores for this business — including the OAuth refresh token and cached access token — and clears the capability\'s provider choice when it pointed at this integration. Settings such as base URLs are left alone.
1479
+
1480
+ ### Example
1481
+
1482
+ ```ts
1483
+ import {
1484
+ Configuration,
1485
+ PlatformClient,
1486
+ } from '@snokam/platform-client';
1487
+ import type { DisconnectIntegrationRequest } from '@snokam/platform-client';
1488
+
1489
+ async function example() {
1490
+ console.log("🚀 Testing @snokam/platform-client SDK...");
1491
+ const config = new Configuration({
1492
+ // To configure OAuth2 access token for authorization: Implicit implicit
1493
+ accessToken: "YOUR ACCESS TOKEN",
1494
+ });
1495
+ const api = new PlatformClient(config);
1496
+
1497
+ const body = {
1498
+ // string
1499
+ id: id_example,
1500
+ // string
1501
+ key: key_example,
1502
+ } satisfies DisconnectIntegrationRequest;
1503
+
1504
+ try {
1505
+ const data = await api.disconnectIntegration(body);
1506
+ console.log(data);
1507
+ } catch (error) {
1508
+ console.error(error);
1509
+ }
1510
+ }
1511
+
1512
+ // Run the test
1513
+ example().catch(console.error);
1514
+ ```
1515
+
1516
+ ### Parameters
1517
+
1518
+
1519
+ | Name | Type | Description | Notes |
1520
+ |------------- | ------------- | ------------- | -------------|
1521
+ | **id** | `string` | | [Defaults to `undefined`] |
1522
+ | **key** | `string` | | [Defaults to `undefined`] |
1523
+
1524
+ ### Return type
1525
+
1526
+ [**Business**](Business.md)
1527
+
1528
+ ### Authorization
1529
+
1530
+ [Implicit implicit](../README.md#Implicit-implicit)
1531
+
1532
+ ### HTTP request headers
1533
+
1534
+ - **Content-Type**: Not defined
1535
+ - **Accept**: `application/json`
1536
+
1537
+
1538
+ ### HTTP response details
1539
+ | Status code | Description | Response headers |
1540
+ |-------------|-------------|------------------|
1541
+ | **200** | Payload of Business | - |
1542
+ | **404** | No description | - |
1543
+
1544
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1545
+
1546
+
1395
1547
  ## endImpersonation
1396
1548
 
1397
1549
  > endImpersonation(tokenId)
@@ -3325,6 +3477,69 @@ This endpoint does not need any parameter.
3325
3477
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3326
3478
 
3327
3479
 
3480
+ ## getProviderCatalog
3481
+
3482
+ > ProviderCatalogResponse getProviderCatalog()
3483
+
3484
+ List provider brand catalog
3485
+
3486
+ Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
3487
+
3488
+ ### Example
3489
+
3490
+ ```ts
3491
+ import {
3492
+ Configuration,
3493
+ PlatformClient,
3494
+ } from '@snokam/platform-client';
3495
+ import type { GetProviderCatalogRequest } from '@snokam/platform-client';
3496
+
3497
+ async function example() {
3498
+ console.log("🚀 Testing @snokam/platform-client SDK...");
3499
+ const config = new Configuration({
3500
+ // To configure OAuth2 access token for authorization: Implicit implicit
3501
+ accessToken: "YOUR ACCESS TOKEN",
3502
+ });
3503
+ const api = new PlatformClient(config);
3504
+
3505
+ try {
3506
+ const data = await api.getProviderCatalog();
3507
+ console.log(data);
3508
+ } catch (error) {
3509
+ console.error(error);
3510
+ }
3511
+ }
3512
+
3513
+ // Run the test
3514
+ example().catch(console.error);
3515
+ ```
3516
+
3517
+ ### Parameters
3518
+
3519
+ This endpoint does not need any parameter.
3520
+
3521
+ ### Return type
3522
+
3523
+ [**ProviderCatalogResponse**](ProviderCatalogResponse.md)
3524
+
3525
+ ### Authorization
3526
+
3527
+ [Implicit implicit](../README.md#Implicit-implicit)
3528
+
3529
+ ### HTTP request headers
3530
+
3531
+ - **Content-Type**: Not defined
3532
+ - **Accept**: `application/json`
3533
+
3534
+
3535
+ ### HTTP response details
3536
+ | Status code | Description | Response headers |
3537
+ |-------------|-------------|------------------|
3538
+ | **200** | Payload of ProviderCatalogResponse | - |
3539
+
3540
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3541
+
3542
+
3328
3543
  ## getProvisioningStatus
3329
3544
 
3330
3545
  > Business getProvisioningStatus(id)
@@ -7100,9 +7315,9 @@ This endpoint does not need any parameter.
7100
7315
 
7101
7316
  > StudioSanityConfig resolveStudioSanityConfig(host)
7102
7317
 
7103
- Resolve the Sanity Studio project/dataset for a host
7318
+ Resolve the Sanity Studio project/dataset and frontend URLs for a host
7104
7319
 
7105
- 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.
7320
+ Returns the non-secret Sanity project id and dataset a studio should point at for the given host, plus that tenant\'s frontend app URLs so document \'Vis side\' links resolve per tenant. A tenant host returns that tenant\'s project; a host that belongs to no business (the platform host) returns the shared platform project and no app URLs. 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.
7106
7321
 
7107
7322
  ### Example
7108
7323
 
@@ -7694,81 +7909,6 @@ example().catch(console.error);
7694
7909
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
7695
7910
 
7696
7911
 
7697
- ## setActiveProvider
7698
-
7699
- > Business setActiveProvider(id, setActiveProviderRequest)
7700
-
7701
- Choose the active provider for a capability
7702
-
7703
- When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
7704
-
7705
- ### Example
7706
-
7707
- ```ts
7708
- import {
7709
- Configuration,
7710
- PlatformClient,
7711
- } from '@snokam/platform-client';
7712
- import type { SetActiveProviderOperationRequest } from '@snokam/platform-client';
7713
-
7714
- async function example() {
7715
- console.log("🚀 Testing @snokam/platform-client SDK...");
7716
- const config = new Configuration({
7717
- // To configure OAuth2 access token for authorization: Implicit implicit
7718
- accessToken: "YOUR ACCESS TOKEN",
7719
- });
7720
- const api = new PlatformClient(config);
7721
-
7722
- const body = {
7723
- // string
7724
- id: id_example,
7725
- // SetActiveProviderRequest
7726
- setActiveProviderRequest: ...,
7727
- } satisfies SetActiveProviderOperationRequest;
7728
-
7729
- try {
7730
- const data = await api.setActiveProvider(body);
7731
- console.log(data);
7732
- } catch (error) {
7733
- console.error(error);
7734
- }
7735
- }
7736
-
7737
- // Run the test
7738
- example().catch(console.error);
7739
- ```
7740
-
7741
- ### Parameters
7742
-
7743
-
7744
- | Name | Type | Description | Notes |
7745
- |------------- | ------------- | ------------- | -------------|
7746
- | **id** | `string` | | [Defaults to `undefined`] |
7747
- | **setActiveProviderRequest** | [SetActiveProviderRequest](SetActiveProviderRequest.md) | | |
7748
-
7749
- ### Return type
7750
-
7751
- [**Business**](Business.md)
7752
-
7753
- ### Authorization
7754
-
7755
- [Implicit implicit](../README.md#Implicit-implicit)
7756
-
7757
- ### HTTP request headers
7758
-
7759
- - **Content-Type**: `application/json`
7760
- - **Accept**: `application/json`
7761
-
7762
-
7763
- ### HTTP response details
7764
- | Status code | Description | Response headers |
7765
- |-------------|-------------|------------------|
7766
- | **200** | Payload of Business | - |
7767
- | **404** | No description | - |
7768
-
7769
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
7770
-
7771
-
7772
7912
  ## setBusinessEmployeePhoto
7773
7913
 
7774
7914
  > ProtectedEmployee setBusinessEmployeePhoto(id, employeeId, body)
@@ -0,0 +1,18 @@
1
+
2
+ # ProviderCatalogEntry
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `capability` | string
10
+ `description` | string
11
+ `key` | string
12
+ `logoUrl` | string
13
+ `title` | string
14
+
15
+
16
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
17
+
18
+
@@ -0,0 +1,14 @@
1
+
2
+ # ProviderCatalogResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `providers` | [Array<ProviderCatalogEntry>](ProviderCatalogEntry.md)
10
+
11
+
12
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
13
+
14
+
@@ -6,6 +6,7 @@
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
+ `appUrls` | { [key: string]: string; }
9
10
  `dataset` | string
10
11
  `mode` | string
11
12
  `projectId` | string
@@ -19,6 +19,7 @@ Name | Type
19
19
  `entraTenantId` | string
20
20
  `isPlatformTemplate` | boolean
21
21
  `keyVaultName` | string
22
+ `onboardingActivateUrlOverrides` | { [key: string]: string; }
22
23
  `plan` | string
23
24
  `sanityDataset` | string
24
25
  `sanityProjectId` | string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@snokam/platform-client",
3
- "version": "1.0.0",
3
+ "version": "3.0.0",
4
4
  "description": "OpenAPI client for @snokam/platform-client",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {