import { APIResource } from "../core/resource.mjs";
import * as BusinessPartnersAPI from "./business-partners.mjs";
import { APIPromise } from "../core/api-promise.mjs";
import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
import { RequestOptions } from "../internal/request-options.mjs";
export declare class CustomApps extends APIResource {
    /**
     * A list of CustomApp.
     *
     * - Requires: `Custom Apps Platform API`
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /custom-apps/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "__meta": {
     *     "redacted_fields": [
     *       {
     *         "name": "date_of_birth",
     *         "reason": "Insufficient entitlements"
     *       }
     *     ]
     *   },
     *   "results": [
     *     {
     *       "id": "string",
     *       "name": "string",
     *       "api_name": "string",
     *       "description": "string",
     *       "icon": "string",
     *       "pages": [
     *         {}
     *       ],
     *       "created_at": "string",
     *       "updated_at": "string"
     *     }
     *   ],
     *   "next_link": "string"
     * }
     * ```
     */
    list(options?: RequestOptions): PagePromise<CustomAppListResponsesPageCursorURL, CustomAppListResponse>;
    /**
     * Create a new CustomApp
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * POST /custom-apps/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Content-Type: application/json
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * {
     *   "api_name": "api_name",
     *   "name": "name"
     * }
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "id": "string",
     *   "name": "string",
     *   "api_name": "string",
     *   "description": "string",
     *   "icon": "string",
     *   "pages": [
     *     {
     *       "api_name": "string",
     *       "page_type": "string",
     *       "canvas_instance_id": "string",
     *       "sdui_page_id": "string",
     *       "function_id": "string",
     *       "created_by": "string",
     *       "updated_by": "string"
     *     }
     *   ],
     *   "created_at": "string",
     *   "updated_at": "string"
     * }
     * ```
     */
    create(body: CustomAppCreateParams, options?: RequestOptions): APIPromise<CustomAppCreateResponse>;
    /**
     * Retrieve a specific CustomApp
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /custom-apps/{id}/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "__meta": {
     *     "redacted_fields": [
     *       {}
     *     ]
     *   }
     * }
     * ```
     */
    retrieve(id: string, options?: RequestOptions): APIPromise<CustomAppRetrieveResponse>;
    /**
     * Update a specific CustomApp.
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * PATCH /custom-apps/{id}/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Content-Type: application/json
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * {
     *   "api_name": "api_name",
     *   "name": "name"
     * }
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "id": "string",
     *   "name": "string",
     *   "api_name": "string",
     *   "description": "string",
     *   "icon": "string",
     *   "pages": [
     *     {
     *       "api_name": "string",
     *       "page_type": "string",
     *       "canvas_instance_id": "string",
     *       "sdui_page_id": "string",
     *       "function_id": "string",
     *       "created_by": "string",
     *       "updated_by": "string"
     *     }
     *   ],
     *   "created_at": "string",
     *   "updated_at": "string"
     * }
     * ```
     */
    update(id: string, body: CustomAppUpdateParams, options?: RequestOptions): APIPromise<CustomAppUpdateResponse>;
    /**
     * Delete a CustomApp
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * DELETE /custom-apps/{id}/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Rippling-Api-Version: 2024-08-01
     *
     * HTTP/1.1 204 No Content
     * ```
     */
    delete(id: string, options?: RequestOptions): APIPromise<void>;
}
export type CustomAppListResponsesPageCursorURL = PageCursorURL<CustomAppListResponse>;
export interface CustomAppListResponse {
    /**
     * The unique api name of the custom app
     */
    api_name: string;
    /**
     * The display name of the custom app
     */
    name: string;
    /**
     * Identifier field
     */
    id?: string;
    /**
     * Record creation date
     */
    created_at?: string;
    /**
     * The description of the custom app
     */
    description?: string;
    /**
     * The icon URL of the custom app
     */
    icon?: string;
    /**
     * The pages of the custom app
     */
    pages?: Array<CustomAppListResponse.Page>;
    /**
     * Record update date
     */
    updated_at?: string;
}
export declare namespace CustomAppListResponse {
    /**
     * Summary of a page attached to a custom app.
     */
    interface Page {
        /**
         * The unique name of the page within the app
         */
        api_name?: string;
        /**
         * The ID of the canvas instance backing this page (canvas_page only)
         */
        canvas_instance_id?: string;
        /**
         * The ID of the role that created the page
         */
        created_by?: string;
        /**
         * The ID of the Rippling Function rendering this page (sdui_page only)
         */
        function_id?: string;
        /**
         * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
         */
        page_type?: string;
        /**
         * The ID of the SDUI page instance (sdui_page only)
         */
        sdui_page_id?: string;
        /**
         * The ID of the role that last modified the page
         */
        updated_by?: string;
    }
}
export interface CustomAppCreateResponse {
    /**
     * The unique api name of the custom app
     */
    api_name: string;
    /**
     * The display name of the custom app
     */
    name: string;
    /**
     * Identifier field
     */
    id?: string;
    /**
     * Record creation date
     */
    created_at?: string;
    /**
     * The description of the custom app
     */
    description?: string;
    /**
     * The icon URL of the custom app
     */
    icon?: string;
    /**
     * The pages of the custom app
     */
    pages?: Array<CustomAppCreateResponse.Page>;
    /**
     * Record update date
     */
    updated_at?: string;
}
export declare namespace CustomAppCreateResponse {
    /**
     * Summary of a page attached to a custom app.
     */
    interface Page {
        /**
         * The unique name of the page within the app
         */
        api_name?: string;
        /**
         * The ID of the canvas instance backing this page (canvas_page only)
         */
        canvas_instance_id?: string;
        /**
         * The ID of the role that created the page
         */
        created_by?: string;
        /**
         * The ID of the Rippling Function rendering this page (sdui_page only)
         */
        function_id?: string;
        /**
         * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
         */
        page_type?: string;
        /**
         * The ID of the SDUI page instance (sdui_page only)
         */
        sdui_page_id?: string;
        /**
         * The ID of the role that last modified the page
         */
        updated_by?: string;
    }
}
/**
 * Meta information for the response.
 */
