// 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';

/**
 * Availability of API features to the company or Partners.
 */
export class Entitlements extends APIResource {
  /**
   * A list of entitlements.
   *
   * - Requires: `API Tier 1`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /entitlements/ 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",
   *       "description": "string",
   *       "display_name": "string"
   *     }
   *   ],
   *   "next_link": "string"
   * }
   * ```
   */
  list(
    options?: RequestOptions,
  ): PagePromise<EntitlementListResponsesPageCursorURL, EntitlementListResponse> {
    return this._client.getAPIList('/entitlements/', PageCursorURL<EntitlementListResponse>, options);
  }
}

export type EntitlementListResponsesPageCursorURL = PageCursorURL<EntitlementListResponse>;

export interface EntitlementListResponse {
  /**
   * Identifier field
   */
  id: string;

  /**
   * Description of the entitlement
   */
  description: string;

  /**
   * Display name of the entitlement
   */
  display_name: string;
}

export declare namespace Entitlements {
  export {
    type EntitlementListResponse as EntitlementListResponse,
    type EntitlementListResponsesPageCursorURL as EntitlementListResponsesPageCursorURL,
  };
}