@coveo/platform-client 35.0.0

package/dist/definitions/resources/Products/ProductInterfaces.d.ts

@@ -0,0 +1,209 @@
+import { ProductsFacetRequestSortType, ProductsSortByType, SortingOrder } from '../Enums';
+export interface AdvancedFiltersModel {
+    queryFilter: string;
+}
+export interface AdvancedParametersModel {
+    /**
+     * Used to retrieve debug information. Will have an impact on query performance.
+     */
+    debug?: boolean;
+    /**
+     * Used to retrieve all documents regardless of their security model.
+     */
+    viewAllContent?: boolean;
+}
+export interface FacetRequestOptions {
+    /**
+     * Whether to take into account the scores generated by the index when reordering facets.
+     */
+    enableIndexFacetOrdering?: boolean;
+    /**
+     * Whether facets should be returned in the same order in which they were requested.
+     */
+    freezeFacetOrder?: boolean;
+}
+export interface FacetRequestItem {
+    /**
+     * The values displayed by the facet in the search interface at the moment of the request.
+     */
+    currentValues?: any[];
+    /**
+     * A custom sort order for the facet values.
+     */
+    customOrder?: string[];
+    /**
+     * The unique identifier of the facet in the search interface.
+     */
+    facetId?: string;
+    /**
+     * The name of the field on which to base the facet request.
+     */
+    field: string;
+    /**
+     * Whether the facet is expanded in the search interface at the moment of the request.
+     */
+    isFieldExpanded?: boolean;
+    /**
+     * The maximum number of facet values to fetch.
+     */
+    numberOfValues?: number;
+    /**
+     * Whether to prevent Coveo ML from automatically selecting facet values.
+     */
+    preventAutoSelect?: boolean;
+    /**
+     * The criterion to use for sorting returned facet values.
+     */
+    sortCriteria?: ProductsFacetRequestSortType;
+}
+export interface FacetsRequestModel {
+    /**
+     * The facet options to add to the request.
+     */
+    options?: FacetRequestOptions;
+    /**
+     * The facet operations to perform on the products listings.
+     */
+    requests: FacetRequestItem[];
+}
+export interface PaginatedModel {
+    /**
+     * The number of elements to list per page.
+     */
+    numberOfValues?: number;
+    /**
+     * The 0-based index number of the page of elements to retrieve.
+     */
+    page?: number;
+}
+export interface SortByFields {
+    /**
+     * The name of the field.
+     */
+    name: string;
+    /**
+     * The sorting direction.
+     */
+    direction: SortingOrder;
+}
+export interface SortModel {
+    /**
+     * The name of the field to sort by.
+     */
+    by: ProductsSortByType;
+    /**
+     * The fields to take into consideration when sorting.
+     */
+    fields?: SortByFields[];
+}
+export interface ProductsRequestModel {
+    /**
+     * Additional fields allow you to collect additional information, besides the standard data.
+     */
+    additionalFields?: string[];
+    /**
+     *
+     */
+    advancedFiltersModel?: AdvancedFiltersModel;
+    /**
+     * Advanced parameters to retrieve more information from the search queries.
+     */
+    advancedParameters?: AdvancedParametersModel;
+    /**
+     * An anonymous identifier used to determine from which identity the query comes from.
+     */
+    clientId?: string;
+    /**
+     * Parameters related to the facet request.
+     */
+    facets?: FacetsRequestModel;
+    /**
+     * Pagination parameters for the returned products.
+     */
+    pagination?: PaginatedModel;
+    /**
+     * Determines the order in which to retrieve the results.
+     */
+    sort?: SortModel;
+    /**
+     * The URL used to retrieve the products listings.
+     */
+    url: string;
+}
+export interface FacetResultModel {
+    facetId: string;
+    field: string;
+    fromAutoSelect: boolean;
+    indexScore: number;
+    mlScore: number;
+    moreValuesAvailable: boolean;
+    values: any[];
+}
+export interface FacetResponseModel {
+    /**
+     * A list of facet results.
+     */
+    results: FacetResultModel[];
+}
+export interface PaginationResultModel {
+    /**
+     * The number of elements.
+     */
+    totalCount: number;
+}
+export interface ProductListingIdentityModel {
+    /**
+     * Associated catalog id.
+     */
+    catalogId: string;
+    /**
+     * The product listing unique id.
+     */
+    id: string;
+}
+export interface ProductModel {
+    additionalFields: Map<string, any>;
+    childResults: ProductModel[];
+    clickUri: string;
+    ec_brand: string;
+    ec_category: string[];
+    ec_cogs: number;
+    ec_description: string;
+    ec_images: string[];
+    ec_in_stock: boolean;
+    ec_item_group_id: string;
+    ec_name: string;
+    ec_price: number;
+    ec_promo_price: number;
+    ec_rating: number;
+    ec_shortdesc: string;
+    ec_thumbnails: string[];
+    permanentid: string;
+    totalNumberOfChildResults: number;
+}
+export interface ProductsResultModel {
+    /**
+     * The execution report.
+     */
+    executionReport: Map<string, any>;
+    /**
+     * The list of facet results.
+     */
+    facets: FacetResponseModel;
+    /**
+     * The number of total elements returned.
+     */
+    pagination: PaginationResultModel;
+    /**
+     * The product listing identity model.
+     */
+    productListing: ProductListingIdentityModel;
+    /**
+     * A list of products.
+     */
+    products: ProductModel[];
+    /**
+     * The response unique id.
+     */
+    responseId: string;
+}

