@snokam/platform-client 3.0.0 → 3.1.1

package/dist/esm/models/index.d.ts

@@ -277,6 +277,68 @@ export interface ApproveDeviceRequest {
      */
     name?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface AuthorizationPreview
+ */
+export interface AuthorizationPreview {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationPreview
+     */
+    businessName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationPreview
+     */
+    clientName?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface AuthorizationRequest
+ */
+export interface AuthorizationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    clientId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    codeChallenge?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    codeChallengeMethod?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    redirectUri?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    resource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    userToken?: string | null;
+}
 /**
  *
  * @export
@@ -2387,6 +2449,19 @@ export interface InvoiceBasisLine {
      */
     unitPriceOre?: number | null;
 }
+/**
+ *
+ * @export
+ * @interface IssuedAuthorizationCode
+ */
+export interface IssuedAuthorizationCode {
+    /**
+     *
+     * @type {string}
+     * @memberof IssuedAuthorizationCode
+     */
+    code?: string | null;
+}
 /**
  *
  * @export
@@ -3323,6 +3398,12 @@ export interface PatchEmployee {
      * @memberof PatchEmployee
      */
     isSeekingProject?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEmployee
+     */
+    leadershipGroupMember?: boolean | null;
     /**
      *
      * @type {string}
@@ -3373,12 +3454,6 @@ export interface PatchEmployee {
      * @memberof PatchEmployee
      */
     parentalLeaveCoverage?: PatchEmployeeParentalLeaveCoverageEnum | null;
-    /**
-     *
-     * @type {string}
-     * @memberof PatchEmployee
-     */
-    parentalLeaveStartDate?: string;
     /**
      *
      * @type {string}
@@ -4092,6 +4167,12 @@ export interface ProtectedEmployee {
      * @memberof ProtectedEmployee
      */
     isSeekingProject?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProtectedEmployee
+     */
+    leadershipGroupMember?: boolean;
     /**
      *
      * @type {string}
@@ -4142,12 +4223,6 @@ export interface ProtectedEmployee {
      * @memberof ProtectedEmployee
      */
     parentalLeaveCoverage?: ProtectedEmployeeParentalLeaveCoverageEnum | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ProtectedEmployee
-     */
-    parentalLeaveStartDate?: string;
     /**
      *
      * @type {string}
@@ -4899,6 +4974,12 @@ export interface SanityEmployeeGroupsInner {
      * @memberof SanityEmployeeGroupsInner
      */
     scopeGrants?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof SanityEmployeeGroupsInner
+     */
+    slackChannel?: string;
 }
 /**
  * @export

package/dist/models/index.d.ts

@@ -277,6 +277,68 @@ export interface ApproveDeviceRequest {
      */
     name?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface AuthorizationPreview
+ */
+export interface AuthorizationPreview {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationPreview
+     */
+    businessName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationPreview
+     */
+    clientName?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface AuthorizationRequest
+ */
+export interface AuthorizationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    clientId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    codeChallenge?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    codeChallengeMethod?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    redirectUri?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    resource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    userToken?: string | null;
+}
 /**
  *
  * @export
@@ -2387,6 +2449,19 @@ export interface InvoiceBasisLine {
      */
     unitPriceOre?: number | null;
 }
+/**
+ *
+ * @export
+ * @interface IssuedAuthorizationCode
+ */
+export interface IssuedAuthorizationCode {
+    /**
+     *
+     * @type {string}
+     * @memberof IssuedAuthorizationCode
+     */
+    code?: string | null;
+}
 /**
  *
  * @export
@@ -3323,6 +3398,12 @@ export interface PatchEmployee {
      * @memberof PatchEmployee
      */
     isSeekingProject?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEmployee
+     */
+    leadershipGroupMember?: boolean | null;
     /**
      *
      * @type {string}
@@ -3373,12 +3454,6 @@ export interface PatchEmployee {
      * @memberof PatchEmployee
      */
     parentalLeaveCoverage?: PatchEmployeeParentalLeaveCoverageEnum | null;
