// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';

/**
 * Author, publish, and install Unity Packages V2 packages
 */
export class Types extends APIResource {
  /**
   * Return the package builder's component types available to the authenticated
   * role.
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /package-components/types/ 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
   *
   * {
   *   "component_types": [
   *     {
   *       "type": "string",
   *       "display_name": "string"
   *     }
   *   ]
   * }
   * ```
   */
  retrieve(options?: RequestOptions): APIPromise<TypeRetrieveResponse> {
    return this._client.get('/package-components/types/', options);
  }
}

export interface TypeRetrieveResponse {
  /**
   * Selectable package component types and display names available to this role.
   */
  component_types: Array<TypeRetrieveResponse.ComponentType>;
}

export namespace TypeRetrieveResponse {
  export interface ComponentType {
    /**
     * Human-readable name of the component type.
     */
    display_name: string;

    /**
     * Component type accepted by the package component picker.
     */
    type: string;
  }
}

export declare namespace Types {
  export { type TypeRetrieveResponse as TypeRetrieveResponse };
}