@skedulo/pulse-solution-services 0.0.11 → 0.0.13

package/dist/index.d.ts

@@ -1,60 +1,122 @@
 // Generated by dts-bundle-generator v9.5.1
 
-/**
- * Interface representing the structure of metadata for an object.
- */
-export interface Metadata {
-	label: string;
-	labelPlural: string | null;
-	mapping: string;
-	name: string;
+export declare enum ArtifactType {
+	CUSTOM_OBJECT = "custom-object",
+	CUSTOM_FIELD = "custom-field",
+	FUNCTION = "function",
+	MOBILE_EXTENSION = "mobile-extension",
+	PUBLIC_PAGE = "public-page",
+	TRIGGERED_ACTION = "triggered-action",
+	USER_ROLE = "user-role",
+	WEBHOOK = "webhook",
+	HORIZON_CUSTOM_RESOURCE = "horizon-custom-resource",
+	HORIZON_PAGE = "horizon-page",
+	HORIZON_TEMPLATE = "horizon-template",
+	HORIZON_TENANT_CONFIG = "horizon-tenant-config",
+	HORIZON_COMPONENT_BUNDLE = "horizon-component-bundle",
+	HORIZON_VIEW_TYPE = "horizon-view-type",
+	HORIZON_CUSTOM_ACTION = "horizon-custom-action",
+	HORIZON_VIEW_STATE = "horizon-view-state",
+	HORIZON_DATA_FIELD_OVERLAY = "horizon-data-field-overlay",
+	HORIZON_DATA_RELATIONSHIP_OVERLAY = "horizon-data-relationship-overlay",
+	HORIZON_LIST_CONFIG = "horizon-list-config",
+	HORIZON_LIST_VIEW_STATE = "horizon-list-view-state"
 }
-/**
- * Interface representing the metadata for a specific object, extending the base Metadata interface.
- */
-export interface ObjectMetadata extends Metadata {
-	relationships: any[];
-	fields: any[];
+export declare enum ConfigVariableType {
+	PLAIN_TEXT = "plain-text",
+	SECRET = "secret"
 }
-/**
- * Interface representing the structure of a relationship.
- */
-export interface RelationshipMapping {
-	schemaMapping: string;
-	mapping: string;
-	fieldMapping: string;
+export declare enum ConfigVariableStatus {
+	ACTIVE = "active",
+	INACTIVE = "inactive",
+	EXPIRED = "expired"
 }
-/**
- * Interface representing the structure of a field.
- */
-export interface FieldMetadata {
-	label: string;
-	mapping: string;
-	type: string;
-	nillable: boolean;
-	length: number;
-	maxLength: number | null;
-	precision: number | null;
-	scale: number | null;
-	upsertKey: boolean;
-	unique: boolean;
-	readOnly: boolean;
-	accessMode: "read_only" | "read_write";
-	relationship: RelationshipMapping | null;
-	values: Array<PicklistValue>;
-	name: string;
+export declare enum GraphqlOperations {
+	INSERT = "insert",
+	UPDATE = "update",
+	DELETE = "delete",
+	UPSERT = "upsert"
 }
-export interface PicklistValue {
-	label: string;
-	value: string;
-	active: boolean;
-	defaultValue: boolean;
+export declare enum HttpMethod {
+	GET = "GET",
+	POST = "POST",
+	PUT = "PUT",
+	DELETE = "DELETE",
+	PATCH = "PATCH"
 }
-export interface BaseConfig {
-	apiServer: string;
-	apiToken: string;
-	internalApiToken?: string;
+export declare enum NotificationTemplate {
+	JOB_DISPATCH = "job_dispatch",
+	JOB_REMINDER = "job_reminder",
+	JOB_CANCELLED = "job_cancelled",
+	JOB_OFFER = "job_offer"
+}
+export declare enum NotificationType {
+	SMS = "sms",
+	PUSH = "push"
 }
+export declare const TENANT_ENDPOINTS: {
+	readonly CONFIG_VAR: {
+		readonly CREATE: "configuration/extension";
+		readonly GET: (key: string) => string;
+		readonly UPDATE: (key: string) => string;
+		readonly DELETE: (key: string) => string;
+		readonly SEARCH: "configuration/extension/search";
+	};
+	readonly GRAPHQL: {
+		readonly SINGLE: "graphql/graphql";
+		readonly BATCH: "graphql/graphql/batch";
+	};
+	readonly METADATA: {
+		readonly ALL: "custom/metadata";
+		readonly OBJECT: (objectMapping: string) => string;
+	};
+	readonly ORG_PREFERENCE: {
+		readonly GET: "config/org_preference";
+		readonly UPDATE: "config/org_preference";
+	};
+	readonly CONFIG_TEMPLATE: {
+		readonly GET_TEMPLATES: (objectName: string) => string;
+		readonly GET_VALUES: (templateId: string) => string;
+		readonly UPDATE_VALUES: (templateId: string) => string;
+		readonly CREATE: "config/template";
+		readonly DELETE: (templateId: string) => string;
+	};
+	readonly CONFIG_FEATURES: {
+		readonly GET: "config/features";
+		readonly UPDATE: (tenantId: string) => string;
+	};
+	readonly VOCABULARY: {
+		readonly GET_ITEMS: (schemaName: string, fieldName: string) => string;
+		readonly ADD_ITEM: (schemaName: string, fieldName: string) => string;
+		readonly UPDATE_ITEM: (schemaName: string, fieldName: string, value: string) => string;
+	};
+	readonly NOTIFICATIONS: {
+		readonly GET_TEMPLATES: "notifications/v2/templates";
+		readonly DELETE_TEMPLATE: (template: string, templateType: string) => string;
+		readonly SET_TEMPLATE: (type: string, protocol: string) => string;
+		readonly DISPATCH: "notifications/dispatch";
+		readonly NOTIFY: "notifications/notify";
+		readonly NOTIFY_CANCEL: "notifications/notify_cancel";
+		readonly ONE_OFF: "notifications/oneoff";
+		readonly SEND_SMS: "notifications/sms";
+		readonly SMS_CONFIRMATION_REQUEST: "notifications/sms/confirmation_request";
+	};
+	readonly GEOSERVICES: {
+		readonly DISTANCE_MATRIX: "geoservices/distanceMatrix";
+		readonly DIRECTIONS: "geoservices/directions";
+		readonly GEOCODE: "geoservices/geocode";
+		readonly AUTOCOMPLETE: "geoservices/autocomplete";
+		readonly PLACE: "geoservices/place";
+		readonly TIMEZONE: "geoservices/timezone";
+	};
+	readonly AVAILABILITY: {
+		readonly SIMPLE: "availability/simple";
+	};
+	readonly FILES: {
+		readonly AVATAR: "files/avatar";
+		readonly ATTACHMENTS: (parentId: string) => string;
+	};
+};
 /**
  * Represents execution options for GraphQL requests.
  * This class encapsulates metadata and execution settings
@@ -79,6 +141,11 @@ export declare class ExecutionOptions {
 	 */
 	constructor(initialValues?: Partial<ExecutionOptions>);
 }
+export interface BaseConfig {
+	apiServer: string;
+	apiToken: string;
+	internalApiToken?: string;
+}
 export interface RequestParams {
 	method?: string;
 	endpoint: string;
@@ -111,6 +178,7 @@ export declare class BaseClient {
 	 * @throws {Error} - If the request fails or the response is not OK.
 	 */
 	performRequest<T = any>({ method, endpoint, headers, body, queryParams }: RequestParams, executionOptions?: Partial<ExecutionOptions>): Promise<T>;
+	protected _performRequest<T = any>({ method, endpoint, headers, body, queryParams }: RequestParams, executionOptions?: Partial<ExecutionOptions>): Promise<T>;
 	protected handleResponseData(response: Response): void;
 	/**
 	 * Constructs the headers for API requests.
@@ -130,43 +198,95 @@ export declare class BaseClient {
 	 */
 	protected handleException(error: any): void;
 }
+export type ArtifactParams = {
+	objectName?: string;
+	viewTypeName?: string;
+	name?: string;
+	scope?: string;
+};
+export declare class ArtifactClient extends BaseClient {
+	private artifactType;
+	private baseEndpoint;
+	constructor(config: any, artifactType: ArtifactType, executionOptions?: Partial<ExecutionOptions>);
+	list<T>(): Promise<T[]>;
+	get<T>(params?: ArtifactParams): Promise<T>;
+	create<T>(params: ArtifactParams, artifactData: Partial<T>): Promise<T>;
+	update<T>(params: ArtifactParams, artifactData: Partial<T>): Promise<T>;
+	delete(params: ArtifactParams): Promise<void>;
+	private buildEndpoint;
+}
+export interface AvailabilityRequestParams {
+	/**
+	 * Array of resource IDs for which availability is requested.
+	 * Must contain at least one and at most 200 resource IDs.
+	 */
+	resourceIds: string[];
+	/**
+	 * The UTC datetime from which to start fetching availability (ISO 8601 format).
+	 */
+	start: string;
+	/**
+	 * The UTC datetime until which to fetch availability (ISO 8601 format).
+	 * Must be after start and within 375 days.
+	 */
+	end: string;
+	/**
+	 * If true, merged availability time intervals are returned in the response.
+	 * Defaults to false.
+	 */
+	mergedAvailabilities?: boolean;
+	/**
+	 * If true (or omitted), a list of availability entries is returned.
+	 * Defaults to true.
+	 */
+	entries?: boolean;
+}
+export interface AvailabilityResult {
+	resourceId: string;
+	mergedAvailabilities?: {
+		start: string;
+		end: string;
+	}[];
+	entries?: AvailabilityEntry[];
+}
+export interface AvailabilityEntry {
+	type: "template" | "pattern" | "override" | "holiday";
+	start: string;
+	end: string;
+	available: boolean;
+	templateEntryId?: string;
+	name?: string;
+	patternId?: string;
+	patternRecordId?: string;
+}
 /**
- * MetadataClient class to handle API requests related to metadata.
+ * AvailabilityClient class to handle API requests related to availability.
  * Extends BaseClient to perform API operations.
  */
-export declare class MetadataClient extends BaseClient {
-	/**
-	 * Fetches all metadata mappings from the metadata endpoint.
-	 * @returns {Promise<Metadata[]>} - A promise resolving to an object containing an array of Metadata.
-	 */
-	fetchAllMetadata(): Promise<Metadata[]>;
+export declare class AvailabilityAPIClient extends BaseClient {
 	/**
-	 * Fetches metadata for a specific object using its mapping.
-	 * @param {string} mapping - The API mapping for the object.
-	 * @returns {Promise<ObjectMetadata>} - A promise resolving to an object containing the metadata of the requested object.
+	 * Fetches resource availability based on the given request parameters.
+	 * @param {AvailabilityRequestParams} params - The request parameters for availability.
+	 * @returns {Promise<AvailabilityResult[]>} - The availability data for the requested resources.
 	 */
-	fetchObjectMetadata(mapping: string): Promise<ObjectMetadata>;
+	fetchAvailability(params: AvailabilityRequestParams): Promise<AvailabilityResult[]>;
 }
 /**
- * MetadataService class to process and filter metadata.
+ * ConfigFeatureClient class to handle API requests related to feature flags.
+ * Extends BaseClient to perform API operations.
  */
-export declare class MetadataService {
-	private client;
-	constructor(client: MetadataClient);
+export declare class ConfigFeaturesClient extends BaseClient {
 	/**
-	 * Retrieves metadata for specific objects.
-	 *
-	 * @param objectNames - The names of the objects.
-	 * @returns A promise that resolves to metadata records.
+	 * Fetches feature flags configuration.
+	 * @returns {Promise<Record<string, any>>} - A promise resolving to the sorted feature flags in JSON string format.
 	 */
-	getObjectMetadata(objectNames: string[]): Promise<Record<string, ObjectMetadata>>;
+	get(): Promise<Record<string, any>>;
 	/**
-	 * Extracts picklist values from the object metadata.
-	 *
-	 * @param metadata - The metadata of the object.
-	 * @returns An object containing the picklist values for each picklist field.
+	 * Deploys feature flags configuration.
+	 * @param {string} newConfig - The new configuration to be deployed.
+	 * @returns {Promise<Record<string, any>>} - A promise resolving when the configuration is successfully deployed.
 	 */
-	getPicklistValues(metadata: ObjectMetadata): Record<string, string[]>;
+	update(tenantId: string, newConfig: Record<string, any>): Promise<Record<string, any>>;
 }
 export interface ConfigTemplate {
 	id?: string;
@@ -193,264 +313,117 @@ export declare class ConfigTemplateClient extends BaseClient {
 	get(objectName: string): Promise<ConfigTemplate[]>;
 	/**
 	 * Fetches configuration template values by template ID.
-	 * @param {string} templateId - The template ID.
-	 * @returns {Promise<any[]>} - A promise resolving to an array of configuration values.
-	 */
-	getTemmplateValues(templateId: string): Promise<any[]>;
-	/**
-	 * Updates or Inserts configuration template values.
-	 * @param {string} templateId - The template ID.
-	 * @param {ConfigTemplateValue[]} values - The values to update.
-	 * @returns {Promise<any>} - A promise resolving when the update is complete.
-	 */
-	upsertTemplateValues(templateId: string, values: ConfigTemplateValue[]): Promise<any>;
-	/**
-	 * Deletes a configuration template.
-	 * @param {string} templateId - The template ID.
-	 * @returns {Promise<any>} - A promise resolving when the deletion is complete.
-	 */
-	delete(templateId: string): Promise<any>;
-	/**
-	 * Deploys a configuration template.
-	 * @param {ConfigTemplate} template - The template to deploy.
-	 * @returns {Promise<any>} - A promise resolving when the deployment is complete.
-	 */
-	create(template: ConfigTemplate): Promise<any>;
-}
-export interface ConfigVar {
-	key?: string;
-	configType: string;
-	value: string;
-	description?: string;
-	status?: "active" | "inactive" | "expired";
-	expiryDate?: string;
-	updatedBy?: string;
-	createdBy?: string;
-	createdAt?: string;
-	updatedAt?: string;
-}
-/**
- * Client for managing configuration variables through API requests.
- * Provides methods to create, retrieve, update, search, and delete configuration variables.
- */
-export declare class ConfigVarClient extends BaseClient {
-	/**
-	 * Creates a new configuration variable.
-	 */
-	create(configVar: ConfigVar): Promise<ConfigVar>;
-	/**
-	 * Retrieves a configuration variable by key.
-	 */
-	get(key: string): Promise<ConfigVar>;
-	/**
-	 * Updates an existing configuration variable.
-	 */
-	update(configVar: ConfigVar): Promise<ConfigVar>;
-	/**
-	 * Upsert a configuration variable. If the configuration variable does not exist, it will be created.
-	 */
-	upsert(configVar: ConfigVar): Promise<ConfigVar>;
-	/**
-	 * Searches for configuration variables with pagination.
-	 */
-	search(pageSize?: number): Promise<ConfigVar[]>;
-	/**
-	 * Deletes a configuration variable by key.
-	 */
-	delete(key: string): Promise<string>;
-}
-export declare enum ArtifactType {
-	CUSTOM_OBJECT = "custom-object",
-	CUSTOM_FIELD = "custom-field",
-	FUNCTION = "function",
-	MOBILE_EXTENSION = "mobile-extension",
-	PUBLIC_PAGE = "public-page",
-	TRIGGERED_ACTION = "triggered-action",
-	USER_ROLE = "user-role",
-	WEBHOOK = "webhook",
-	HORIZON_CUSTOM_RESOURCE = "horizon-custom-resource",
-	HORIZON_PAGE = "horizon-page",
-	HORIZON_TEMPLATE = "horizon-template",
-	HORIZON_TENANT_CONFIG = "horizon-tenant-config",
-	HORIZON_COMPONENT_BUNDLE = "horizon-component-bundle",
-	HORIZON_VIEW_TYPE = "horizon-view-type",
-	HORIZON_CUSTOM_ACTION = "horizon-custom-action",
-	HORIZON_VIEW_STATE = "horizon-view-state",
-	HORIZON_DATA_FIELD_OVERLAY = "horizon-data-field-overlay",
-	HORIZON_DATA_RELATIONSHIP_OVERLAY = "horizon-data-relationship-overlay",
-	HORIZON_LIST_CONFIG = "horizon-list-config",
-	HORIZON_LIST_VIEW_STATE = "horizon-list-view-state"
-}
-export declare enum ConfigVariableType {
-	PLAIN_TEXT = "plain-text",
-	SECRET = "secret"
-}
-export declare enum ConfigVariableStatus {
-	ACTIVE = "active",
-	INACTIVE = "inactive",
-	EXPIRED = "expired"
-}
-export declare enum GraphqlOperations {
-	INSERT = "insert",
-	UPDATE = "update",
-	DELETE = "delete",
-	UPSERT = "upsert"
-}
-export declare enum HttpMethod {
-	GET = "GET",
-	POST = "POST",
-	PUT = "PUT",
-	DELETE = "DELETE",
-	PATCH = "PATCH"
-}
-export declare enum NotificationTemplate {
-	JOB_DISPATCH = "job_dispatch",
-	JOB_REMINDER = "job_reminder",
-	JOB_CANCELLED = "job_cancelled",
-	JOB_OFFER = "job_offer"
-}
-export declare enum NotificationType {
-	SMS = "sms",
-	PUSH = "push"
-}
-export declare const TENANT_ENDPOINTS: {
-	readonly CONFIG_VAR: {
-		readonly CREATE: "configuration/extension";
-		readonly GET: (key: string) => string;
-		readonly UPDATE: (key: string) => string;
-		readonly DELETE: (key: string) => string;
-		readonly SEARCH: "configuration/extension/search";
-	};
-	readonly GRAPHQL: {
-		readonly SINGLE: "graphql/graphql";
-		readonly BATCH: "graphql/graphql/batch";
-	};
-	readonly METADATA: {
-		readonly ALL: "custom/metadata";
-		readonly OBJECT: (objectMapping: string) => string;
-	};
-	readonly ORG_PREFERENCE: {
-		readonly GET: "config/org_preference";
-		readonly UPDATE: "config/org_preference";
-	};
-	readonly CONFIG_TEMPLATE: {
-		readonly GET_TEMPLATES: (objectName: string) => string;
-		readonly GET_VALUES: (templateId: string) => string;
-		readonly UPDATE_VALUES: (templateId: string) => string;
-		readonly CREATE: "config/template";
-		readonly DELETE: (templateId: string) => string;
-	};
-	readonly CONFIG_FEATURES: {
-		readonly GET: "config/features";
-		readonly UPDATE: (tenantId: string) => string;
-	};
-	readonly VOCABULARY: {
-		readonly GET_ITEMS: (schemaName: string, fieldName: string) => string;
-		readonly ADD_ITEM: (schemaName: string, fieldName: string) => string;
-		readonly UPDATE_ITEM: (schemaName: string, fieldName: string, value: string) => string;
-	};
-	readonly NOTIFICATIONS: {
-		readonly GET_TEMPLATES: "notifications/v2/templates";
-		readonly DELETE_TEMPLATE: (template: string, templateType: string) => string;
-		readonly SET_TEMPLATE: (type: string, protocol: string) => string;
-		readonly DISPATCH: "notifications/dispatch";
-		readonly NOTIFY: "notifications/notify";
-		readonly NOTIFY_CANCEL: "notifications/notify_cancel";
-		readonly ONE_OFF: "notifications/oneoff";
-		readonly SEND_SMS: "notifications/sms";
-		readonly SMS_CONFIRMATION_REQUEST: "notifications/sms/confirmation_request";
-	};
-	readonly GEOSERVICES: {
-		readonly DISTANCE_MATRIX: "geoservices/distanceMatrix";
-		readonly DIRECTIONS: "geoservices/directions";
-		readonly GEOCODE: "geoservices/geocode";
-		readonly AUTOCOMPLETE: "geoservices/autocomplete";
-		readonly PLACE: "geoservices/place";
-		readonly TIMEZONE: "geoservices/timezone";
-	};
-	readonly AVAILABILITY: {
-		readonly SIMPLE: "availability/simple";
-	};
-};
-export interface HasId {
-	UID?: string;
-	[key: string]: any;
-}
-export interface GraphQlResponse<T = any> {
-	data: T;
-	errors?: object[];
-}
-export interface GraphqlParams {
-	objectName: string;
-	operationName: string;
-}
-export interface GraphqlMurationParams extends GraphqlParams {
-	records: HasId[];
-	operation: GraphqlOperations;
-	bulkOperation?: boolean;
-}
-export interface GraphqlQueryParams extends GraphqlParams {
-	first?: number;
-	offset?: number;
-	orderBy?: string;
-	filter?: string;
-	after?: string;
-	fields?: string;
-	readOnly?: boolean;
-}
-export interface QueryResult {
-	records: HasId[];
-	totalCount: number;
-	pageInfo: any;
-	endCursor: string;
-	endOffset: number;
+	 * @param {string} templateId - The template ID.
+	 * @returns {Promise<any[]>} - A promise resolving to an array of configuration values.
+	 */
+	getTemmplateValues(templateId: string): Promise<any[]>;
+	/**
+	 * Updates or Inserts configuration template values.
+	 * @param {string} templateId - The template ID.
+	 * @param {ConfigTemplateValue[]} values - The values to update.
+	 * @returns {Promise<any>} - A promise resolving when the update is complete.
+	 */
+	upsertTemplateValues(templateId: string, values: ConfigTemplateValue[]): Promise<any>;
+	/**
+	 * Deletes a configuration template.
+	 * @param {string} templateId - The template ID.
+	 * @returns {Promise<any>} - A promise resolving when the deletion is complete.
+	 */
+	delete(templateId: string): Promise<any>;
+	/**
+	 * Deploys a configuration template.
+	 * @param {ConfigTemplate} template - The template to deploy.
+	 * @returns {Promise<any>} - A promise resolving when the deployment is complete.
+	 */
+	create(template: ConfigTemplate): Promise<any>;
 }
-export interface MutationResult {
-	data: {
-		schema: {
-			[alias: string]: string;
-		};
-	};
+export interface ConfigVar {
+	key?: string;
+	configType: string;
+	value: string;
+	description?: string;
+	status?: "active" | "inactive" | "expired";
+	expiryDate?: string;
+	updatedBy?: string;
+	createdBy?: string;
+	createdAt?: string;
+	updatedAt?: string;
 }
 /**
- * A client for executing GraphQL queries and mutations.
- * Extends the BaseClient to interact with the GraphQL API.
+ * Client for managing configuration variables through API requests.
+ * Provides methods to create, retrieve, update, search, and delete configuration variables.
  */
-export declare class GraphQLClient extends BaseClient {
+export declare class ConfigVarClient extends BaseClient {
 	/**
-	 * Executes a GraphQL query or mutation.
-	 * @param {string} graphqlQuery - The GraphQL query or mutation string.
-	 * @param {Record<string, string>} headers - Additional headers to include in the request.
-	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
-	 * @throws {Error} - If the request fails or if there are errors in the response.
+	 * Creates a new configuration variable.
 	 */
-	execute(graphqlQuery: string, headers?: Record<string, string>): Promise<GraphQlResponse>;
+	create(configVar: ConfigVar): Promise<ConfigVar>;
 	/**
-	 * Executes a GraphQL query or mutation.
-	 * @param {string} graphqlQuery - The GraphQL queries and/or mutations.
-	 * @param {Record<string, string>} headers - Additional headers to include in the request.
-	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
-	 * @throws {Error} - If the request fails or if there are errors in the response.
+	 * Retrieves a configuration variable by key.
 	 */
-	executeBatch(graphqlQuery: string, headers?: Record<string, string>): Promise<GraphQlResponse>;
-	protected handleResponseData(responseData: any): void;
+	get(key: string): Promise<ConfigVar>;
+	/**
+	 * Updates an existing configuration variable.
+	 */
+	update(configVar: ConfigVar): Promise<ConfigVar>;
+	/**
+	 * Upsert a configuration variable. If the configuration variable does not exist, it will be created.
+	 */
+	upsert(configVar: ConfigVar): Promise<ConfigVar>;
+	/**
+	 * Searches for configuration variables with pagination.
+	 */
+	search(pageSize?: number): Promise<ConfigVar[]>;
+	/**
+	 * Deletes a configuration variable by key.
+	 */
+	delete(key: string): Promise<string>;
 }
 /**
- * OrgPreferencesClient class to handle API requests related to organization preferences.
- * Extends BaseClient to perform API operations.
+ * Request parameters for fetching avatars.
+ * - `userIds`: comma-separated user IDs
+ * - `sizeHint`: optional size hint (e.g., "small", "thumbnail")
  */
-export declare class OrgPreferenceClient extends BaseClient {
+export interface GetAvatarParams {
+	userIds: string[];
+	sizeHint?: string;
+}
+/**
+ * Response shape for fetching avatars.
+ * The API returns a map from userId -> avatar URL.
+ */
+export type GetAvatarResponse = Record<string, string>;
+/**
+ * Represents a single attachment record.
+ */
+export interface Attachment {
+	id: string;
+	contentType: string;
+	fileName: string;
+	uploadedDate: string;
+	parentId: string;
+	createdBy: string;
+	size: number;
+	description: string;
+	downloadUrl: string;
+}
+/**
+ * Response shape for fetching attachments.
+ */
+export interface GetAttachmentsResponse {
+	list: Attachment[];
+}
+export declare class FilesAPIClient extends BaseClient {
 	/**
-	 * Fetches the organization preferences configuration.
-	 * @returns {Promise<Record<string, any>>} - A promise resolving to the sorted organization preferences.
+	 * Fetch a map of userId -> avatar URL.
+	 * Example request: GET /avatar?user_ids=abc,def&size_hint=thumbnail
 	 */
-	get(): Promise<Record<string, any>>;
+	getAvatar(params: GetAvatarParams): Promise<GetAvatarResponse>;
 	/**
-	 * Deploys the organization preferences configuration.
-	 * @param {Record<string, any>} newConfig - The new configuration to be deployed.
-	 * @returns {Promise<Record<string, any>>} - A promise resolving when the configuration is successfully deployed.
+	 * Find attachments that belong to the specified parent record.
+	 * Example request: GET /attachments/{parentId}
 	 */
-	deploy(newConfig: Record<string, any>): Promise<Record<string, any>>;
+	getAttachments(parentId: string): Promise<GetAttachmentsResponse>;
 }
 export interface LatLng {
 	lat: number;
@@ -545,168 +518,18 @@ export interface PlaceResponse {
 	geometry: LatLng;
 }
 export interface TimezoneRequest {
-	location: [
-		number,
-		number
-	];
-	timestamp: number;
-}
-export interface TimezoneResponse {
-	dstOffset: number;
-	rawOffset: number;
-	timeZoneId: string;
-}
-export interface BaseObject {
-	id: string;
-	name: string;
-	propertyMap?: Record<string, any>;
-}
-export interface BaseEvent extends BaseObject {
-	start: Date;
-	finish: Date;
-	eventType?: string;
-	description?: string;
-	geoLocation?: LatLng;
-}
-export interface Resource extends BaseObject {
-	category?: string;
-	employmentType?: string;
-	resourceType?: string;
-	userId?: string;
-	regionId?: string;
-	timezone: string;
-	tags: Tag[];
-	availabilities: BaseEvent[];
-	events: BaseEvent[];
-}
-export interface Tag extends BaseObject {
-}
-export interface Availability extends BaseEvent {
-	resourceId: string;
-	isAvailable: boolean;
-	status: string;
-	availabilityType: string;
-}
-export interface Activity extends BaseEvent {
-	resourceId: string;
-	activityType: string;
-}
-export interface JobAllocation extends BaseEvent {
-	jobId: string;
-	resourceId: string;
-	status: string;
-}
-export interface Job extends BaseEvent {
-	address: string;
-	contactId: string;
-	jobStatus: string;
-	regionId: string;
-	tags: Tag[];
-}
-export interface ResourceShift extends BaseEvent {
-	resourceId: string;
-	shift: Shift;
-}
-export interface Shift extends BaseEvent {
-	regionId: string;
-	displayName: string;
-	isDraft: boolean;
-}
-export declare class EntityFactory {
-	static createBaseObject(data: Record<string, string>): BaseObject;
-	static createBaseEvent(data: Record<string, string>): BaseEvent;
-	static createTag(data: Record<string, any>): Tag;
-	static createResource(data: Record<string, any>): Resource;
-	static createJob(data: Record<string, any>): Job;
-	static createAvailability(data: Record<string, any>): Availability;
-	static createActivity(data: Record<string, any>): Activity;
-	static createJobAllocation(data: Record<string, any>): JobAllocation;
-	static createResourceShift(data: Record<string, any>): ResourceShift;
-	static createShift(data: Record<string, any>): Shift;
-}
-export type ArtifactParams = {
-	objectName?: string;
-	viewTypeName?: string;
-	name?: string;
-	scope?: string;
-};
-declare class ArtifactClient extends BaseClient {
-	private artifactType;
-	private baseEndpoint;
-	constructor(config: any, artifactType: ArtifactType, executionOptions?: Partial<ExecutionOptions>);
-	list<T>(): Promise<T[]>;
-	get<T>(params?: ArtifactParams): Promise<T>;
-	create<T>(params: ArtifactParams, artifactData: Partial<T>): Promise<T>;
-	update<T>(params: ArtifactParams, artifactData: Partial<T>): Promise<T>;
-	delete(params: ArtifactParams): Promise<void>;
-	private buildEndpoint;
-}
-export interface AvailabilityRequestParams {
-	/**
-	 * Array of resource IDs for which availability is requested.
-	 * Must contain at least one and at most 200 resource IDs.
-	 */
-	resourceIds: string[];
-	/**
-	 * The UTC datetime from which to start fetching availability (ISO 8601 format).
-	 */
-	start: string;
-	/**
-	 * The UTC datetime until which to fetch availability (ISO 8601 format).
-	 * Must be after start and within 375 days.
-	 */
-	end: string;
-	/**
-	 * If true, merged availability time intervals are returned in the response.
-	 * Defaults to false.
-	 */
-	mergedAvailabilities?: boolean;
-	/**
-	 * If true (or omitted), a list of availability entries is returned.
-	 * Defaults to true.
-	 */
-	entries?: boolean;
-}
-export interface AvailabilityResult {
-	resourceId: string;
-	mergedAvailabilities?: {
-		start: string;
-		end: string;
-	}[];
-	entries?: AvailabilityEntry[];
-}
-export interface AvailabilityEntry {
-	type: "template" | "pattern" | "override" | "holiday";
-	start: string;
-	end: string;
-	available: boolean;
-	templateEntryId?: string;
-	name?: string;
-	patternId?: string;
-	patternRecordId?: string;
-}
-declare class AvailabilityAPIClient extends BaseClient {
-	/**
-	 * Fetches resource availability based on the given request parameters.
-	 * @param {AvailabilityRequestParams} params - The request parameters for availability.
-	 * @returns {Promise<AvailabilityResult[]>} - The availability data for the requested resources.
-	 */
-	fetchAvailability(params: AvailabilityRequestParams): Promise<AvailabilityResult[]>;
-}
-declare class ConfigFeaturesClient extends BaseClient {
-	/**
-	 * Fetches feature flags configuration.
-	 * @returns {Promise<Record<string, any>>} - A promise resolving to the sorted feature flags in JSON string format.
-	 */
-	get(): Promise<Record<string, any>>;
-	/**
-	 * Deploys feature flags configuration.
-	 * @param {string} newConfig - The new configuration to be deployed.
-	 * @returns {Promise<Record<string, any>>} - A promise resolving when the configuration is successfully deployed.
-	 */
-	update(tenantId: string, newConfig: Record<string, any>): Promise<Record<string, any>>;
+	location: [
+		number,
+		number
+	];
+	timestamp: number;
+}
+export interface TimezoneResponse {
+	dstOffset: number;
+	rawOffset: number;
+	timeZoneId: string;
 }
-declare class GeoAPIClient extends BaseClient {
+export declare class GeoAPIClient extends BaseClient {
 	/**
 	 * Computes travel distance and time for all combinations of origin and destination locations.
 	 */
@@ -732,6 +555,136 @@ declare class GeoAPIClient extends BaseClient {
 	 */
 	getTimezone(data: TimezoneRequest): Promise<TimezoneResponse>;
 }
+export interface HasId {
+	UID?: string;
+	[key: string]: any;
+}
+export interface GraphQlResponse<T = any> {
+	data: T;
+	errors?: object[];
+}
+export interface GraphqlParams {
+	objectName: string;
+	operationName: string;
+}
+export interface GraphqlMurationParams extends GraphqlParams {
+	records: HasId[];
+	operation: GraphqlOperations;
+	bulkOperation?: boolean;
+}
+export interface GraphqlQueryParams extends GraphqlParams {
+	first?: number;
+	offset?: number;
+	orderBy?: string;
+	filter?: string;
+	after?: string;
+	fields?: string;
+	readOnly?: boolean;
+}
+export interface QueryResult {
+	records: HasId[];
+	totalCount: number;
+	pageInfo: any;
+	endCursor: string;
+	endOffset: number;
+}
+export interface MutationResult {
+	data: {
+		schema: {
+			[alias: string]: string;
+		};
+	};
+}
+/**
+ * A client for executing GraphQL queries and mutations.
+ * Extends the BaseClient to interact with the GraphQL API.
+ */
+export declare class GraphQLClient extends BaseClient {
+	/**
+	 * Executes a GraphQL query or mutation.
+	 * @param {string} graphqlQuery - The GraphQL query or mutation string.
+	 * @param {Record<string, string>} headers - Additional headers to include in the request.
+	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
+	 * @throws {Error} - If the request fails or if there are errors in the response.
+	 */
+	execute(graphqlQuery: string, headers?: Record<string, string>): Promise<GraphQlResponse>;
+	/**
+	 * Executes a GraphQL query or mutation.
+	 * @param {string} graphqlQuery - The GraphQL queries and/or mutations.
+	 * @param {Record<string, string>} headers - Additional headers to include in the request.
+	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
+	 * @throws {Error} - If the request fails or if there are errors in the response.
+	 */
+	executeBatch(graphqlQuery: string, headers?: Record<string, string>): Promise<GraphQlResponse>;
+	protected handleResponseData(responseData: any): void;
+}
+/**
+ * Interface representing the structure of metadata for an object.
+ */
+export interface Metadata {
+	label: string;
+	labelPlural: string | null;
+	mapping: string;
+	name: string;
+}
+/**
+ * Interface representing the metadata for a specific object, extending the base Metadata interface.
+ */
+export interface ObjectMetadata extends Metadata {
+	relationships: any[];
+	fields: any[];
+}
+/**
+ * Interface representing the structure of a relationship.
+ */
+export interface RelationshipMapping {
+	schemaMapping: string;
+	mapping: string;
+	fieldMapping: string;
+}
+/**
+ * Interface representing the structure of a field.
+ */
+export interface FieldMetadata {
+	label: string;
+	mapping: string;
+	type: string;
+	nillable: boolean;
+	length: number;
+	maxLength: number | null;
+	precision: number | null;
+	scale: number | null;
+	upsertKey: boolean;
+	unique: boolean;
+	readOnly: boolean;
+	accessMode: "read_only" | "read_write";
+	relationship: RelationshipMapping | null;
+	values: Array<PicklistValue>;
+	name: string;
+}
+export interface PicklistValue {
+	label: string;
+	value: string;
+	active: boolean;
+	defaultValue: boolean;
+}
+/**
+ * MetadataClient class to handle API requests related to metadata.
+ * Extends BaseClient to perform API operations.
+ */
+export declare class MetadataClient extends BaseClient {
+	/**
+	 * Fetches all metadata mappings from the metadata endpoint.
+	 * @returns {Promise<Metadata[]>} - A promise resolving to an object containing an array of Metadata.
+	 */
+	fetchAllMetadata(): Promise<Metadata[]>;
+	/**
+	 * Fetches metadata for a specific object using its mapping.
+	 * @param {string} mapping - The API mapping for the object.
+	 * @returns {Promise<ObjectMetadata>} - A promise resolving to an object containing the metadata of the requested object.
+	 */
+	fetchObjectMetadata(mapping: string): Promise<ObjectMetadata>;
+}
 export interface JobRequest {
 	jobId: string;
 }
@@ -776,7 +729,11 @@ export interface SmsConfirmationRequest extends JobRequest {
 export interface SmsResponse {
 	success: boolean;
 }
-declare class MobileNotificationClient extends BaseClient {
+/**
+ * Client for handling mobile notifications API operations.
+ * Extends BaseClient to provide request methods.
+ */
+export declare class MobileNotificationClient extends BaseClient {
 	/**
 	 * Fetches all mobile notification templates from the API.
 	 * @returns {Promise<any>} - An array of mobile notification templates.
@@ -832,6 +789,23 @@ declare class MobileNotificationClient extends BaseClient {
 	 */
 	requestSmsConfirmation(request: SmsConfirmationRequest): Promise<SmsResponse>;
 }
+/**
+ * OrgPreferencesClient class to handle API requests related to organization preferences.
+ * Extends BaseClient to perform API operations.
+ */
+export declare class OrgPreferenceClient extends BaseClient {
+	/**
+	 * Fetches the organization preferences configuration.
+	 * @returns {Promise<Record<string, any>>} - A promise resolving to the sorted organization preferences.
+	 */
+	get(): Promise<Record<string, any>>;
+	/**
+	 * Deploys the organization preferences configuration.
+	 * @param {Record<string, any>} newConfig - The new configuration to be deployed.
+	 * @returns {Promise<Record<string, any>>} - A promise resolving when the configuration is successfully deployed.
+	 */
+	deploy(newConfig: Record<string, any>): Promise<Record<string, any>>;
+}
 export interface VocabularyItem {
 	value: string;
 	label: string;
@@ -841,7 +815,11 @@ export interface VocabularyItem {
 	createdAt?: string;
 	updatedAt?: string;
 }
-declare class VocabularyClient extends BaseClient {
+/**
+ * VocabularyClient handles API requests related to vocabulary fields.
+ * Extends BaseClient to perform API operations.
+ */
+export declare class VocabularyClient extends BaseClient {
 	/**
 	 * Fetches vocabulary items for a specific field in a schema.
 	 * @param {string} schemaName - The schema name.
@@ -867,6 +845,74 @@ declare class VocabularyClient extends BaseClient {
 	 */
 	updateVocabularyItem(schemaName: string, fieldName: string, value: string, item: VocabularyItem): Promise<VocabularyItem>;
 }
+export interface BaseObject {
+	id: string;
+	name: string;
+	propertyMap?: Record<string, any>;
+}
+export interface BaseEvent extends BaseObject {
+	start: Date;
+	finish: Date;
+	eventType?: string;
+	description?: string;
+	geoLocation?: LatLng;
+}
+export interface Resource extends BaseObject {
+	category?: string;
+	employmentType?: string;
+	resourceType?: string;
+	userId?: string;
+	regionId?: string;
+	timezone: string;
+	tags: Tag[];
+	availabilities: BaseEvent[];
+	events: BaseEvent[];
+}
+export interface Tag extends BaseObject {
+}
+export interface Availability extends BaseEvent {
+	resourceId: string;
+	isAvailable: boolean;
+	status: string;
+	availabilityType: string;
+}
+export interface Activity extends BaseEvent {
+	resourceId: string;
+	activityType: string;
+}
+export interface JobAllocation extends BaseEvent {
+	jobId: string;
+	resourceId: string;
+	status: string;
+}
+export interface Job extends BaseEvent {
+	address: string;
+	contactId: string;
+	jobStatus: string;
+	regionId: string;
+	tags: Tag[];
+}
+export interface ResourceShift extends BaseEvent {
+	resourceId: string;
+	shift: Shift;
+}
+export interface Shift extends BaseEvent {
+	regionId: string;
+	displayName: string;
+	isDraft: boolean;
+}
+export declare class EntityFactory {
+	static createBaseObject(data: Record<string, string>): BaseObject;
+	static createBaseEvent(data: Record<string, string>): BaseEvent;
+	static createTag(data: Record<string, any>): Tag;
+	static createResource(data: Record<string, any>): Resource;
+	static createJob(data: Record<string, any>): Job;
+	static createAvailability(data: Record<string, any>): Availability;
+	static createActivity(data: Record<string, any>): Activity;
+	static createJobAllocation(data: Record<string, any>): JobAllocation;
+	static createResourceShift(data: Record<string, any>): ResourceShift;
+	static createShift(data: Record<string, any>): Shift;
+}
 export interface LockInfo {
 	name: string;
 	ttl: number;
@@ -950,7 +996,7 @@ export interface CacheOptions<T> {
 	ttl?: number;
 	useSecondaryCache?: boolean;
 }
-declare class GeoService {
+export declare class GeoService {
 	private geoAPIClient;
 	private sessionId;
 	constructor(geoAPIClient: GeoAPIClient);
@@ -1114,12 +1160,33 @@ export declare class GraphQLQueryBuilder {
 	 */
 	toString(): string;
 }
-declare class LockService {
+export declare class LockService {
 	private configVarClient;
 	constructor(configVarClient: ConfigVarClient);
 	acquireLock(lockInfo: LockInfo): Promise<boolean>;
 	releaseLock(name: string): Promise<void>;
 }
+/**
+ * MetadataService class to process and filter metadata.
+ */
+export declare class MetadataService {
+	private client;
+	constructor(client: MetadataClient);
+	/**
+	 * Retrieves metadata for specific objects.
+	 *
+	 * @param objectNames - The names of the objects.
+	 * @returns A promise that resolves to metadata records.
+	 */
+	getObjectMetadata(objectNames: string[]): Promise<Record<string, ObjectMetadata>>;
+	/**
+	 * Extracts picklist values from the object metadata.
+	 *
+	 * @param metadata - The metadata of the object.
+	 * @returns An object containing the picklist values for each picklist field.
+	 */
+	getPicklistValues(metadata: ObjectMetadata): Record<string, string[]>;
+}
 export declare class ResourceQueryParam {
 	resourceIds?: Set<string>;
 	regionIds?: Set<string>;
@@ -1220,6 +1287,7 @@ export declare class DateTimeUtils {
 	static mergeEvents(events: BaseEvent[]): BaseEvent[];
 }
 export declare class ExecutionContext {
+	private static instance;
 	skedContext: any;
 	contextData: any;
 	private baseConfig;
@@ -1229,6 +1297,7 @@ export declare class ExecutionContext {
 	protected constructor(skedContext: any, executionOptions: Partial<ExecutionOptions> | undefined, threshholds: ThresholdConfig);
 	static fromContext(skedContext: any, executionOptions?: Partial<ExecutionOptions>, threshholds?: ThresholdConfig): ExecutionContext;
 	static fromCredentials(config: BaseConfig, executionOptions?: Partial<ExecutionOptions>, threshholds?: ThresholdConfig): ExecutionContext;
+	private updateConfig;
 	set executionOptions(executionOptions: Partial<ExecutionOptions>);
 	get executionOptions(): Partial<ExecutionOptions>;
 	/**
@@ -1249,6 +1318,7 @@ export declare class ExecutionContext {
 	get mobileNotificationClient(): MobileNotificationClient;
 	get geoAPIClient(): GeoAPIClient;
 	get availabilityAPIClient(): AvailabilityAPIClient;
+	get filesAPIClient(): FilesAPIClient;
 	get geoService(): GeoService;
 	get lockService(): LockService;
 	get configVarCache(): CacheService<any>;
@@ -1327,54 +1397,6 @@ export declare const TenantObjects: {
  * Uses Winston logger but retains ANSI colors for console logs.
  */
 export declare function LogMethod(namespace?: string): (target: any, propertyKey: any, descriptor: any) => any;
-export interface BatchJobSchemaData extends HasId {
-	StatusDetails?: string;
-	MaximumBatches?: number;
-	Status?: string;
-	ProcessedBatches?: number;
-	ObjectName?: string;
-	JobType?: string;
-	BatchProcessor?: string;
-	CreatedDate?: string;
-	FilterCondition?: string;
-	OrderBy?: string;
-	Fields?: string;
-	JobHandler?: string;
-	State?: string;
-	DelaySeconds?: number;
-	CallbackURL?: string;
-	ProcessingAt?: string;
-	CompletedAt?: string;
-	FailedBatches?: number;
-	FetchingStrategy?: string;
-}
-export interface BatchOrchestratorConfig {
-	isAsyncProcessing?: boolean;
-}
-export interface BatchState {
-	processor?: {
-		cursor?: string;
-		allCursors?: string[];
-		batchNumber?: number;
-	};
-	worker?: any;
-}
-export declare class BatchOrchestrator {
-	protected context: ExecutionContext;
-	protected config: BatchOrchestratorConfig;
-	constructor(context: ExecutionContext, config?: BatchOrchestratorConfig);
-	processBatchJob(): Promise<void>;
-	protected validateJob(): void;
-	protected prepareData(): Promise<void>;
-	protected sendWorkerStateToCallbackUrl(): Promise<void>;
-	protected getWorkerState(): object;
-	protected delay(ms: number): Promise<void>;
-	protected processWorker(): Promise<void>;
-	protected processNextBatch(): Promise<void>;
-	protected postProcess(): Promise<void>;
-	protected updateJobStatus(): Promise<void>;
-	private isCompleted;
-}
 export declare enum PaginationStrategy {
 	CURSOR = "cursor",
 	OFFSET = "offset",