// 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';
import { path } from '../../internal/utils/path';

/**
 * Permission-profile membership for the authenticated caller
 */
export class PermissionProfiles extends APIResource {
  /**
   * Check the authenticated caller's live assignment to an active permission
   * profile, not its data-access grants.
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /permissions/permission-profiles/{profile_id}/membership/ 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
   *
   * {
   *   "is_member": false
   * }
   * ```
   */
  membership(profileID: string, options?: RequestOptions): APIPromise<PermissionProfileMembershipResponse> {
    return this._client.get(path`/permissions/permission-profiles/${profileID}/membership/`, options);
  }
}

/**
 * The authenticated caller's membership in one active permission profile.
 */
export interface PermissionProfileMembershipResponse {
  /**
   * Whether the authenticated caller belongs to this active permission profile in
   * their company. False also covers nonexistent or unavailable profiles.
   */
  is_member: boolean;
}

export declare namespace PermissionProfiles {
  export { type PermissionProfileMembershipResponse as PermissionProfileMembershipResponse };
}