@snokam/platform-client 3.0.0 → 3.1.1

package/src/apis/PlatformClient.ts

@@ -22,6 +22,8 @@ import type {
     AppCatalogEntry,
     AppModule,
     ApproveDeviceRequest,
+    AuthorizationPreview,
+    AuthorizationRequest,
     BillingPaymentMethod,
     BillingSessionRequest,
     BillingSessionResponse,
@@ -57,6 +59,7 @@ import type {
     IntegrationSummary,
     InviteCredentialRequest,
     InvoiceBasis,
+    IssuedAuthorizationCode,
     LoginConfig,
     MeApp,
     MeterEnforcementDecision,
@@ -133,6 +136,10 @@ export interface ApproveDeviceOperationRequest {
     approveDeviceRequest: ApproveDeviceRequest;
 }
 
+export interface ApproveOAuthAuthorizationRequest {
+    authorizationRequest: AuthorizationRequest;
+}
+
 export interface AssignBusinessEmployeeSystemRequest {
     id: string;
     upn: string;
@@ -454,6 +461,10 @@ export interface PreviewDeviceRequest {
     code: string;
 }
 
+export interface PreviewOAuthAuthorizationRequest {
+    authorizationRequest: AuthorizationRequest;
+}
+
 export interface ProvisionBusinessRequest {
     id: string;
 }
@@ -748,6 +759,60 @@ export class PlatformClient extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for approveOAuthAuthorization without sending the request
+     */
+    async approveOAuthAuthorizationRequestOpts(requestParameters: ApproveOAuthAuthorizationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['authorizationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'authorizationRequest',
+                'Required parameter "authorizationRequest" was null or undefined when calling approveOAuthAuthorization().'
+            );
+        }
+
+        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/oauth/authorization`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['authorizationRequest'],
+        };
+    }
+
+    /**
+     * Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
+     * Record the user\'s approval of an app\'s sign-in request
+     */
+    async approveOAuthAuthorizationRaw(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssuedAuthorizationCode>> {
+        const requestOptions = await this.approveOAuthAuthorizationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
+     * Record the user\'s approval of an app\'s sign-in request
+     */
+    async approveOAuthAuthorization(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssuedAuthorizationCode> {
+        const response = await this.approveOAuthAuthorizationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for assignBusinessEmployeeSystem without sending the request
      */
@@ -5434,6 +5499,60 @@ export class PlatformClient extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for previewOAuthAuthorization without sending the request
+     */
+    async previewOAuthAuthorizationRequestOpts(requestParameters: PreviewOAuthAuthorizationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['authorizationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'authorizationRequest',
+                'Required parameter "authorizationRequest" was null or undefined when calling previewOAuthAuthorization().'
+            );
+        }
+
+        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/oauth/authorization/preview`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['authorizationRequest'],
+        };
+    }
+
+    /**
+     * 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.
+     * Describe an app\'s sign-in request before the user approves it
+     */
+    async previewOAuthAuthorizationRaw(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthorizationPreview>> {
+        const requestOptions = await this.previewOAuthAuthorizationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * 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.
+     * Describe an app\'s sign-in request before the user approves it
+     */
+    async previewOAuthAuthorization(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthorizationPreview> {
+        const response = await this.previewOAuthAuthorizationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for provisionBusiness without sending the request
      */
@@ -5908,7 +6027,7 @@ export class PlatformClient extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      * Resolve the platform Sanity read config
      */
     async resolvePlatformSanityConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlatformSanityConfig>> {
@@ -5919,7 +6038,7 @@ export class PlatformClient extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      * Resolve the platform Sanity read config
      */
     async resolvePlatformSanityConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlatformSanityConfig> {

package/src/models/index.ts

@@ -279,6 +279,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
@@ -2398,6 +2460,19 @@ export interface InvoiceBasisLine {
      */
     unitPriceOre?: number | null;
 }
+/**
+ * 
+ * @export
+ * @interface IssuedAuthorizationCode
+ */
+export interface IssuedAuthorizationCode {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuedAuthorizationCode
+     */
+    code?: string | null;
+}
 /**
  * 
  * @export
@@ -3342,6 +3417,12 @@ export interface PatchEmployee {
      * @memberof PatchEmployee
      */
     isSeekingProject?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchEmployee
+     */
+    leadershipGroupMember?: boolean | null;
     /**
      * 
      * @type {string}
@@ -3390,12 +3471,6 @@ export interface PatchEmployee {
      * @memberof PatchEmployee
      */
     parentalLeaveCoverage?: PatchEmployeeParentalLeaveCoverageEnum | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof PatchEmployee
-     */
-    parentalLeaveStartDate?: string;
     /**
      * 
      * @type {string}
@@ -4122,6 +4197,12 @@ export interface ProtectedEmployee {
      * @memberof ProtectedEmployee
      */
     isSeekingProject?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProtectedEmployee
+     */
+    leadershipGroupMember?: boolean;
     /**
      * 
      * @type {string}
@@ -4170,12 +4251,6 @@ export interface ProtectedEmployee {
      * @memberof ProtectedEmployee
      */
     parentalLeaveCoverage?: ProtectedEmployeeParentalLeaveCoverageEnum | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof ProtectedEmployee
-     */
-    parentalLeaveStartDate?: string;
     /**
      * 
      * @type {string}
@@ -4955,6 +5030,12 @@ export interface SanityEmployeeGroupsInner {
      * @memberof SanityEmployeeGroupsInner
      */
     scopeGrants?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof SanityEmployeeGroupsInner
+     */
+    slackChannel?: string;
 }