-    /**
-     *
-     * @type {string}
-     * @memberof PatchEmployee
-     */
-    parentalLeaveStartDate?: string;
     /**
      *
      * @type {string}
@@ -4092,6 +4167,12 @@ export interface ProtectedEmployee {
      * @memberof ProtectedEmployee
      */
     isSeekingProject?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProtectedEmployee
+     */
+    leadershipGroupMember?: boolean;
     /**
      *
      * @type {string}
@@ -4142,12 +4223,6 @@ export interface ProtectedEmployee {
      * @memberof ProtectedEmployee
      */
     parentalLeaveCoverage?: ProtectedEmployeeParentalLeaveCoverageEnum | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ProtectedEmployee
-     */
-    parentalLeaveStartDate?: string;
     /**
      *
      * @type {string}
@@ -4899,6 +4974,12 @@ export interface SanityEmployeeGroupsInner {
      * @memberof SanityEmployeeGroupsInner
      */
     scopeGrants?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof SanityEmployeeGroupsInner
+     */
+    slackChannel?: string;
 }
 /**
  * @export

package/docs/AuthorizationPreview.md

@@ -0,0 +1,15 @@
+
+# AuthorizationPreview
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`businessName` | string
+`clientName` | string
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AuthorizationRequest.md

@@ -0,0 +1,19 @@
+
+# AuthorizationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`codeChallenge` | string
+`codeChallengeMethod` | string
+`redirectUri` | string
+`resource` | string
+`userToken` | string
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/IssuedAuthorizationCode.md

@@ -0,0 +1,14 @@
+
+# IssuedAuthorizationCode
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PatchEmployee.md

@@ -32,6 +32,7 @@ Name | Type
 `isExternal` | boolean
 `isPublic` | boolean
 `isSeekingProject` | boolean
+`leadershipGroupMember` | boolean
 `linkedin` | string
 `manager` | [EmployeeReference](EmployeeReference.md)
 `maritalStatus` | string
@@ -40,7 +41,6 @@ Name | Type
 `nextOfKin` | [Array<SanityEmployeeNextOfKinInner>](SanityEmployeeNextOfKinInner.md)
 `nrOfChildren` | number
 `parentalLeaveCoverage` | string
-`parentalLeaveStartDate` | string
 `personalProjectRequirements` | string
 `position` | string
 `salaryConfig` | [PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfig](PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfig.md)

package/docs/PlatformClient.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
 |------------- | ------------- | -------------|
 | [**addCustomDomain**](PlatformClient.md#addcustomdomainoperation) | **POST** /v1.0/protected/businesses/{id}/custom-domains | Add a custom domain |
 | [**approveDevice**](PlatformClient.md#approvedeviceoperation) | **POST** /v1.0/protected/businesses/{id}/devices | Approve a screen into this business |
+| [**approveOAuthAuthorization**](PlatformClient.md#approveoauthauthorization) | **POST** /v1.0/protected/oauth/authorization | Record the user\'s approval of an app\'s sign-in request |
 | [**assignBusinessEmployeeSystem**](PlatformClient.md#assignbusinessemployeesystem) | **POST** /v1.0/protected/businesses/{id}/employees/{upn}/systems/{systemKey} | Grant an employee a seat in a third-party system |
 | [**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 |
 | [**checkIntegration**](PlatformClient.md#checkintegration) | **POST** /v1.0/protected/businesses/{id}/integrations/{key}/check | Run a live integration connectivity check |
@@ -96,6 +97,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
 | [**powerOfficeOnboardingReturn**](PlatformClient.md#powerofficeonboardingreturn) | **GET** /v1.0/connect/poweroffice/return/{reference} | PowerOffice onboarding return |
 | [**previewBillingInvoice**](PlatformClient.md#previewbillinginvoice) | **POST** /v1.0/protected/businesses/{id}/billing/invoice-preview | Preview a month\'s invoice basis |
 | [**previewDevice**](PlatformClient.md#previewdevice) | **GET** /v1.0/protected/businesses/{id}/devices/preview | Look up a pairing code before approving |
+| [**previewOAuthAuthorization**](PlatformClient.md#previewoauthauthorization) | **POST** /v1.0/protected/oauth/authorization/preview | Describe an app\'s sign-in request before the user approves it |
 | [**provisionBusiness**](PlatformClient.md#provisionbusiness) | **POST** /v1.0/protected/businesses/{id}/provision | Provision a business |
 | [**publicCapabilities**](PlatformClient.md#publiccapabilities) | **GET** /v1.0/public/capabilities | Get capabilities |
 | [**publicModules**](PlatformClient.md#publicmodules) | **GET** /v1.0/public/modules | Get available modules |
@@ -288,6 +290,78 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## approveOAuthAuthorization
+
+> IssuedAuthorizationCode approveOAuthAuthorization(authorizationRequest)
+
+Record the user\'s approval of an app\'s sign-in request
+
+Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlatformClient,
+} from '@snokam/platform-client';
+import type { ApproveOAuthAuthorizationRequest } from '@snokam/platform-client';
+
+async function example() {
+  console.log("🚀 Testing @snokam/platform-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: Implicit implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PlatformClient(config);
+
+  const body = {
+    // AuthorizationRequest
+    authorizationRequest: ...,
+  } satisfies ApproveOAuthAuthorizationRequest;
+
+  try {
+    const data = await api.approveOAuthAuthorization(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **authorizationRequest** | [AuthorizationRequest](AuthorizationRequest.md) |  | |
+
+### Return type
+
+[**IssuedAuthorizationCode**](IssuedAuthorizationCode.md)
+
+### Authorization
+
+[Implicit implicit](../README.md#Implicit-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Payload of IssuedAuthorizationCode |  -  |
+| **400** | Payload of String |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## assignBusinessEmployeeSystem
 
 > EmployeeSystemAccess assignBusinessEmployeeSystem(id, upn, systemKey, roleId)
@@ -6634,6 +6708,78 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## previewOAuthAuthorization
+
+> AuthorizationPreview previewOAuthAuthorization(authorizationRequest)
+
+Describe an app\'s sign-in request before the user approves it
+
+Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlatformClient,
+} from '@snokam/platform-client';
+import type { PreviewOAuthAuthorizationRequest } from '@snokam/platform-client';
+
+async function example() {
+  console.log("🚀 Testing @snokam/platform-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: Implicit implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PlatformClient(config);
+
+  const body = {
+    // AuthorizationRequest
+    authorizationRequest: ...,
+  } satisfies PreviewOAuthAuthorizationRequest;
+
+  try {
+    const data = await api.previewOAuthAuthorization(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **authorizationRequest** | [AuthorizationRequest](AuthorizationRequest.md) |  | |
+
+### Return type
+
+[**AuthorizationPreview**](AuthorizationPreview.md)
+
+### Authorization
+
+[Implicit implicit](../README.md#Implicit-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Payload of AuthorizationPreview |  -  |
+| **400** | Payload of String |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## provisionBusiness
 
 > Business provisionBusiness(id)
@@ -7252,7 +7398,7 @@ example().catch(console.error);
 
 Resolve the platform Sanity read config
 
-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.
+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.
 
 ### Example
 

package/docs/ProtectedEmployee.md

@@ -31,6 +31,7 @@ Name | Type
 `isExternal` | boolean
 `isPublic` | boolean
 `isSeekingProject` | boolean
+`leadershipGroupMember` | boolean
 `linkedin` | string
 `manager` | [SanityEmployeeManager](SanityEmployeeManager.md)
 `maritalStatus` | string
@@ -39,7 +40,6 @@ Name | Type
 `nextOfKin` | [Array<SanityEmployeeNextOfKinInner>](SanityEmployeeNextOfKinInner.md)
 `nrOfChildren` | number
 `parentalLeaveCoverage` | string
-`parentalLeaveStartDate` | string
 `personalProjectRequirements` | string
 `position` | string
 `salaryConfig` | [SanityEmployeeSalaryConfig](SanityEmployeeSalaryConfig.md)

package/docs/SanityEmployeeGroupsInner.md

@@ -17,6 +17,7 @@ Name | Type
 `sanityType` | string
 `sanityUpdatedAt` | string
 `scopeGrants` | Array<string>
+`slackChannel` | string
 
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snokam/platform-client",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "OpenAPI client for @snokam/platform-client",
   "author": "OpenAPI-Generator",
   "repository": {