package/dist/definitions/resources/Products/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Product';
+export * from './ProductInterfaces';

package/dist/definitions/resources/PushApi/PushApi.d.ts

@@ -0,0 +1,10 @@
+import Resource from '../Resource';
+import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces';
+export default class PushApi extends Resource {
+    static baseUrl: string;
+    createOrUpdateSecurityIdentityAlias(securityProviderId: string, alias: SecurityIdentityAliasModel, options?: SecurityIdentityOptions): Promise<void>;
+    deleteSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityDelete, options?: SecurityIdentityOptions): Promise<void>;
+    createOrUpdateSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel, options?: SecurityIdentityOptions): Promise<void>;
+    manageSecurityIdentities(securityProviderId: string, batchConfig: SecurityIdentityBatchConfig): Promise<void>;
+    deleteOldSecurityIdentities(securityProviderId: string, batchDelete: SecurityIdentityDeleteOptions): Promise<void>;
+}

package/dist/definitions/resources/PushApi/PushApiInterfaces.d.ts

@@ -0,0 +1,37 @@
+import { SinglePermissionResult, SinglePermissionIdentityType } from '../Enums';
+export interface SecurityIdentityAliasModel extends SecurityIdentityBase {
+    mappings: AliasMappings;
+}
+export interface SecurityIdentityModel extends SecurityIdentityBase {
+    members?: Identity[];
+}
+export interface SecurityIdentityDelete {
+    identity: Identity;
+}
+export interface SecurityIdentityDeleteOptions extends Required<SecurityIdentityOptions> {
+    queueDelay?: number;
+}
+export interface SecurityIdentityOptions {
+    orderingId?: number;
+}
+export interface SecurityIdentityBatchConfig {
+    fileId: string;
+    orderingId?: string;
+}
+interface SecurityIdentityBase {
+    Result?: {
+        errorDetails: string;
+        result: SinglePermissionResult;
+    };
+    identity?: Identity;
+    wellKnowns?: Identity[];
+}
+interface AliasMappings extends Identity {
+    provider: string;
+}
+interface Identity {
+    additionalInfo: Record<string, string>;
+    name: string;
+    type: SinglePermissionIdentityType;
+}
+export {};

package/dist/definitions/resources/PushApi/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PushApi';
+export * from './PushApiInterfaces';

package/dist/definitions/resources/Resource.d.ts

@@ -0,0 +1,10 @@
+import API from '../APICore';
+declare class Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    constructor(api: API, serverlessApi: API);
+    protected buildPath(route: string, parameters: any): string;
+    private convertObjectToQueryString;
+}
+export default Resource;

package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshots.d.ts

