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

import { APIResource } from '../../core/resource';
import * as Shared from '../shared';
import { GroupMembersPageCursorURL } from '../shared';
import { PageCursorURL, PagePromise } from '../../core/pagination';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

/**
 * Supergroups used by the company
 */
export class Members extends APIResource {
  /**
   * Retrieve members for a supergroup. A `group_id` returned by List supergroups or
   * Retrieve a supergroup can return a 404 response when membership is not
   * available. An empty `results` array means the supergroup has no members.
   *
   * - Requires: `API Tier 1`
   * - Expandable fields: `worker`
   * - Sortable fields: `id`, `created_at`, `updated_at`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /supergroups/{group_id}/members/?expand=expand&order_by=order_by&limit=50&cursor=cursor 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",
   *       "created_at": "string",
   *       "updated_at": "string",
   *       "full_name": "string",
   *       "work_email": "string",
   *       "worker_id": "string",
   *       "worker": {
   *         "id": "string",
   *         "created_at": "string",
   *         "updated_at": "string",
   *         "user_id": "string",
   *         "user": {},
   *         "is_manager": "string",
   *         "manager_id": "string",
   *         "manager": {},
   *         "legal_entity_id": "string",
   *         "legal_entity": {},
   *         "country": "AF",
   *         "start_date": "string",
   *         "end_date": "string",
   *         "number": "string",
   *         "work_email": "string",
   *         "personal_email": "string",
   *         "status": "INIT",
   *         "location": {},
   *         "employment_type_id": "string",
   *         "employment_type": {},
   *         "gender": "MALE",
   *         "date_of_birth": "string",
   *         "race": "BLACK",
   *         "ethnicity": "HISPANIC_OR_LATINO",
   *         "citizenship": "AF",
   *         "compensation_id": "string",
   *         "compensation": {},
   *         "overtime_exemption": "EXEMPT",
   *         "department_id": "string",
   *         "department": {},
   *         "teams_id": [],
   *         "teams": [],
   *         "title": "string",
   *         "title_effective_date": "string",
   *         "level_id": "string",
   *         "level": {},
   *         "job_function_id": "string",
   *         "job_function": {},
   *         "termination_details": {},
   *         "pay_schedule_id": "string",
   *         "work_schedule": {},
   *         "compensation_grade": {},
   *         "original_start_date": "string",
   *         "custom_fields": [],
   *         "country_fields": {},
   *         "business_partners_id": [],
   *         "business_partners": []
   *       }
   *     }
   *   ],
   *   "next_link": "string"
   * }
   * ```
   */
  list(
    groupID: string,
    query: MemberListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
    return this._client.getAPIList(
      path`/supergroups/${groupID}/members/`,
      PageCursorURL<Shared.GroupMember>,
      { query, ...options },
    );
  }
}

export interface MemberListParams {
  cursor?: string;

  expand?: string;

  /**
   * The maximum number of results to return. Defaults to 50. Maximum is 100.
   */
  limit?: number;

  order_by?: string;
}

export declare namespace Members {
  export { type MemberListParams as MemberListParams };
}

export { type GroupMembersPageCursorURL };