@snokam/platform-client 1.0.0 → 3.0.0

package/src/apis/PlatformClient.ts

@@ -30,6 +30,7 @@ import type {
     BusinessAccess,
     BusinessHealth,
     Capability,
+    ChooseProviderRequest,
     CreateApiTokenRequest,
     CreateUserRequest,
     CreatedApiToken,
@@ -81,6 +82,7 @@ import type {
     PowerOfficeProject,
     PowerOfficeProjectsResponse,
     ProtectedEmployee,
+    ProviderCatalogResponse,
     RecordImpersonationActivityRequest,
     RenameDeviceRequest,
     ResetConfirmRequest,
@@ -88,7 +90,6 @@ import type {
     RevokeRequest,
     ScopeDefinition,
     SessionBootstrapRequest,
-    SetActiveProviderRequest,
     SetFacebookAccountRequest,
     SetGoogleAnalyticsPropertyRequest,
     SetPlatformSecretRequest,
@@ -152,6 +153,11 @@ export interface CheckPlatformIntegrationRequest {
     key: string;
 }
 
+export interface ChooseProviderOperationRequest {
+    id: string;
+    chooseProviderRequest: ChooseProviderRequest;
+}
+
 export interface ConnectTenantRequest {
     id: string;
 }
@@ -202,6 +208,11 @@ export interface DisableCredentialRequest {
     credentialId: string;
 }
 
+export interface DisconnectIntegrationRequest {
+    id: string;
+    key: string;
+}
+
 export interface EndImpersonationRequest {
     tokenId: string;
 }
@@ -510,11 +521,6 @@ export interface SetAccountingReinvoiceProductRequest {
     powerOfficeProduct: PowerOfficeProduct;
 }
 
-export interface SetActiveProviderOperationRequest {
-    id: string;
-    setActiveProviderRequest: SetActiveProviderRequest;
-}
-
 export interface SetBusinessEmployeePhotoRequest {
     id: string;
     employeeId: string;
@@ -978,6 +984,68 @@ export class PlatformClient extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for chooseProvider without sending the request
+     */
+    async chooseProviderRequestOpts(requestParameters: ChooseProviderOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling chooseProvider().'
+            );
+        }
+
+        if (requestParameters['chooseProviderRequest'] == null) {
+            throw new runtime.RequiredError(
+                'chooseProviderRequest',
+                'Required parameter "chooseProviderRequest" was null or undefined when calling chooseProvider().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("Implicit", []);
+        }
+
+
+        let urlPath = `/v1.0/protected/businesses/{id}/integrations/chosen`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['chooseProviderRequest'],
+        };
+    }
+
+    /**
+     * When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
+     * Choose the active provider for a capability
+     */
+    async chooseProviderRaw(requestParameters: ChooseProviderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>> {
+        const requestOptions = await this.chooseProviderRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
+     * Choose the active provider for a capability
+     */
+    async chooseProvider(requestParameters: ChooseProviderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business> {
+        const response = await this.chooseProviderRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for connectTenant without sending the request
      */
@@ -1593,6 +1661,66 @@ export class PlatformClient extends runtime.BaseAPI {
         await this.disableCredentialRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for disconnectIntegration without sending the request
+     */
+    async disconnectIntegrationRequestOpts(requestParameters: DisconnectIntegrationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling disconnectIntegration().'
+            );
+        }
+
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling disconnectIntegration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("Implicit", []);
+        }
+
+
+        let urlPath = `/v1.0/protected/businesses/{id}/integrations/{key}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+        urlPath = urlPath.replace('{key}', encodeURIComponent(String(requestParameters['key'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * 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.
+     * Disconnect an integration
+     */
+    async disconnectIntegrationRaw(requestParameters: DisconnectIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>> {
+        const requestOptions = await this.disconnectIntegrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * 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.
+     * Disconnect an integration
+     */
+    async disconnectIntegration(requestParameters: DisconnectIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business> {
+        const response = await this.disconnectIntegrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for endImpersonation without sending the request
      */
@@ -2986,6 +3114,50 @@ export class PlatformClient extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getProviderCatalog without sending the request
+     */
+    async getProviderCatalogRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("Implicit", []);
+        }
+
+
+        let urlPath = `/v1.0/protected/catalog/providers`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
+     * List provider brand catalog
+     */
+    async getProviderCatalogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProviderCatalogResponse>> {
+        const requestOptions = await this.getProviderCatalogRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Returns the global, platform-owned provider brand catalog (key, capability, title, logo, description). Single source of truth for provider branding across tenants.
+     * List provider brand catalog
+     */
+    async getProviderCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProviderCatalogResponse> {
+        const response = await this.getProviderCatalogRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getProvisioningStatus without sending the request
      */
@@ -5786,8 +5958,8 @@ export class PlatformClient extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
-     * Resolve the Sanity Studio project/dataset for a host
+     * 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.
+     * Resolve the Sanity Studio project/dataset and frontend URLs for a host
      */
     async resolveStudioSanityConfigRaw(requestParameters: ResolveStudioSanityConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudioSanityConfig>> {
         const requestOptions = await this.resolveStudioSanityConfigRequestOpts(requestParameters);
@@ -5797,8 +5969,8 @@ export class PlatformClient extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
-     * Resolve the Sanity Studio project/dataset for a host
+     * 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.
+     * Resolve the Sanity Studio project/dataset and frontend URLs for a host
      */
     async resolveStudioSanityConfig(requestParameters: ResolveStudioSanityConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudioSanityConfig> {
         const response = await this.resolveStudioSanityConfigRaw(requestParameters, initOverrides);
@@ -6219,68 +6391,6 @@ export class PlatformClient extends runtime.BaseAPI {
         await this.setAccountingReinvoiceProductRaw(requestParameters, initOverrides);
     }
 
-    /**
-     * Creates request options for setActiveProvider without sending the request
-     */
-    async setActiveProviderRequestOpts(requestParameters: SetActiveProviderOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['id'] == null) {
-            throw new runtime.RequiredError(
-                'id',
-                'Required parameter "id" was null or undefined when calling setActiveProvider().'
-            );
-        }
-
-        if (requestParameters['setActiveProviderRequest'] == null) {
-            throw new runtime.RequiredError(
-                'setActiveProviderRequest',
-                'Required parameter "setActiveProviderRequest" was null or undefined when calling setActiveProvider().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("Implicit", []);
-        }
-
-
-        let urlPath = `/v1.0/protected/businesses/{id}/integrations/active`;
-        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
-
-        return {
-            path: urlPath,
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: requestParameters['setActiveProviderRequest'],
-        };
-    }
-
-    /**
-     * When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
-     * Choose the active provider for a capability
-     */
-    async setActiveProviderRaw(requestParameters: SetActiveProviderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Business>> {
-        const requestOptions = await this.setActiveProviderRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response);
-    }
-
-    /**
-     * When a capability has several providers (e.g. PowerOffice vs Tripletex, Coinbase API-key vs OAuth), selects which one the business uses.
-     * Choose the active provider for a capability
-     */
-    async setActiveProvider(requestParameters: SetActiveProviderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Business> {
-        const response = await this.setActiveProviderRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
     /**
      * Creates request options for setBusinessEmployeePhoto without sending the request
      */

package/src/models/index.ts

@@ -744,6 +744,12 @@ export interface BusinessConfig {
      * @memberof BusinessConfig
      */
     olafTeamsSettings?: OlafTeamsSettings;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof BusinessConfig
+     */
+    onboardingActivateUrlOverrides?: { [key: string]: string; } | null;
     /**
      * 
      * @type {string}
@@ -948,6 +954,25 @@ export interface Capability {
      */
     platformProvided?: boolean | null;
 }
+/**
+ * 
+ * @export
+ * @interface ChooseProviderRequest
+ */
+export interface ChooseProviderRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ChooseProviderRequest
+     */
+    capability?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ChooseProviderRequest
+     */
+    integrationKey?: string | null;
+}
 /**
  * 
  * @export
@@ -2201,19 +2226,25 @@ export interface IntegrationSummary {
      * @type {boolean}
      * @memberof IntegrationSummary
      */
-    isActive?: boolean | null;
+    isConfigured?: boolean | null;
     /**
      * 
      * @type {boolean}
      * @memberof IntegrationSummary
      */
-    isConfigured?: boolean | null;
+    isInUse?: boolean | null;
     /**
      * 
      * @type {string}
      * @memberof IntegrationSummary
      */
     key?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntegrationSummary
+     */
+    logoUrl?: string | null;
     /**
      * 
      * @type {Array<string>}
@@ -4281,6 +4312,56 @@ export const ProtectedEmployeeSanityTypeEnum = {
 } as const;
 export type ProtectedEmployeeSanityTypeEnum = typeof ProtectedEmployeeSanityTypeEnum[keyof typeof ProtectedEmployeeSanityTypeEnum];
 
+/**
+ * 
+ * @export
+ * @interface ProviderCatalogEntry
+ */
+export interface ProviderCatalogEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderCatalogEntry
+     */
+    capability?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderCatalogEntry
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderCatalogEntry
+     */
+    key?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderCatalogEntry
+     */
+    logoUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderCatalogEntry
+     */
+    title?: string | null;
+}
+/**
+ * 
+ * @export
+ * @interface ProviderCatalogResponse
+ */
+export interface ProviderCatalogResponse {
+    /**
+     * 
+     * @type {Array<ProviderCatalogEntry>}
+     * @memberof ProviderCatalogResponse
+     */
+    providers?: Array<ProviderCatalogEntry> | null;
+}
 /**
  * 
  * @export
@@ -5548,25 +5629,6 @@ export interface SessionBootstrapRequest {
      */
     bootstrapToken?: string | null;
 }
-/**
- * 
- * @export
- * @interface SetActiveProviderRequest
- */
-export interface SetActiveProviderRequest {
-    /**
-     * 
-     * @type {string}
-     * @memberof SetActiveProviderRequest
-     */
-    capability?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof SetActiveProviderRequest
-     */
-    integrationKey?: string | null;
-}
 /**
  * 
  * @export
@@ -5902,6 +5964,12 @@ export interface StartImpersonationResult {
  * @interface StudioSanityConfig
  */
 export interface StudioSanityConfig {
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof StudioSanityConfig
+     */
+    appUrls?: { [key: string]: string; } | null;
     /**
      * 
      * @type {string}
@@ -6093,6 +6161,12 @@ export interface TenantInfo {
      * @memberof TenantInfo
      */
     keyVaultName?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof TenantInfo
+     */
+    onboardingActivateUrlOverrides?: { [key: string]: string; } | null;
     /**
      * 
      * @type {string}