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

package/dist/src/directory-sync/scim/DirectoryConfig.d.ts

@@ -1,343 +0,0 @@
-import type { Directory, JacksonOption, DatabaseStore, DirectoryType, PaginationParams, IUsers, IGroups, IWebhookEventsLogger, IEventController, Response, Index } from '../../typings';
-interface DirectoryConfigParams {
-    db: DatabaseStore;
-    opts: JacksonOption;
-    users: IUsers;
-    groups: IGroups;
-    logger: IWebhookEventsLogger;
-    eventController: IEventController;
-}
-interface FilterByParams extends PaginationParams {
-    product?: string;
-    provider?: DirectoryType;
-}
-/**
- * @swagger
- * definitions:
- *   Directory:
- *      type: object
- *      properties:
- *        id:
- *          type: string
- *          description: Directory ID
- *        name:
- *          type: string
- *          description: name
- *        tenant:
- *          type: string
- *          description: Tenant
- *        product:
- *          type: string
- *          description: Product
- *        type:
- *          type: string
- *          description: Directory provider
- *        deactivated:
- *          type: boolean
- *          description: Status
- *        log_webhook_events:
- *          type: boolean
- *          description: If true, webhook requests will be logged
- *        scim:
- *         type: object
- *         properties:
- *           path:
- *              type: string
- *              description: SCIM path
- *           endpoint:
- *              type: string
- *              description: SCIM url
- *           secret:
- *              type: string
- *              description: SCIM secret
- *        webhook:
- *         type: object
- *         properties:
- *           endpoint:
- *              type: string
- *              description: Webhook url
- *           secret:
- *              type: string
- *              description: Webhook secret
- */
-export declare class DirectoryConfig {
-    private _store;
-    private opts;
-    private db;
-    private users;
-    private groups;
-    private logger;
-    private eventController;
-    constructor({ db, opts, users, groups, logger, eventController }: DirectoryConfigParams);
-    private store;
-    /**
-     * @swagger
-     * parameters:
-     *   tenant:
-     *     name: tenant
-     *     description: Tenant
-     *     in: query
-     *     required: true
-     *     type: string
-     *   product:
-     *     name: product
-     *     description: Product
-     *     in: query
-     *     required: true
-     *     type: string
-     *   directoryId:
-     *     name: directoryId
-     *     description: Directory ID
-     *     in: query
-     *     required: false
-     *     type: string
-     *   pageOffset:
-     *     name: pageOffset
-     *     description: Starting point from which the set of records are retrieved
-     *     in: query
-     *     required: false
-     *     type: string
-     *   pageLimit:
-     *     name: pageLimit
-     *     description: Number of records to be fetched for the page
-     *     in: query
-     *     required: false
-     *     type: string
-     *   pageToken:
-     *     name: pageToken
-     *     description: Token used for DynamoDB pagination
-     *     in: query
-     *     required: false
-     *     type: string
-     */
-    /**
-     * @swagger
-     * /api/v1/dsync:
-     *   post:
-     *     summary: Create a directory connection
-     *     parameters:
-     *       - name: tenant
-     *         description: Tenant
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: product
-     *         description: Product
-     *         in: formData
-     *         required: true
-     *         type: string
-     *       - name: name
-     *         description: Name
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: webhook_url
-     *         description: Webhook URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: webhook_secret
-     *         description: Webhook secret
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: type
-     *         description: Directory provider. (Supported values are azure-scim-v2, onelogin-scim-v2, okta-scim-v2, jumpcloud-scim-v2, generic-scim-v2, google)
-     *         in: formData
-     *         required: false
-     *         type: string
-     *     tags: [Directory Sync]
-     *     produces:
-     *      - application/json
-     *     consumes:
-     *      - application/x-www-form-urlencoded
-     *      - application/json
-     *     responses:
-     *      200:
-     *        description: Success
-     *        schema:
-     *          $ref:  '#/definitions/Directory'
-     */
-    create(params: {
-        name?: string;
-        tenant: string;
-        product: string;
-        webhook_url?: string;
-        webhook_secret?: string;
-        type?: DirectoryType;
-        google_domain?: string;
-        google_access_token?: string;
-        google_refresh_token?: string;
-    }): Promise<Response<Directory>>;
-    /**
-     * @swagger
-     * /api/v1/dsync/{directoryId}:
-     *   get:
-     *     summary: Get a directory connection by id
-     *     parameters:
-     *       - name: directoryId
-     *         description: Directory ID
-     *         in: path
-     *         required: true
-     *         type: string
-     *     tags:
-     *       - Directory Sync
-     *     produces:
-     *       - application/json
-     *     responses:
-     *       '200':
-     *         description: Success
-     *         schema:
-     *           $ref: '#/definitions/Directory'
-     */
-    get(id: string): Promise<Response<Directory>>;
-    /**
-     * @swagger
-     * /api/v1/dsync/{directoryId}:
-     *   patch:
-     *     summary: Update a directory connection
-     *     parameters:
-     *       - name: directoryId
-     *         description: Directory ID
-     *         in: path
-     *         required: true
-     *         type: string
-     *       - name: name
-     *         description: Name
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: webhook_url
-     *         description: Webhook URL
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: webhook_secret
-     *         description: Webhook secret
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: log_webhook_events
-     *         description: If true, webhook requests will be logged
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: deactivated
-     *         description: If true, the directory connection will be deactivated
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: google_domain
-     *         description: Google domain
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: google_access_token
-     *         description: Google access token
-     *         in: formData
-     *         required: false
-     *         type: string
-     *       - name: google_refresh_token
-     *         description: Google refresh token
-     *         in: formData
-     *         required: false
-     *         type: string
-     *     tags: [Directory Sync]
-     *     produces:
-     *      - application/json
-     *     consumes:
-     *      - application/x-www-form-urlencoded
-     *      - application/json
-     *     responses:
-     *      200:
-     *        description: Success
-     *        schema:
-     *          $ref:  '#/definitions/Directory'
-     */
-    update(id: string, param: Omit<Partial<Directory>, 'id' | 'tenant' | 'prodct' | 'scim' | 'type'> & {
-        webhook_url?: string;
-        webhook_secret?: string;
-    }): Promise<Response<Directory>>;
-    /**
-     * @swagger
-     * /api/v1/dsync:
-     *   get:
-     *     summary: Get a directory connection by tenant and product
-     *     parameters:
-     *       - $ref: '#/parameters/tenant'
-     *       - $ref: '#/parameters/product'
-     *     tags: [Directory Sync]
-     *     produces:
-     *      - application/json
-     *     consumes:
-     *      - application/x-www-form-urlencoded
-     *      - application/json
-     *     responses:
-     *      200:
-     *        description: Success
-     *        schema:
-     *          type: array
-     *          items:
-     *            $ref:  '#/definitions/Directory'
-     */
-    getByTenantAndProduct(tenant: string, product: string): Promise<Response<Directory[]>>;
-    getAll(params?: PaginationParams): Promise<Response<Directory[]> & {
-        pageToken?: string;
-    }>;
-    /**
-     * @swagger
-     * /api/v1/dsync/{directoryId}:
-     *   delete:
-     *     summary: Delete a directory connection by id
-     *     parameters:
-     *       - name: directoryId
-     *         description: Directory ID
-     *         in: path
-     *         required: true
-     *         type: string
-     *     tags:
-     *       - Directory Sync
-     *     produces:
-     *       - application/json
-     *     responses:
-     *       '200':
-     *         description: Success
-     */
-    delete(id: string): Promise<Response<null>>;
-    private transform;
-    /**
-     * @swagger
-     * /api/v1/dsync/product:
-     *   get:
-     *     summary: Get directory connections by product
-     *     parameters:
-     *      - $ref: '#/parameters/product'
-     *      - $ref: '#/parameters/pageOffset'
-     *      - $ref: '#/parameters/pageLimit'
-     *      - $ref: '#/parameters/pageToken'
-     *     tags:
-     *       - Directory Sync
-     *     produces:
-     *       - application/json
-     *     responses:
-     *       '200':
-     *         description: Success
-     *         content:
-     *           application/json:
-     *              schema:
-     *                type: object
-     *                properties:
-     *                  data:
-     *                    type: array
-     *                    items:
-     *                      $ref: '#/definitions/Directory'
-     *                  pageToken:
-     *                    type: string
-     *                    description: token for pagination
-     */
-    filterBy(params?: FilterByParams): Promise<Response<Directory[]> & {
-        pageToken?: string;
-    }>;
-    getCount(idx?: Index): Promise<number | undefined>;
-}
-export {};