@boxyhq/saml-jackson 1.33.1-beta.1 → 1.34.0

package/dist/src/ee/identity-federation/app.d.ts

@@ -1,328 +0,0 @@
-import type { Storable, JacksonOption, IdentityFederationApp, Records, GetByProductParams, AppRequestParams, Index } from '../../typings';
-type NewAppParams = Pick<IdentityFederationApp, 'name' | 'tenant' | 'product' | 'acsUrl' | 'entityId' | 'tenants' | 'mappings' | 'type' | 'redirectUrl'> & {
-    logoUrl?: string;
-    faviconUrl?: string;
-    primaryColor?: string;
-};
-export declare class App {
-    protected store: Storable;
-    private opts;
-    /**
-     * @swagger
-     * definitions:
-     *   IdentityFederationApp:
-     *      type: object
-     *      properties:
-     *        id:
-     *          type: string
-     *          description: id
-     *        name:
-     *          type: string
-     *          description: name
-     *        tenant:
-     *          type: string
-     *          description: Tenant
-     *        product:
-     *          type: string
-     *          description: Product
-     *        acsUrl:
-     *          type: string
-     *          description: ACS URL
-     *        entityId:
-     *          type: string
-     *          description: Entity ID
-     *        logoUrl:
-     *          type: string
-     *          description: Logo URL (optional)
-     *        faviconUrl:
-     *          type: string
-     *          description: Favicon URL (optional)
-     *        primaryColor:
-     *          type: string
-     *          description: Primary color (optional)
-     */
-    constructor({ store, opts }: {
-        store: Storable;
-        opts: JacksonOption;
-    });
-    /**
-     * @swagger
-     * /api/v1/identity-federation:
-     *   post:
-     *     summary: Create an Identity Federation app
-     *     parameters:
-     *       - name: name
-     *         description: Name
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: tenant
-     *         description: Tenant
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: product
-     *         description: Product
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: acsUrl
-     *         description: ACS URL
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: entityId
-     *         description: Entity ID
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: logoUrl
-     *         description: Logo URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: faviconUrl
-     *         description: Favicon URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: primaryColor
-     *         description: Primary color
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: tenants
-     *         description: Mapping of tenants whose connections will be grouped under this Identity Federation app
-     *         in: formData
-     *         required: false
-     *         type: array
-     *       - name: mappings
-     *         description: Mapping of attributes from the IdP to SP
-     *         in: formData
-     *         required: false
-     *         type: array
-     *       - name: type
-     *         description: If creating an OIDC app, this should be set to 'oidc' otherwise it defaults to 'saml'
-     *         in: formData
-     *         required: false
-     *         type: array
-     *       - name: redirectUrl
-     *         description: If creating an OIDC app, provide the redirect URL
-     *         in: formData
-     *         required: false
-     *         type: array
-     *     tags: [Identity Federation]
-     *     produces:
-     *      - application/json
-     *     consumes:
-     *      - application/x-www-form-urlencoded
-     *      - application/json
-     *     responses:
-     *      200:
-     *        description: Success
-     *        schema:
-     *          type: array
-     *          items:
-     *            $ref:  '#/definitions/IdentityFederationApp'
-     */
-    create({ name, type, redirectUrl, tenant, product, acsUrl, entityId, logoUrl, faviconUrl, primaryColor, tenants, mappings, }: NewAppParams): Promise<IdentityFederationApp>;
-    /**
-     * @swagger
-     * /api/v1/identity-federation:
-     *   get:
-     *     summary: Get an Identity Federation app
-     *     parameters:
-     *       - name: id
-     *         description: App ID
-     *         in: query
-     *         required: true
-     *         type: string
-     *       - name: tenant
-     *         description: Tenant
-     *         in: query
-     *         required: false
-     *         type: string
-     *       - name: product
-     *         description: Product
-     *         in: query
-     *         required: false
-     *         type: string
-     *     tags:
-     *       - Identity Federation
-     *     produces:
-     *       - application/json
-     *     responses:
-     *       '200':
-     *         description: Success
-     *         schema:
-     *           $ref: '#/definitions/IdentityFederationApp'
-     */
-    get(params: AppRequestParams): Promise<IdentityFederationApp>;
-    /**
-     * @swagger
-     * /api/v1/identity-federation/product:
-     *   get:
-     *     summary: Get Identity Federation apps by product
-     *     parameters:
-     *       - name: product
-     *         description: Product
-     *         in: query
-     *         required: true
-     *         type: string
-     *       - $ref: '#/parameters/pageOffset'
-     *       - $ref: '#/parameters/pageLimit'
-     *       - $ref: '#/parameters/pageToken'
-     *     tags:
-     *       - Identity Federation
-     *     produces:
-     *       - application/json
-     *     responses:
-     *        200:
-     *          description: Success
-     *          content:
-     *            application/json:
-     *               schema:
-     *                 type: object
-     *                 properties:
-     *                   data:
-     *                     type: array
-     *                     items:
-     *                       $ref: '#/definitions/IdentityFederationApp'
-     *                   pageToken:
-     *                     type: string
-     *                     description: token for pagination
-     */
-    getByProduct({ product, pageOffset, pageLimit, pageToken }: GetByProductParams): Promise<Records<any>>;
-    getByEntityId(entityId: string): Promise<IdentityFederationApp>;
-    /**
-     * @swagger
-     * /api/v1/identity-federation:
-     *   patch:
-     *     summary: Update an Identity Federation app
-     *     parameters:
-     *       - name: id
-     *         description: App ID
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: tenant
-     *         description: Tenant
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: product
-     *         description: Product
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: name
-     *         description: Name
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: acsUrl
-     *         description: ACS URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: logoUrl
-     *         description: Logo URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: faviconUrl
-     *         description: Favicon URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: primaryColor
-     *         description: Primary color
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: tenants
-     *         description: Mapping of tenants whose connections will be grouped under this Identity Federation app
-     *         in: formData
-     *         required: false
-     *         type: array
-     *       - name: mappings
-     *         description: Mapping of attributes from the IdP to SP
-     *         in: formData
-     *         required: false
-     *         type: array
-     *     tags:
-     *       - Identity Federation
-     *     produces:
-     *       - application/json
-     *     consumes:
-     *      - application/x-www-form-urlencoded
-     *      - application/json
-     *     responses:
-     *       '200':
-     *         description: Success
-     *         schema:
-     *           $ref: '#/definitions/IdentityFederationApp'
-     */
-    update(params: Partial<IdentityFederationApp>): Promise<{
-        id: string;
-        type?: string;
-        clientID?: string;
-        clientSecret?: string;
-        redirectUrl?: string[] | string;
-        name: string;
-        tenant: string;
-        product: string;
-        acsUrl: string;
-        entityId: string;
-        logoUrl: string | null;
-        faviconUrl: string | null;
-        primaryColor: string | null;
-        tenants?: string[];
-        mappings?: import("./types").AttributeMapping[] | null;
-    }>;
-    getAll({ pageOffset, pageLimit, pageToken, }: {
-        pageOffset?: number;
-        pageLimit?: number;
-        pageToken?: string;
-    }): Promise<Records<IdentityFederationApp>>;
-    /**
-     * @swagger
-     * /api/v1/identity-federation:
-     *   delete:
-     *     summary: Delete an Identity Federation app
-     *     parameters:
-     *       - name: id
-     *         description: App ID
-     *         in: query
-     *         required: true
-     *         type: string
-     *       - name: tenant
-     *         description: Tenant
-     *         in: query
-     *         required: false
-     *         type: string
-     *       - name: product
-     *         description: Product
-     *         in: query
-     *         required: false
-     *         type: string
-     *     tags:
-     *       - Identity Federation
-     *     produces:
-     *       - application/json
-     *     responses:
-     *       '200':
-     *         description: Success
-     *         schema:
-     *           $ref: '#/definitions/IdentityFederationApp'
-     */
-    delete(params: AppRequestParams): Promise<void>;
-    getMetadata(): Promise<{
-        xml: any;
-        entityId: string;
-        ssoUrl: string;
-        x509cert: string;
-    }>;
-    getCount(idx?: Index): Promise<number | undefined>;
-}
-export {};