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

import { APIResource } from '../core/resource';
import { PageCursorURL, PagePromise } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';

/**
 * Custom objects defined by the company
 */
export class PlatformCapabilities extends APIResource {
  /**
   * A list of platform capabilities.
   *
   * - Requires: `Platform Capabilities API`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /platform-capabilities/ 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": [
   *     {
   *       "version": "string"
   *     }
   *   ],
   *   "next_link": "string"
   * }
   * ```
   */
  list(
    options?: RequestOptions,
  ): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse> {
    return this._client.getAPIList(
      '/platform-capabilities/',
      PageCursorURL<PlatformCapabilityListResponse>,
      options,
    );
  }
}

export type PlatformCapabilityListResponsesPageCursorURL = PageCursorURL<PlatformCapabilityListResponse>;

export interface PlatformCapabilityListResponse {
  /**
   * Schema version
   */
  version: string;
}

export declare namespace PlatformCapabilities {
  export {
    type PlatformCapabilityListResponse as PlatformCapabilityListResponse,
    type PlatformCapabilityListResponsesPageCursorURL as PlatformCapabilityListResponsesPageCursorURL,
  };
}