@compassdigital/sdk.typescript 4.836.0 → 4.838.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.836.0",
+	"version": "4.838.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -394,18 +394,24 @@ import {
 	GetConfigStationPublicResponse,
 	PutConfigStationPublicBody,
 	PutConfigStationPublicResponse,
+	PatchConfigStationPublicBody,
+	PatchConfigStationPublicResponse,
 	GetConfigSitePrivateResponse,
 	PutConfigSitePrivateBody,
 	PutConfigSitePrivateResponse,
 	GetConfigSitePublicResponse,
 	PutConfigSitePublicBody,
 	PutConfigSitePublicResponse,
+	PatchConfigSitePublicBody,
+	PatchConfigSitePublicResponse,
 	GetConfigBusinessUnitPrivateResponse,
 	PutConfigBusinessUnitPrivateBody,
 	PutConfigBusinessUnitPrivateResponse,
 	GetConfigBusinessUnitPublicResponse,
 	PutConfigBusinessUnitPublicBody,
 	PutConfigBusinessUnitPublicResponse,
+	PatchConfigBusinessUnitPublicBody,
+	PatchConfigBusinessUnitPublicResponse,
 	GetConfigHealthResponse,
 	GetConfigPingResponse,
 } from './interface/config';
@@ -1009,8 +1015,6 @@ import {
 	DeleteMenuV4BrandCategoryResponse,
 	PostMenuV4BrandCategoryAttachItemsBody,
 	PostMenuV4BrandCategoryAttachItemsResponse,
-	PostMenuV4BrandSwapCategoryItemsBody,
-	PostMenuV4BrandSwapCategoryItemsResponse,
 	GetMenuV4BrandCatalogBackupVersionsResponse,
 	PostMenuV4BrandCatalogBackupRestoreBody,
 	PostMenuV4BrandCatalogBackupRestoreResponse,
@@ -1532,6 +1536,14 @@ import {
 	PostAuthAuthorizeLoginResponse,
 	PostAuthAuthorizeSsoBody,
 	PostAuthAuthorizeSsoResponse,
+	PostAuthAuthorizeDenyBody,
+	PostAuthAuthorizeDenyResponse,
+	GetWellKnownOauthAuthorizationServerResponse,
+	GetWellKnownOauthAuthorizationServerAuthResponse,
+	GetWellKnownOpenidConfigurationResponse,
+	GetWellKnownOpenidConfigurationAuthResponse,
+	GetWellKnownOauthProtectedResourceResponse,
+	GetWellKnownOauthProtectedResourceAgentThriveMcpResponse,
 } from './interface/auth';
 
 import {
@@ -5508,6 +5520,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /config/station/{key}/public - Partially update a station's public configuration
+	 *
+	 * @param key - station key (a location/brand id)
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_config_station_public(
+		key: string,
+		body: PatchConfigStationPublicBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchConfigStationPublicResponse> {
+		return this.request(
+			'config',
+			'/config/station/{key}/public',
+			'PATCH',
+			`/config/station/${key}/public`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /config/site/{key}/private - Get a site's private configuration
 	 *
@@ -5592,6 +5626,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /config/site/{key}/public - Partially update a site's public configuration
+	 *
+	 * @param key - site key (a location/group id)
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_config_site_public(
+		key: string,
+		body: PatchConfigSitePublicBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchConfigSitePublicResponse> {
+		return this.request(
+			'config',
+			'/config/site/{key}/public',
+			'PATCH',
+			`/config/site/${key}/public`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /config/business-unit/{key}/private - Get a business unit's private configuration
 	 *
@@ -5676,6 +5732,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /config/business-unit/{key}/public - Partially update a business unit's public configuration
+	 *
+	 * @param key - business unit key (a location/location id)
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_config_business_unit_public(
+		key: string,
+		body: PatchConfigBusinessUnitPublicBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchConfigBusinessUnitPublicResponse> {
+		return this.request(
+			'config',
+			'/config/business-unit/{key}/public',
+			'PATCH',
+			`/config/business-unit/${key}/public`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /config/health - Config Service readiness and dependency health check
 	 *
@@ -12059,28 +12137,6 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
-	/**
-	 * POST /menu/v4/brand/{id}/swap-category-items
-	 *
-	 * @param id
-	 * @param body
-	 * @param options - additional request options
-	 */
-	post_menu_v4_brand_swap_category_items(
-		id: string,
-		body: PostMenuV4BrandSwapCategoryItemsBody,
-		options?: RequestOptions,
-	): ResponsePromise<PostMenuV4BrandSwapCategoryItemsResponse> {
-		return this.request(
-			'menu',
-			'/menu/v4/brand/{id}/swap-category-items',
-			'POST',
-			`/menu/v4/brand/${id}/swap-category-items`,
-			body,
-			options,
-		);
-	}
-
 	/**
 	 * GET /menu/v4/brand/{id}/catalog-backup/versions
 	 *
@@ -17856,6 +17912,134 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /auth/authorize/deny - User declined the authorization request (RFC 6749 s4.1.2.1 access_denied).
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_auth_authorize_deny(
+		body: PostAuthAuthorizeDenyBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAuthAuthorizeDenyResponse> {
+		return this.request(
+			'auth',
+			'/auth/authorize/deny',
+			'POST',
+			`/auth/authorize/deny`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /.well-known/oauth-authorization-server - Authorization-server metadata at the root path (RFC 8414).
+	 *
+	 * @param options - additional request options
+	 */
+	get_well_known_oauth_authorization_server(
+		options?: RequestOptions,
+	): ResponsePromise<GetWellKnownOauthAuthorizationServerResponse> {
+		return this.request(
+			'auth',
+			'/.well-known/oauth-authorization-server',
+			'GET',
+			`/.well-known/oauth-authorization-server`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /.well-known/oauth-authorization-server/auth - Authorization-server metadata with the issuer path inserted (RFC 8414).
+	 *
+	 * @param options - additional request options
+	 */
+	get_well_known_oauth_authorization_server_auth(
+		options?: RequestOptions,
+	): ResponsePromise<GetWellKnownOauthAuthorizationServerAuthResponse> {
+		return this.request(
+			'auth',
+			'/.well-known/oauth-authorization-server/auth',
+			'GET',
+			`/.well-known/oauth-authorization-server/auth`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /.well-known/openid-configuration - OpenID Provider metadata at the root path (OIDC discovery).
+	 *
+	 * @param options - additional request options
+	 */
+	get_well_known_openid_configuration(
+		options?: RequestOptions,
+	): ResponsePromise<GetWellKnownOpenidConfigurationResponse> {
+		return this.request(
+			'auth',
+			'/.well-known/openid-configuration',
+			'GET',
+			`/.well-known/openid-configuration`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /.well-known/openid-configuration/auth - OpenID Provider metadata with the issuer path inserted (OIDC discovery).
+	 *
+	 * @param options - additional request options
+	 */
+	get_well_known_openid_configuration_auth(
+		options?: RequestOptions,
+	): ResponsePromise<GetWellKnownOpenidConfigurationAuthResponse> {
+		return this.request(
+			'auth',
+			'/.well-known/openid-configuration/auth',
+			'GET',
+			`/.well-known/openid-configuration/auth`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /.well-known/oauth-protected-resource - Protected-resource metadata when the URL names no resource (RFC 9728).
+	 *
+	 * @param options - additional request options
+	 */
+	get_well_known_oauth_protected_resource(
+		options?: RequestOptions,
+	): ResponsePromise<GetWellKnownOauthProtectedResourceResponse> {
+		return this.request(
+			'auth',
+			'/.well-known/oauth-protected-resource',
+			'GET',
+			`/.well-known/oauth-protected-resource`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /.well-known/oauth-protected-resource/agent/thrive/mcp - Protected-resource metadata for the thrive MCP endpoint (RFC 9728 §3.1).
+	 *
+	 * @param options - additional request options
+	 */
+	get_well_known_oauth_protected_resource_agent_thrive_mcp(
+		options?: RequestOptions,
+	): ResponsePromise<GetWellKnownOauthProtectedResourceAgentThriveMcpResponse> {
+		return this.request(
+			'auth',
+			'/.well-known/oauth-protected-resource/agent/thrive/mcp',
+			'GET',
+			`/.well-known/oauth-protected-resource/agent/thrive/mcp`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /review - Get reviews by taxonomy
 	 *

package/src/interface/auth.ts

@@ -62,6 +62,8 @@ export interface SSOConfigsResponseDTO {
 	tokenEndpoint: string;
 	userinfoEndpoint: string;
 	realm: string;
+	// The client these SSO users are affiliated with
+	clientAffiliation?: string;
 	mapping?: SSOMapping;
 }
 
@@ -73,6 +75,7 @@ export interface SSOConfigRequestDTO {
 	tokenEndpoint: string;
 	userinfoEndpoint: string;
 	realm: string;
+	clientAffiliation?: string;
 	protocol: 'OIDC' | 'SAML2';
 	mapping?: SSOMapping;
 }
@@ -88,6 +91,7 @@ export interface SSOConfigUpdateRequestDTO {
 	tokenEndpoint: string;
 	userinfoEndpoint: string;
 	realm: string;
+	clientAffiliation?: string;
 	protocol: 'OIDC' | 'SAML2';
 	mapping?: SSOMapping;
 }
@@ -316,6 +320,8 @@ export interface AuthorizeRequestResponseDTO {
 	client_name: string;
 	scopes: string[];
 	realm: string;
+	// Name of the MCP resource the client asked to access (RFC 8707).
+	resource_name?: string;
 }
 
 export interface AuthorizeLoginRequestDTO {
@@ -335,6 +341,18 @@ export interface AuthorizeSsoRequestDTO {
 	token: string;
 }
 
+export interface AuthorizeDenyRequestDTO {
+	request_id: string;
+}
+
+export interface ProtectedResourceMetadataResponseDTO {
+	resource: string;
+	authorization_servers: string[];
+	bearer_methods_supported: string[];
+	resource_name: string;
+	scopes_supported: string[];
+}
+
 // POST /auth/flow - Determines the authentication flow for a user based on their email address
 
 export type PostAuthFlowBody = SSOFlowRequestDTO;
@@ -560,3 +578,34 @@ export type PostAuthAuthorizeLoginResponse = AuthorizeRedirectResponseDTO;
 export type PostAuthAuthorizeSsoBody = AuthorizeSsoRequestDTO;
 
 export type PostAuthAuthorizeSsoResponse = AuthorizeRedirectResponseDTO;
+
+// POST /auth/authorize/deny - User declined the authorization request (RFC 6749 s4.1.2.1 access_denied).
+
+export type PostAuthAuthorizeDenyBody = AuthorizeDenyRequestDTO;
+
+export type PostAuthAuthorizeDenyResponse = AuthorizeRedirectResponseDTO;
+
+// GET /.well-known/oauth-authorization-server - Authorization-server metadata at the root path (RFC 8414).
+
+export type GetWellKnownOauthAuthorizationServerResponse = OpenIdConfigurationResponseDTO;
+
+// GET /.well-known/oauth-authorization-server/auth - Authorization-server metadata with the issuer path inserted (RFC 8414).
+
+export type GetWellKnownOauthAuthorizationServerAuthResponse = OpenIdConfigurationResponseDTO;
+
+// GET /.well-known/openid-configuration - OpenID Provider metadata at the root path (OIDC discovery).
+
+export type GetWellKnownOpenidConfigurationResponse = OpenIdConfigurationResponseDTO;
+
+// GET /.well-known/openid-configuration/auth - OpenID Provider metadata with the issuer path inserted (OIDC discovery).
+
+export type GetWellKnownOpenidConfigurationAuthResponse = OpenIdConfigurationResponseDTO;
+
+// GET /.well-known/oauth-protected-resource - Protected-resource metadata when the URL names no resource (RFC 9728).
+
+export type GetWellKnownOauthProtectedResourceResponse = ProtectedResourceMetadataResponseDTO;
+
+// GET /.well-known/oauth-protected-resource/agent/thrive/mcp - Protected-resource metadata for the thrive MCP endpoint (RFC 9728 §3.1).
+
+export type GetWellKnownOauthProtectedResourceAgentThriveMcpResponse =
+	ProtectedResourceMetadataResponseDTO;

package/src/interface/config.ts

@@ -839,6 +839,21 @@ export interface PutConfigStationPublicRequest extends BaseRequest, PutConfigSta
 	body: PutConfigStationPublicBody;
 }
 
+// PATCH /config/station/{key}/public - Partially update a station's public configuration
+
+export interface PatchConfigStationPublicPath {
+	// station key (a location/brand id)
+	key: string;
+}
+
+export type PatchConfigStationPublicBody = PublicStationConfig;
+
+export type PatchConfigStationPublicResponse = PublicStationConfig;
+
+export interface PatchConfigStationPublicRequest extends BaseRequest, PatchConfigStationPublicPath {
+	body: PatchConfigStationPublicBody;
+}
+
 // GET /config/site/{key}/private - Get a site's private configuration
 
 export interface GetConfigSitePrivatePath {
@@ -891,6 +906,21 @@ export interface PutConfigSitePublicRequest extends BaseRequest, PutConfigSitePu
 	body: PutConfigSitePublicBody;
 }
 
+// PATCH /config/site/{key}/public - Partially update a site's public configuration
+
+export interface PatchConfigSitePublicPath {
+	// site key (a location/group id)
+	key: string;
+}
+
+export type PatchConfigSitePublicBody = PublicSiteConfig;
+
+export type PatchConfigSitePublicResponse = PublicSiteConfig;
+
+export interface PatchConfigSitePublicRequest extends BaseRequest, PatchConfigSitePublicPath {
+	body: PatchConfigSitePublicBody;
+}
+
 // GET /config/business-unit/{key}/private - Get a business unit's private configuration
 
 export interface GetConfigBusinessUnitPrivatePath {
@@ -951,6 +981,23 @@ export interface PutConfigBusinessUnitPublicRequest
 	body: PutConfigBusinessUnitPublicBody;
 }
 
+// PATCH /config/business-unit/{key}/public - Partially update a business unit's public configuration
+
+export interface PatchConfigBusinessUnitPublicPath {
+	// business unit key (a location/location id)
+	key: string;
+}
+
+export type PatchConfigBusinessUnitPublicBody = PublicBusinessUnitConfig;
+
+export type PatchConfigBusinessUnitPublicResponse = PublicBusinessUnitConfig;
+
+export interface PatchConfigBusinessUnitPublicRequest
+	extends BaseRequest,
+		PatchConfigBusinessUnitPublicPath {
+	body: PatchConfigBusinessUnitPublicBody;
+}
+
 // GET /config/health - Config Service readiness and dependency health check
 
 export type GetConfigHealthResponse = HealthResponse;

package/src/interface/consumer.ts

@@ -4753,22 +4753,55 @@ export interface PostExternalExchangeLoginCodeResponseDTO {
 }
 
 export interface GetConsumerLocationResponse {
-	// id
-	id: string;
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// CDL id of the location
+	id?: string;
+	// ISO timestamp the location was deleted, if any
+	deleted_at?: string;
+	// operation id
+	operation_id?: number;
 	// name
-	name: string;
+	name?: string;
 	label?: {
 		en?: string;
 		fr?: string;
 	};
-	// distance in meters from the group
-	distance?: number;
+	// display order within its group
+	sequence?: number;
+	// search terms
+	search?: string[];
+	// app the location belongs to
+	app?: string;
+	// address
+	address?: ConsumerAddress;
+	// latitude
+	latitude?: number;
+	// longitude
+	longitude?: number;
+	// brands (stations) attached to the location
+	brands?: ConsumerBrand[];
 	// meta data
 	meta?: Record<string, any>;
+	// phone number
+	phone?: string;
+	// CDL id of the group of this location
+	location_group?: string;
+	// CDL id of the multigroup of this location
+	location_multigroup?: string;
+	// CDL id of the sector of this location
+	sector?: string;
+	date?: {
+		deleted?: string;
+		created?: string;
+		modified?: string;
+	};
+	// shared drop-off timeslot settings
+	timeslots?: Record<string, any>;
+	// marketplace configuration
+	market_place?: ConsumerLocationMarketPlace;
+	// site operational status
+	status?: 'active' | 'inactive';
+	// distance in meters from the caller
+	distance?: number;
 	style?: {
 		logo?: string | null;
 		main_logo?: string | null;
@@ -4776,10 +4809,6 @@ export interface GetConsumerLocationResponse {
 	};
 	// timezone
 	timezone?: string;
-	// site operational status
-	status?: Record<string, any>;
-	locations?: ConsumerLocation[];
-	address?: ConsumerAddress;
 }
 
 export interface GetDeliveryOrderResponseDto {

package/src/interface/menu.ts

@@ -2165,17 +2165,6 @@ export interface CategoryItemRelationshipDTO {
 	[index: string]: any;
 }
 
-export interface SwappedCategoryDTO {
-	category_id?: string;
-	sequence?: number;
-}
-
-export interface SwapOriginalStatesDTO {
-	swap_out_was_visible: boolean;
-	swap_in_was_visible: boolean;
-	[index: string]: any;
-}
-
 export interface CatalogBackupVersionDTO {
 	version_id?: string;
 	last_modified?: string;
@@ -9125,32 +9114,6 @@ export interface PostMenuV4BrandCategoryAttachItemsRequest
 	body: PostMenuV4BrandCategoryAttachItemsBody;
 }
 
-// POST /menu/v4/brand/{id}/swap-category-items
-
-export interface PostMenuV4BrandSwapCategoryItemsPath {
-	id: string;
-}
-
-export interface PostMenuV4BrandSwapCategoryItemsBody {
-	menu_id: string;
-	category_ids: string[];
-	swap_out_item_id: string;
-	swap_in_item_id: string;
-	[index: string]: any;
-}
-
-export interface PostMenuV4BrandSwapCategoryItemsResponse {
-	status?: string;
-	swapped_categories?: SwappedCategoryDTO[];
-	original_states?: SwapOriginalStatesDTO;
-}
-
-export interface PostMenuV4BrandSwapCategoryItemsRequest
-	extends BaseRequest,
-		PostMenuV4BrandSwapCategoryItemsPath {
-	body: PostMenuV4BrandSwapCategoryItemsBody;
-}
-
 // GET /menu/v4/brand/{id}/catalog-backup/versions
 
 export interface GetMenuV4BrandCatalogBackupVersionsPath {