@compassdigital/sdk.typescript 4.41.0 → 4.42.0

package/src/interface/auth.ts

@@ -12,13 +12,68 @@ export interface SSOFlowResponseDTO {
   oidc?: OIDC;
 }
 
-export interface SSOConfigResponseDTO {
+export interface SSOConfigsResponseDTO {
+  name: string;
+  clientId: string;
+  authorizationEndpoint: string;
+  tokenEndpoint: string;
+  userinfoEndpoint: string;
+  realm: string;
+}
+
+export interface SSOConfigRequestDTO {
   name: string;
   clientId: string;
   authorizationEndpoint: string;
+  clientSecret: string;
   tokenEndpoint: string;
   userinfoEndpoint: string;
   realm: string;
+  protocol: "OIDC" | "SAML2";
+}
+
+export interface SSOConfigResponseDTO {
+  success: boolean;
+}
+
+export interface SSOAuthRequestDTO {
+  code: string;
+  name: string;
+  clientId: string;
+}
+
+export interface Token {
+  token: string;
+  expires: string;
+}
+
+export interface Name {
+  first: string;
+  last: string;
+}
+
+export interface Date {
+  modified: string;
+  created: string;
+}
+
+export interface Is {
+  disabled: boolean;
+  verified: boolean;
+}
+
+export interface Profile {
+  id: string;
+  email: string;
+  name?: Name;
+  date?: Date;
+  ssoId: string;
+  is?: Is;
+}
+
+export interface SSOAuthResponseDTO {
+  access: Token;
+  profile: Profile;
 }
 
 // GET /auth/flow - Determines the authentication flow for a user based on their email address
@@ -42,8 +97,28 @@ export interface GetAuthSsoConfigsQuery {
   _query?: string;
 }
 
-export type GetAuthSsoConfigsResponse = SSOConfigResponseDTO[];
+export type GetAuthSsoConfigsResponse = SSOConfigsResponseDTO[];
 
 export interface GetAuthSsoConfigsRequest
   extends BaseRequest,
     RequestQuery<GetAuthSsoConfigsQuery> {}
+
+// POST /auth/sso-config - Create a new SSO configuration
+
+export type PostAuthSsoConfigBody = SSOConfigRequestDTO;
+
+export type PostAuthSsoConfigResponse = SSOConfigResponseDTO;
+
+export interface PostAuthSsoConfigRequest extends BaseRequest {
+  body: PostAuthSsoConfigBody;
+}
+
+// POST /auth/sso - Authenticates a user using a SSO provider.
+
+export type PostAuthSsoBody = SSOAuthRequestDTO;
+
+export type PostAuthSsoResponse = SSOAuthResponseDTO;
+
+export interface PostAuthSsoRequest extends BaseRequest {
+  body: PostAuthSsoBody;
+}

package/src/interface/compassconnect.ts

@@ -25,6 +25,34 @@ export interface Auth {
     token?: string;
     expires?: string;
   };
+  // Access token string (should be moved inside access object under real scenarios)
+  access_token?: string;
+  // Duration in seconds until the access token expires (should be moved inside access object under real scenarios)
+  expires_in?: number;
+  // Unix timestamp when the token expires (should be moved inside access object under real scenarios)
+  expires_at?: number;
+  attributes?: {
+    clientName?: string;
+    company?: string;
+    country?: string;
+    credentialType?: string;
+    department?: string;
+    email?: string;
+    first_name?: string;
+    full_name?: string;
+    last_name?: string;
+    locale?: string;
+    logon_username?: string;
+    mobile?: string;
+    samlAuthenticationStatementAuthMethod?: string;
+    telephone?: string;
+    title?: string;
+    userPrincipalName?: string;
+  };
+  // Identifier of the user or session
+  id?: string;
+  // Refresh token string (should be moved inside refresh object under real scenarios)
+  refresh_token?: string;
 }
 
 export interface Compassconnect {
@@ -36,7 +64,7 @@ export interface Compassconnects {
   compassconnects: Compassconnect[];
 }
 
-// GET /compassconnect/get_oms_token - Gets an OMS token
+// GET /compassconnect/oms_token - Gets an OMS token
 
 export interface GetCompassconnectOmsTokenQuery {
   // The SSO code recieved from login

package/src/interface/frictionless.ts

@@ -217,19 +217,6 @@ export interface AmazonJWOOrderingResponseDTO {
   purchaseId: string;
 }
 
-export interface StandardCognitionEventDTO {
-  // Value that uniquely identifies each event that occurs in Standard Cognition's system
-  event_id: string;
-  // Contains an enumerated string that tells the system what type of event took place. Current values are external-customer-order-created for when a new order is created and external-customer-order-state-changed for when an order changes state
-  event_type: "external-customer-order-created" | "external-customer-order-state-changed";
-  // Value that uniquely identifies each customer in Standard Cognition's system. Coincides with our Checkin ID
-  external_customer_id: string;
-  // Value that uniquely identifies each store in Standard Cognition's system
-  tenant_id: string;
-  // Value that uniquely identifies each order in Standard Cognition's system
-  order_id: string;
-}
-
 // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
 
 export interface GetFrictionlessBrandFrictionlessStatusPath {
@@ -377,13 +364,3 @@ export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
 export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
   body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
 }
-
-// POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
-
-export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEventDTO;
-
-export type PostFrictionlessWebhookStandardcognitionResponse = {};
-
-export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
-  body: PostFrictionlessWebhookStandardcognitionBody;
-}