@compassdigital/sdk.typescript 4.731.0 → 4.733.0

package/src/index.ts

@@ -1235,6 +1235,8 @@ import {
 	GetConsumerLocationGroupResponse$0,
 	GetConsumerLocationMultigroupQuery,
 	GetConsumerLocationMultigroupResponse,
+	GetConsumerClientGroupsQuery,
+	GetConsumerClientGroupsResponse$0,
 	GetConsumerActiveMenusQuery,
 	GetConsumerActiveMenusResponse,
 	GetConsumerMenuRecommendedItemsQuery,
@@ -1455,6 +1457,17 @@ import {
 	PostAuthJwtAssertionBody,
 	PostAuthJwtAssertionResponse,
 	GetAuthJwtAssertionJwkResponse,
+	GetAuthConnectProviderAuthorizeQuery,
+	GetAuthConnectProviderAuthorizeResponse,
+	PostAuthConnectProviderConfigBody,
+	PostAuthConnectProviderConfigResponse,
+	PutAuthConnectProviderConfigBody,
+	PutAuthConnectProviderConfigResponse,
+	GetAuthConnectProviderConfigQuery,
+	GetAuthConnectProviderConfigResponse,
+	DeleteAuthConnectProviderConfigQuery,
+	DeleteAuthConnectProviderConfigResponse,
+	GetAuthConnectProvidersResponse,
 } from './interface/auth';
 
 import {
@@ -14275,6 +14288,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /consumer/client-groups/{client} - Get a client's nearest sites with their business units and stations
+	 *
+	 * @param client - Client slug whose sites are returned
+	 * @param options - additional request options
+	 */
+	get_consumer_client_groups(
+		client: string,
+		options: {
+			query: GetConsumerClientGroupsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerClientGroupsResponse$0> {
+		return this.request(
+			'consumer',
+			'/consumer/client-groups/{client}',
+			'GET',
+			`/consumer/client-groups/${client}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /consumer/active-menus/{stationId} - Get current menu
 	 *
@@ -16803,6 +16838,134 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /auth/connect/providers/{provider}/authorize - Starts linking a messaging identity (Slack, Teams) to the caller's CD account.
+	 *
+	 * @param provider
+	 * @param options - additional request options
+	 */
+	get_auth_connect_provider_authorize(
+		provider: string,
+		options: {
+			query: GetAuthConnectProviderAuthorizeQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetAuthConnectProviderAuthorizeResponse> {
+		return this.request(
+			'auth',
+			'/auth/connect/providers/{provider}/authorize',
+			'GET',
+			`/auth/connect/providers/${provider}/authorize`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /auth/connect/providers/{provider} - Registers a provider's OIDC config for a product (e.g. Slack for thrive).
+	 *
+	 * @param provider
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_auth_connect_provider_config(
+		provider: string,
+		body: PostAuthConnectProviderConfigBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAuthConnectProviderConfigResponse> {
+		return this.request(
+			'auth',
+			'/auth/connect/providers/{provider}',
+			'POST',
+			`/auth/connect/providers/${provider}`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * PUT /auth/connect/providers/{provider} - Updates a product's existing OIDC provider config (full replace).
+	 *
+	 * @param provider
+	 * @param body
+	 * @param options - additional request options
+	 */
+	put_auth_connect_provider_config(
+		provider: string,
+		body: PutAuthConnectProviderConfigBody,
+		options?: RequestOptions,
+	): ResponsePromise<PutAuthConnectProviderConfigResponse> {
+		return this.request(
+			'auth',
+			'/auth/connect/providers/{provider}',
+			'PUT',
+			`/auth/connect/providers/${provider}`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /auth/connect/providers/{provider} - Returns a product's registered OIDC provider config.
+	 *
+	 * @param provider
+	 * @param options - additional request options
+	 */
+	get_auth_connect_provider_config(
+		provider: string,
+		options: {
+			query: GetAuthConnectProviderConfigQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetAuthConnectProviderConfigResponse> {
+		return this.request(
+			'auth',
+			'/auth/connect/providers/{provider}',
+			'GET',
+			`/auth/connect/providers/${provider}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * DELETE /auth/connect/providers/{provider} - Deletes a product's OIDC provider config.
+	 *
+	 * @param provider
+	 * @param options - additional request options
+	 */
+	delete_auth_connect_provider_config(
+		provider: string,
+		options: {
+			query: DeleteAuthConnectProviderConfigQuery;
+		} & RequestOptions,
+	): ResponsePromise<DeleteAuthConnectProviderConfigResponse> {
+		return this.request(
+			'auth',
+			'/auth/connect/providers/{provider}',
+			'DELETE',
+			`/auth/connect/providers/${provider}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /auth/connect/providers - Returns every registered connect provider config, across every product.
+	 *
+	 * @param options - additional request options
+	 */
+	get_auth_connect_providers(
+		options?: RequestOptions,
+	): ResponsePromise<GetAuthConnectProvidersResponse> {
+		return this.request(
+			'auth',
+			'/auth/connect/providers',
+			'GET',
+			`/auth/connect/providers`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /review - Get reviews by taxonomy
 	 *

package/src/interface/auth.ts

@@ -155,6 +155,56 @@ export interface JwtAssertionJwkResponse {
 	n: string;
 }
 
+export interface ConnectAuthorizeResponseDTO {
+	// The provider's full authorization URL — the product frontend just redirects the browser here.
+	authorizeUrl: string;
+}
+
+export interface ConnectProviderConfigRequestDTO {
+	// Which internal product this registration belongs to, e.g. "thrive".
+	product: string;
+	// The client_id this provider (Slack/Teams) assigned to our app.
+	oauthClientId: string;
+	// The client_secret this provider (Slack/Teams) assigned to our app.
+	oauthClientSecret: string;
+	authorizationEndpoint: string;
+	tokenEndpoint: string;
+	jwksUri: string;
+	// May contain a {tenantid} placeholder for multi-tenant issuers (e.g. Microsoft Entra).
+	issuer: string;
+	// Which id_token claim carries the external subject id.
+	subjectClaim: string;
+	// Which id_token claim carries the tenant/team id.
+	tenantClaim: string;
+	successUrl: string;
+	errorUrl: string;
+}
+
+export interface ConnectProviderConfigResponseDTO {
+	success: boolean;
+}
+
+export interface ConnectProviderConfigListResponseDTO {
+	// Which internal product this registration belongs to, e.g. "thrive".
+	product: string;
+	// The client_id this provider (Slack/Teams) assigned to our app.
+	oauthClientId: string;
+	authorizationEndpoint: string;
+	tokenEndpoint: string;
+	jwksUri: string;
+	// May contain a {tenantid} placeholder for multi-tenant issuers (e.g. Microsoft Entra).
+	issuer: string;
+	// Which id_token claim carries the external subject id.
+	subjectClaim: string;
+	// Which id_token claim carries the tenant/team id.
+	tenantClaim: string;
+	successUrl: string;
+	errorUrl: string;
+	// Which provider this registration is for, e.g. "slack".
+	provider: string;
+	createdAt: string;
+}
+
 // POST /auth/flow - Determines the authentication flow for a user based on their email address
 
 export type PostAuthFlowBody = SSOFlowRequestDTO;
@@ -228,3 +278,66 @@ export type PostAuthJwtAssertionResponse = JwtAssertionResponse;
 // GET /auth/jwt-assertion/jwk - Get the public JWK for JWT assertion
 
 export type GetAuthJwtAssertionJwkResponse = JwtAssertionJwkResponse;
+
+// GET /auth/connect/providers/{provider}/authorize - Starts linking a messaging identity (Slack, Teams) to the caller's CD account.
+
+export interface GetAuthConnectProviderAuthorizePath {
+	provider: string;
+}
+
+export interface GetAuthConnectProviderAuthorizeQuery {
+	// Which internal product owns this registration, e.g. "thrive".
+	product: string;
+}
+
+export type GetAuthConnectProviderAuthorizeResponse = ConnectAuthorizeResponseDTO;
+
+// POST /auth/connect/providers/{provider} - Registers a provider's OIDC config for a product (e.g. Slack for thrive).
+
+export interface PostAuthConnectProviderConfigPath {
+	provider: string;
+}
+
+export type PostAuthConnectProviderConfigBody = ConnectProviderConfigRequestDTO;
+
+export type PostAuthConnectProviderConfigResponse = ConnectProviderConfigResponseDTO;
+
+// PUT /auth/connect/providers/{provider} - Updates a product's existing OIDC provider config (full replace).
+
+export interface PutAuthConnectProviderConfigPath {
+	provider: string;
+}
+
+export type PutAuthConnectProviderConfigBody = ConnectProviderConfigRequestDTO;
+
+export type PutAuthConnectProviderConfigResponse = ConnectProviderConfigResponseDTO;
+
+// GET /auth/connect/providers/{provider} - Returns a product's registered OIDC provider config.
+
+export interface GetAuthConnectProviderConfigPath {
+	provider: string;
+}
+
+export interface GetAuthConnectProviderConfigQuery {
+	// Which internal product owns this registration, e.g. "thrive".
+	product: string;
+}
+
+export type GetAuthConnectProviderConfigResponse = ConnectProviderConfigListResponseDTO;
+
+// DELETE /auth/connect/providers/{provider} - Deletes a product's OIDC provider config.
+
+export interface DeleteAuthConnectProviderConfigPath {
+	provider: string;
+}
+
+export interface DeleteAuthConnectProviderConfigQuery {
+	// Which internal product owns this registration, e.g. "thrive".
+	product: string;
+}
+
+export type DeleteAuthConnectProviderConfigResponse = ConnectProviderConfigResponseDTO;
+
+// GET /auth/connect/providers - Returns every registered connect provider config, across every product.
+
+export type GetAuthConnectProvidersResponse = ConnectProviderConfigListResponseDTO[];

package/src/interface/consumer.ts

@@ -1580,6 +1580,8 @@ export interface ConsumerGroupMobile {
 
 export interface ConsumerGroup {
 	status?: 'active' | 'inactive';
+	// client slug the site is assigned to
+	client?: string;
 	id?: string;
 	name?: string;
 	label?: {
@@ -1627,6 +1629,8 @@ export interface HomePageResponse {
 	orders?: HomePageOrder[];
 	// location object for the site
 	location?: ConsumerGroup;
+	// nearest sites for the client, hydrated with business units and stations
+	clientGroups?: ConsumerGroup[];
 	// free coffee object
 	freeCoffee?: FreeCoffeeDTO;
 	// mealplan barcode object
@@ -1759,6 +1763,8 @@ export interface GetConsumerLocationGroupResponse {
 	timezone?: string;
 	// site operational status
 	status?: Record<string, any>;
+	// client slug the site is assigned to
+	client?: string;
 	locations?: ConsumerLocation[];
 	address?: ConsumerAddress;
 }
@@ -1772,6 +1778,13 @@ export interface GetConsumerLocationMultiGroupResponse {
 	groups: Record<string, any>[];
 }
 
+export interface GetConsumerClientGroupsResponse {
+	// Multigroup id the sites were searched within
+	id: string;
+	// Nearest sites assigned to the client, each hydrated with its business units and stations, ordered nearest-first.
+	groups: ConsumerGroup[];
+}
+
 export interface ConsumerGetActiveMenusResponse {
 	// menus
 	menus: ConsumerMenuHours[];
@@ -4697,6 +4710,12 @@ export interface GetConsumerHomePageQuery {
 	appName?: string;
 	// reorder eligible
 	reorderEligible: boolean;
+	// Client slug whose nearest sites are added to the response (needs latitude and longitude to sort)
+	client?: string;
+	// Latitude used to sort the client nearest sites
+	latitude?: number;
+	// Longitude used to sort the client nearest sites
+	longitude?: number;
 }
 
 export type GetConsumerHomePageResponse = HomePageResponse;
@@ -4847,6 +4866,28 @@ export interface GetConsumerLocationMultigroupQuery {
 
 export type GetConsumerLocationMultigroupResponse = GetConsumerLocationMultiGroupResponse;
 
+// GET /consumer/client-groups/{client} - Get a client's nearest sites with their business units and stations
+
+export interface GetConsumerClientGroupsPath {
+	// Client slug whose sites are returned
+	client: string;
+}
+
+export interface GetConsumerClientGroupsQuery {
+	// Multigroup (realm) id to search within, e.g. the app's Thrive/Boost multigroup
+	multigroup: string;
+	// Latitude used to sort sites by proximity
+	latitude?: number;
+	// Longitude used to sort sites by proximity
+	longitude?: number;
+	// Maximum number of nearest sites to return (default 10)
+	limit?: number;
+	// Optional maximum distance in km; sites farther than this are excluded. Requires numeric latitude and longitude — supplying it without them returns 400.
+	max_distance_km?: number;
+}
+
+export type GetConsumerClientGroupsResponse$0 = GetConsumerClientGroupsResponse;
+
 // GET /consumer/active-menus/{stationId} - Get current menu
 
 export interface GetConsumerActiveMenusPath {