export interface CustomAppRetrieveResponse extends BusinessPartnersAPI.Meta {
    /**
     * The unique api name of the custom app
     */
    api_name: string;
    /**
     * The display name of the custom app
     */
    name: string;
    /**
     * Identifier field
     */
    id?: string;
    /**
     * Record creation date
     */
    created_at?: string;
    /**
     * The description of the custom app
     */
    description?: string;
    /**
     * The icon URL of the custom app
     */
    icon?: string;
    /**
     * The pages of the custom app
     */
    pages?: Array<CustomAppRetrieveResponse.Page>;
    /**
     * Record update date
     */
    updated_at?: string;
}
export declare namespace CustomAppRetrieveResponse {
    /**
     * Summary of a page attached to a custom app.
     */
    interface Page {
        /**
         * The unique name of the page within the app
         */
        api_name?: string;
        /**
         * The ID of the canvas instance backing this page (canvas_page only)
         */
        canvas_instance_id?: string;
        /**
         * The ID of the role that created the page
         */
        created_by?: string;
        /**
         * The ID of the Rippling Function rendering this page (sdui_page only)
         */
        function_id?: string;
        /**
         * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
         */
        page_type?: string;
        /**
         * The ID of the SDUI page instance (sdui_page only)
         */
        sdui_page_id?: string;
        /**
         * The ID of the role that last modified the page
         */
        updated_by?: string;
    }
}
export interface CustomAppUpdateResponse {
    /**
     * The unique api name of the custom app
     */
    api_name: string;
    /**
     * The display name of the custom app
     */
    name: string;
    /**
     * Identifier field
     */
    id?: string;
    /**
     * Record creation date
     */
    created_at?: string;
    /**
     * The description of the custom app
     */
    description?: string;
    /**
     * The icon URL of the custom app
     */
    icon?: string;
    /**
     * The pages of the custom app
     */
    pages?: Array<CustomAppUpdateResponse.Page>;
    /**
     * Record update date
     */
    updated_at?: string;
}
export declare namespace CustomAppUpdateResponse {
    /**
     * Summary of a page attached to a custom app.
     */
    interface Page {
        /**
         * The unique name of the page within the app
         */
        api_name?: string;
        /**
         * The ID of the canvas instance backing this page (canvas_page only)
         */
        canvas_instance_id?: string;
        /**
         * The ID of the role that created the page
         */
        created_by?: string;
        /**
         * The ID of the Rippling Function rendering this page (sdui_page only)
         */
        function_id?: string;
        /**
         * The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')
         */
        page_type?: string;
        /**
         * The ID of the SDUI page instance (sdui_page only)
         */
        sdui_page_id?: string;
        /**
         * The ID of the role that last modified the page
         */
        updated_by?: string;
    }
}
export interface CustomAppCreateParams {
    /**
     * The unique api name of the custom app
     */
    api_name: string;
    /**
     * The display name of the custom app
     */
    name: string;
    /**
     * The description of the custom app
     */
    description?: string;
}
export interface CustomAppUpdateParams {
    /**
     * The unique api name of the custom app
     */
    api_name: string;
    /**
     * The display name of the custom app
     */
    name: string;
    /**
     * The description of the custom app
     */
    description?: string;
}
export declare namespace CustomApps {
    export { type CustomAppListResponse as CustomAppListResponse, type CustomAppCreateResponse as CustomAppCreateResponse, type CustomAppRetrieveResponse as CustomAppRetrieveResponse, type CustomAppUpdateResponse as CustomAppUpdateResponse, type CustomAppListResponsesPageCursorURL as CustomAppListResponsesPageCursorURL, type CustomAppCreateParams as CustomAppCreateParams, type CustomAppUpdateParams as CustomAppUpdateParams, };
}
//# sourceMappingURL=custom-apps.d.mts.map