@@ -0,0 +1,61 @@
+/// <reference types="node" />
+import Resource from '../Resource';
+import { ApplyOptions, CreateFromFileOptions, CreateFromOrganizationOptions, DryRunOptions, ExportSnapshotContentOptions, GenerateUrlOptions, GetSnapshotOptions, PushSnapshotOptions, ResourceSnapshotExportConfigurationModel, ResourceSnapshotsModel, ResourceSnapshotsReportModel, ResourceSnapshotsSynchronizationPlanModel, ResourceSnapshotsSynchronizationReportModel, ResourceSnapshotSupportedFileTypes, ResourceSnapshotType, ResourceSnapshotUrlModel, SnapshotAccessModel, SnapshotDiffModel, SnapshotListParams, UpdateChildrenOptions, ValidateAccessOptions } from './ResourceSnapshotsInterfaces';
+export default class ResourceSnapshots extends Resource {
+    static baseUrl: string;
+    list(params?: SnapshotListParams): Promise<ResourceSnapshotsModel[]>;
+    get(snapshotId: string, options?: GetSnapshotOptions): Promise<ResourceSnapshotsModel>;
+    /**
+     * Lists the resources that the authenticated user can leverage in snapshots in the target organization.
+     */
+    listResourceAccess(): Promise<ResourceSnapshotType[]>;
+    /**
+     * Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the target snapshot.
+     */
+    validateAccess(snapshotId: string, options: ValidateAccessOptions): Promise<SnapshotAccessModel>;
+    /**
+     * Retrieves a ZIP file holding the content of the target snapshot, in the target format.
+     *
+     * @param {string} snapshotId The unique identifier of the target snapshot.
+     * @param {ExportSnapshotContentOptions} [options]
+     * @returns {Promise<Blob>} A newly created Blob object which contains the zipped snapshot
+     */
+    export(snapshotId: string, options?: ExportSnapshotContentOptions): Promise<Blob>;
+    getContent(snapshotId: string, options: GenerateUrlOptions): Promise<Response>;
+    /**
+     * Creates a snapshot from a file containing the configuration.
+     *
+     * @param {File} file The file containing the configuration.
+     * @param {CreateFromFileOptions} options
+     */
+    createFromFile(file: File, options?: CreateFromFileOptions): Promise<ResourceSnapshotsModel>;
+    /**
+     * Creates a snapshot from a buffer containing the configuration.
+     *
+     * @param {Buffer} file The buffer containing the configuration.
+     * @param {ResourceSnapshotSupportedFileTypes} fileType The type of the file containing the configuration.
+     * @param {CreateFromFileOptions} options
+     */
+    createFromBuffer(file: Buffer, fileType: ResourceSnapshotSupportedFileTypes, options: CreateFromFileOptions): Promise<ResourceSnapshotsModel>;
+    createFromOrganization(exportConfigurationModel: ResourceSnapshotExportConfigurationModel, options: CreateFromOrganizationOptions): Promise<ResourceSnapshotsModel>;
+    generateUrl(snapshotId: string, options: GenerateUrlOptions): Promise<ResourceSnapshotUrlModel>;
+    dryRun(snapshotId: string, options: DryRunOptions): Promise<ResourceSnapshotsReportModel>;
+    apply(snapshotId: string, options: ApplyOptions): Promise<ResourceSnapshotsReportModel>;
+    push(snapshotId: string, options: PushSnapshotOptions): Promise<Record<string, unknown>>;
+    delete(snapshotId: string): Promise<Record<string, unknown>>;
+    createSynchronizationPlan(snapshotId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    getSynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    updateSynchronizationPlan(snapshotId: string, synchronizationPlanId: string, synchronizationPlanModel: ResourceSnapshotsSynchronizationPlanModel): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    applySynchronizationPlan(snapshotId: string, synchronizationPlanId: string): Promise<ResourceSnapshotsSynchronizationReportModel>;
+    updateSynchronizationPlanForChildren(snapshotId: string, synchronizationPlanId: string, options: UpdateChildrenOptions): Promise<ResourceSnapshotsSynchronizationPlanModel>;
+    private getSnapshotFileType;
+    /**
+     * @description Shows the diff report for the target snapshot and dry-run report
+     * @experimental
+     *
+     * @param {string} snapshotId - The unique identifier of the target snapshot.
+     * @param {string} relativeReportId - The unique identifier of the dry-run operation report associated with the target diff report.
+     * @param {(number|undefined)} [numberOfLinesMax=undefined] - Maximum number of lines before the diff is downloaded to a file.
+     */
+    diff(snapshotId: string, relativeReportId: string, numberOfLinesMax?: number): Promise<SnapshotDiffModel>;
+}

package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts

@@ -0,0 +1,309 @@
+import { SortingOrder, SnapshotSortingType } from '../Enums';
+export interface ResourceSnapshotsModel {
+    /**
+     * The username of the snapshot creator.
+     */
+    createdBy: string;
+    /**
+     * The date of creation of the snapshot in number of milliseconds since UNIX epoch.
+     */
+    createdDate: number;
+    /**
+     * A note you can attach to your snapshot.
+     */
+    developerNote?: string;
+    /**
+     * The unique identifier of the target snapshot.
+     */
+    id: string;
+    /**
+     * The unique identifier of the organization from which the snapshot originates if it differs from the current organization.
+     */
+    originId?: string;
+    /**
+     * The unique identifier of the organization in which the snapshot applies.
+     */
+    targetId: string;
+    /**
+     * The list of reports of events on the snapshot.
+     */
+    reports?: ResourceSnapshotsReportModel[];
+    /**
+     * The list of synchronization reports on the snapshot.
+     */
+    synchronizationReports?: ResourceSnapshotsSynchronizationReportModel[];
+    /**
+     * The list of diff generation reports on the snapshot.
+     */
+    diffGenerationReports?: SnapshotDiffModel[];
+    /**
+     * A summary of the contents of the snapshot.
+     */
+    contentSummary?: Record<string, number>;
+}
+export declare enum ResourceSnapshotType {
+    extension = "EXTENSION",
+    featuredResult = "FEATURED_RESULT",
+    field = "FIELD",
+    filter = "FILTER",
+    mapping = "MAPPING",
+    mlModel = "ML_MODEL",
+    mlModelAssociation = "ML_MODEL_ASSOCIATION",
+    queryParameter = "QUERY_PARAMETER",
+    queryPipeline = "QUERY_PIPELINE",
+    queryPipelineCondition = "QUERY_PIPELINE_CONDITION",
+    rankingExpression = "RANKING_EXPRESSION",
+    rankingWeight = "RANKING_WEIGHT",
+    searchPage = "SEARCH_PAGE",
+    securityProvider = "SECURITY_PROVIDER",
+    source = "SOURCE",
+    stopWord = "STOP_WORD",
+    subscription = "SUBSCRIPTION",
+    thesaurus = "THESAURUS",
+    trigger = "TRIGGER"
+}
+export declare enum SnapshotAccessType {
+    Read = "READ",
+    Write = "WRITE"
+}
+export declare enum SnapshotExportContentFormat {
+    Flat = "FLAT",
+    SplitPerType = "SPLIT_PER_TYPE"
+}
+export declare enum ResourceSnapshotsReportResultCode {
+    AccessDenied = "ACCESS_DENIED",
+    ResourcesInError = "RESOURCES_IN_ERROR",
+    Success = "SUCCESS",
+    UnexpectedError = "UNEXPECTED_ERROR",
+    UnableToPushToOrganization = "UNABLE_TO_PUSH_TO_ORGANIZATION",
+    NoResourceRetrieved = "NO_RESOURCE_RETRIEVED",
+    UnableToRetrieveResources = "UNABLE_TO_RETRIEVE_RESOURCES",
+    ResourceDependencyCyle = "RESOURCE_DEPENDENCY_CYCLE",
+    ExternalServiceCommunicationError = "EXTERNAL_SERVICE_COMMUNICATION_ERROR"
+}
+export declare enum ResourceSnapshotsReportStatus {
+    Pending = "PENDING",
+    InProgress = "IN_PROGRESS",
+    Completed = "COMPLETED",
+    Aborted = "ABORTED"
+}
+export declare enum ResourceSnapshotsSynchronizationPlanStatus {
+    Creating = "CREATING",
+    Created = "CREATED",
+    InError = "IN_ERROR"
+}
+export declare enum ResourceSnapshotsReportType {
+    CreateSnapshot = "CREATE_SNAPSHOT",
+    DryRun = "DRY_RUN",
+    Apply = "APPLY",
+    CreateSynchronizationPlan = "CREATE_SYNCHRONIZATION_PLAN",
+    ApplySynchronizationPlan = "APPLY_SYNCHRONIZATION_PLAN"
+}
+export declare enum ResourceSnapshotSupportedFileTypes {
+    ZIP = "ZIP",
+    JSON = "JSON"
+}
+export declare enum ResourceSnapshotContentType {
+    PRIMARY = "PRIMARY",
+    CURRENT_STATE = "CURRENT_STATE"
+}
+export interface ResourceSnapshotsReportOperationModel {
+    /**
+     * The number of resources created by the operation.
+     */
+    resourcesCreated: number;
+    /**
+     * The number of resources deleted by the operation.
+     */
+    resourcesDeleted: number;
+    /**
+     * The number of resources for which an error occurred during the operation.
+     */
+    resourcesInError: number;
+    /**
+     * The number of pre-existing resources recreated by the operation. This happens when a resource cannot be updated. For example, it is not possible to rename a query pipeline, so in such a case the pipeline would be deleted and created again with the desired name. This operation counts as one recreation.
+     */
+    resourcesRecreated: number;
+    /**
+     * The number of resources unchanged by the operation.
+     */
+    resourcesUnchanged: number;
+    /**
+     * The number of resources updated by the operation.
+     */
+    resourcesUpdated: number;
+}
+export interface ResourceSnapshotsReportOperationResult {
+    /**
+     * The code of the error that occured.
+     */
+    resultCode: string;
+    /**
+     * A human-friendly message about the error.
+     */
+    message: string;
+}
+export declare type ResourceSnapshotsReportOperationResults = Record<string, ResourceSnapshotsReportOperationResult[]>;
+export interface ResourceSnapshotsReportModel {
+    /**
+     * The unique identifier of the report.
+     */
+    id: string;
+    /**
+     * For each type of resource, an object containing failure details, if applicable.
+     */
+    resourceOperationResults: Record<string, ResourceSnapshotsReportOperationResults>;
+    /**
+     * For each type of resource, a breakdown of the number of resources per operation.
+     */
+    resourceOperations: Record<string, ResourceSnapshotsReportOperationModel>;
+    /**
+     * The number of resources processed by the event.
+     */
+    resourcesProcessed: number;
+    /**
+     * The result code of the snapshot event, if applicable.
+     */
+    resultCode: ResourceSnapshotsReportResultCode;
+    /**
+     * The status of the snapshot.
+     */
+    status: ResourceSnapshotsReportStatus;
+    /**
+     * The type of snapshot event.
+     */
+    type: ResourceSnapshotsReportType;
+    /**
+     * The report creation date in number of milliseconds since UNIX epoch.
+     */
+    updatedDate: number;
+}
+export interface ResourceSnapshotsSynchronizationReportModel {
+    id: string;
+    synchronizationPlanId: string;
+    linkOperations?: Record<string, unknown>;
+    linkOperationDetails?: Record<string, unknown>;
+    resourcesProcessed?: number;
+    resultCode: ResourceSnapshotsReportResultCode;
+    status: ResourceSnapshotsReportStatus;
+    type: ResourceSnapshotsReportType;
+    updatedDate: number;
+}
+export interface ResourceSnapshotsSynchronizationPlanModel {
+    id: string;
+    snapshotId: string;
+    status: ResourceSnapshotsSynchronizationPlanStatus;
+    alreadyLinkedResources?: Record<string, ResourceSnapshotsAlreadyLinkedResourcesModel[]>;
+    resourceSynchronizationOperations?: Record<string, ResourceSnapshotsSynchronizationOperationsModel[]>;
+}
+export interface ResourceSnapshotsSynchronizationOperationsModel {
+    resourceName: string;
+    displayName: string;
+    matches: ResourceSnapshotsSynchronizationMatchModel[];
+}
+export interface ResourceSnapshotsAlreadyLinkedResourcesModel {
+    resourceName: string;
+    linkModel: ResourceSnapshotsLinkModel;
+}
+export interface ResourceSnapshotsSynchronizationMatchModel {
+    associationScore?: number;
+    displayName?: string;
+    linkModel: ResourceSnapshotsLinkModel;
+}
+export interface ResourceSnapshotsLinkModel {
+    id?: string;
+    organizationId: string;
+    resourceId: string;
+    resourceName: string;
+    resourceType: string;
+}
+export interface ResourceSnapshotExportConfigurationModel {
+    resourcesToExport: Partial<Record<ResourceSnapshotType, string[] | null>>;
+}
+export interface ResourceSnapshotUrlModel {
+    url: string;
+    urlExpiration: number;
+}
+export interface SnapshotAccessModel {
+    allowed: boolean;
+}
+export interface SnapshotListParams {
+    filter?: string;
+    sortingOrder?: SortingOrder;
+    sortingType?: SnapshotSortingType;
+}
+export interface PushSnapshotOptions {
+    targetOrganizationId: string;
+    developerNotes?: string;
+}
+export interface CreateFromFileOptions {
+    developerNotes?: string;
+}
+export interface GetSnapshotOptions {
+    /**
+     * Whether to include reports with the snapshot.
+     *
+     * @default false
+     */
+    includeReports?: boolean;
+}
+export interface ExportSnapshotContentOptions {
+    /**
+     * The format of the snapshot content.
+     * - FLAT: Content unified into a single file
+     * - SPLIT_PER_TYPE: Content split into one file per resource type
+     *
+     * @default SnapshotExportContentFormat.Flat
+     */
+    contentFormat?: SnapshotExportContentFormat;
+}
+export interface ValidateAccessOptions {
+    snapshotAccessType: SnapshotAccessType;
+}
+export interface CreateFromOrganizationOptions {
+    developerNotes?: string;
+    targetOrganizationId?: string;
+    includeChildrenResources?: boolean;
+}
+export interface DryRunOptions {
+    deleteMissingResources: boolean;
+}
+export declare enum ApplyOptionsDeletionScope {
+    AllManagedResources = "ALL_MANAGED_RESOURCES",
+    OnlyTypesFromSnapshot = "ONLY_TYPES_FROM_SNAPSHOT"
+}
+export interface ApplyOptions {
+    /**
+     * Whether to delete organization resources not present in the snapshot.
+     *
+     * @default false
+     */
+    deleteMissingResources?: boolean;
+    /**
+     * The scope of the resources on which to calculate deletions.
+     * **Note:** only applies when `deleteMissingResources` is set to `true`.
+     *
+     * @default ApplyOptionsDeletionScope.AllManagedResources
+     *
+     */
+    deletionScope?: ApplyOptionsDeletionScope;
+}
+export interface GenerateUrlOptions {
+    contentType: ResourceSnapshotContentType;
+}
+export interface UpdateChildrenOptions {
+    snapshotParentResourceName: string;
+    parentResourceType: string;
+    targetParentId: string;
+}
+export interface SnapshotDiffFileModel extends ResourceSnapshotUrlModel {
+    numberOfLines: number;
+}
+export interface SnapshotDiffModel {
+    id: string;
+    snapshotId: string;
+    relativeReportId: string;
+    updatedDate: number;
+    status: ResourceSnapshotsReportStatus;
+    files: Partial<Record<ResourceSnapshotType, SnapshotDiffFileModel>>;
+}

package/dist/definitions/resources/ResourceSnapshots/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ResourceSnapshots';
+export * from './ResourceSnapshotsInterfaces';

package/dist/definitions/resources/Saml/Saml.d.ts

@@ -0,0 +1,14 @@
+import { New } from '../BaseInterfaces';
+import { RealmModel } from '../Groups';
+import Resource from '../Resource';
+import { SamlIdentityProviderEnabledModel, SamlIdentityProviderModel } from './SamlInterfaces';
+export default class Saml extends Resource {
+    static baseUrl: string;
+    isEnabled(): Promise<SamlIdentityProviderEnabledModel>;
+    listAvailableProviders(): Promise<SamlIdentityProviderModel[]>;
+    deleteProvider(): Promise<Record<string, unknown>>;
+    getProvider(): Promise<SamlIdentityProviderModel>;
+    create(identityProvider: New<SamlIdentityProviderModel>): Promise<SamlIdentityProviderModel>;
+    update(identityProvider: SamlIdentityProviderModel): Promise<SamlIdentityProviderModel>;
+    listRealms(): Promise<RealmModel[]>;
+}

package/dist/definitions/resources/Saml/SamlInterfaces.d.ts

@@ -0,0 +1,13 @@
+import { IdAndDisplayNameModel } from '../BaseInterfaces';
+export interface SamlIdentityProviderEnabledModel {
+    organizationId: string;
+    samlEnabled: boolean;
+}
+export interface SamlIdentityProviderModel {
+    displayName: string;
+    entityId: string;
+    id: string;
+    organizationIds: IdAndDisplayNameModel[];
+    postBindingEndpoint: string;
+    x509Certificate: string;
+}

package/dist/definitions/resources/Saml/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Saml';
+export * from './SamlInterfaces';