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

import { APIResource } from '../core/resource';
import * as CompaniesAPI from './companies';
import { APIPromise } from '../core/api-promise';
import { RequestOptions } from '../internal/request-options';

/**
 * Provides the user's SSO information
 */
export class SSOMeResource extends APIResource {
  /**
   * SSO information of the current user
   *
   * - Requires: `API Tier 1`
   * - Expandable fields: `company`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /sso-me/?expand=expand&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
   *
   * {
   *   "id": "string",
   *   "created_at": "string",
   *   "updated_at": "string",
   *   "work_email": "string",
   *   "company_id": "string",
   *   "company": {
   *     "id": "string",
   *     "created_at": "string",
   *     "updated_at": "string",
   *     "parent_legal_entity_id": "string",
   *     "parent_legal_entity": {
   *       "id": "string",
   *       "created_at": "string",
   *       "updated_at": "string",
   *       "tax_identifier": "string",
   *       "country": {
   *         "code": "AF"
   *       },
   *       "legal_name": "string",
   *       "entity_level": "PARENT",
   *       "registration_date": "string",
   *       "mailing_address": {
   *         "type": "HOME",
   *         "formatted": "string",
   *         "street_address": "string",
   *         "locality": "string",
   *         "region": "string",
   *         "postal_code": "string",
   *         "country": "AF"
   *       },
   *       "physical_address": {
   *         "type": "HOME",
   *         "formatted": "string",
   *         "street_address": "string",
   *         "locality": "string",
   *         "region": "string",
   *         "postal_code": "string",
   *         "country": "AF"
   *       },
   *       "parent_id": "string",
   *       "parent": {},
   *       "management_type": "PEO",
   *       "company_id": "string",
   *       "company": {
   *         "id": "string",
   *         "created_at": "string",
   *         "updated_at": "string",
   *         "parent_legal_entity_id": "string",
   *         "parent_legal_entity": {},
   *         "legal_entities_id": [],
   *         "legal_entities": [],
   *         "physical_address": {},
   *         "primary_email": "string",
   *         "legal_name": "string",
   *         "doing_business_as_name": "string",
   *         "phone": "string",
   *         "name": "string"
   *       }
   *     },
   *     "legal_entities_id": [
   *       "string"
   *     ],
   *     "legal_entities": [
   *       {
   *         "id": "string",
   *         "created_at": "string",
   *         "updated_at": "string",
   *         "tax_identifier": "string",
   *         "country": {},
   *         "legal_name": "string",
   *         "entity_level": "PARENT",
   *         "registration_date": "string",
   *         "mailing_address": {},
   *         "physical_address": {},
   *         "parent_id": "string",
   *         "parent": {},
   *         "management_type": "PEO",
   *         "company_id": "string",
   *         "company": {}
   *       }
   *     ],
   *     "physical_address": {
   *       "type": "HOME",
   *       "formatted": "string",
   *       "street_address": "string",
   *       "locality": "string",
   *       "region": "string",
   *       "postal_code": "string",
   *       "country": "AF"
   *     },
   *     "primary_email": "string",
   *     "legal_name": "string",
   *     "doing_business_as_name": "string",
   *     "phone": "string",
   *     "name": "string"
   *   }
   * }
   * ```
   */
  list(query: SSOMeListParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
    return this._client.get('/sso-me/', { query, ...options });
  }
}

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

  /**
   * Record creation date
   */
  created_at: string;

  /**
   * Record update date
   */
  updated_at: string;

  /**
   * The company of the user.
   *
   * Expandable field
   */
  company?: CompaniesAPI.Company;

  /**
   * The company ID of the user.
   */
  company_id?: string;

  /**
   * The user's work email address.
   */
  work_email?: string;
}

export interface SSOMeListParams {
  cursor?: string;

  expand?: string;

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

export declare namespace SSOMeResource {
  export { type SSOMe as SSOMe, type SSOMeListParams as SSOMeListParams };
}