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

/**
 * Developer Platform account and team management
 */
export class DeveloperUsers extends APIResource {
  /**
   * List App Shop Publishers Super Group members for the authenticated company.
   * Filterable: email, role_state.
   *
   * - Requires: `Developer Program`
   * - Filterable fields: `email`, `role_state`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /developer-users/?filter=filter&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",
   *       "email": "string",
   *       "full_name": "string",
   *       "is_super_admin": false,
   *       "role_state": "INIT"
   *     }
   *   ],
   *   "next_link": "string"
   * }
   * ```
   */
  list(
    query: DeveloperUserListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<DeveloperUserListResponsesPageCursorURL, DeveloperUserListResponse> {
    return this._client.getAPIList('/developer-users/', PageCursorURL<DeveloperUserListResponse>, {
      query,
      ...options,
    });
  }
}

export type DeveloperUserListResponsesPageCursorURL = PageCursorURL<DeveloperUserListResponse>;

/**
 * App Shop Publishers Super Group member.
 */
export interface DeveloperUserListResponse {
  /**
   * Role ID of a member of the App Shop Publishers Super Group
   */
  id?: string;

  /**
   * The publisher's work or invite email
   */
  email?: string;

  /**
   * The publisher's full name
   */
  full_name?: string;

  /**
   * Whether this publisher is a Super Admin
   */
  is_super_admin?: boolean;

  /**
   * Role state: INIT, HIRED, ACCEPTED, ACTIVE, or TERMINATED
   */
  role_state?: 'INIT' | 'HIRED' | 'ACCEPTED' | 'ACTIVE' | 'TERMINATED';
}

export interface DeveloperUserListParams {
  cursor?: string;

  filter?: string;

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

export declare namespace DeveloperUsers {
  export {
    type DeveloperUserListResponse as DeveloperUserListResponse,
    type DeveloperUserListResponsesPageCursorURL as DeveloperUserListResponsesPageCursorURL,
    type DeveloperUserListParams as DeveloperUserListParams,
  };
}