import { APIResource } from "../core/resource.js";
import * as BusinessPartnersAPI from "./business-partners.js";
import * as Shared from "./shared.js";
import { APIPromise } from "../core/api-promise.js";
import { PageCursorURL, PagePromise } from "../core/pagination.js";
import { RequestOptions } from "../internal/request-options.js";
/**
 * Users of the company
 */
export declare class Users extends APIResource {
    /**
     * A list of users.
     *
     * - Requires: `API Tier 1`
     * - Sortable fields: `id`, `created_at`, `updated_at`
     */
    list(query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<UsersPageCursorURL, User>;
    /**
     * Retrieve a specific user
     */
    retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse>;
}
export type UsersPageCursorURL = PageCursorURL<User>;
export interface User {
    /**
     * Identifier field
     */
    id: string;
    /**
     * Record creation date
     */
    created_at: string;
    /**
     * Record update date
     */
    updated_at: string;
    /**
     * Whether the user is able to access company resources, typically when they are in
     * actively engaged with the company and not after off-boarding.
     */
    active?: boolean;
    /**
     * The user's addresses.
     */
    addresses?: Array<User.Address>;
    /**
     * The display name of the user using either the concatenated preferred given and
     * family name or username depending on availability.
     */
    display_name?: string;
    /**
     * The user's email addresses.
     */
    emails?: Array<User.Email>;
    /**
     * The User's default location for purposes of localization of currency, date time
     * format, or numerical representations pursuant to RFC5646.
     */
    locale?: string;
    /**
     * The user's name.
     */
    name?: User.Name;
    /**
     * The permanent profile number of the user.
     */
    number?: string;
    /**
     * The user's phone numbers.
     */
    phone_numbers?: Array<User.PhoneNumber>;
    /**
     * The user's photos.
     */
    photos?: Array<User.Photo>;
    /**
     * The User's preferred written or spoken language in the same format of the HTTP
     * Accept-Language header, pursuant to Section 5.3.5 of RFC7231.
     */
    preferred_language?: string;
    /**
     * The User's current time zone in IANA database Olson format
     */
    timezone?: string;
    /**
     * The unique identifier across Rippling used by the User for direct authentication
     * into their associated company. Globally unique.
     */
    username?: string;
}
export declare namespace User {
    interface Address {
        /**
         * The country component, pursuant to SCIM RFC 7643 4.1.2.
         */
        country?: Shared.CountryCode;
        /**
         * The formatted mailing address.
         */
        formatted?: string;
        /**
         * The city or locality component.
         */
        locality?: string;
        /**
         * The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
         */
        postal_code?: string;
        /**
         * The state or region component, pursuant to SCIM RFC 7643 4.1.2.
         */
        region?: string;
        /**
         * The full street address component, which may include house number, street name,
         * P.O. box, and multi-line extended street address information, pursuant to SCIM
         * RFC 7643 4.1.2..
         */
        street_address?: string;
        /**
         * The classification of the address.
         */
        type?: 'HOME' | 'WORK' | 'OTHER';
    }
    interface Email {
        /**
         * The display value of the email address.
         */
        display?: string;
        /**
         * The classification of the email.
         */
        type?: 'HOME' | 'WORK' | 'OTHER';
        /**
         * A valid email address.
         */
        value?: string;
    }
    /**
     * The user's name.
     */
    interface Name {
        /**
         * The legal family name of the user, or last name in most Western languages.
         */
        family_name?: string;
        /**
         * The user's full name.
         */
        formatted?: string;
        /**
         * The given legal name of the user, or first name in most Western languages.
         */
        given_name?: string;
        /**
         * The middle name(s) of the user.
         */
        middle_name?: string;
        /**
         * The preferred family name, or last name in most Western languages, by the user.
         */
        preferred_family_name?: string;
        /**
         * The preferred given name, or first name in most Western languages, by the user.
         */
        preferred_given_name?: string;
    }
    interface PhoneNumber {
        /**
         * The display value of the phone number.
         */
        display?: string;
        /**
         * The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.
         */
        type?: 'HOME' | 'WORK' | 'MOBILE' | 'FAX' | 'OTHER';
        /**
         * The canonical global phone number pursuant to RFC3966.
         */
        value?: string;
    }
    interface Photo {
        /**
         * The classification of the photo.
         */
        type?: 'PHOTO' | 'THUMBNAIL';
        /**
         * The URL of the photo.
         */
        value?: string;
    }
}
/**
 * Meta information for the response.
 */
export interface UserRetrieveResponse extends BusinessPartnersAPI.Meta, User {
}
export interface UserListParams {
    cursor?: string;
    order_by?: string;
}
export declare namespace Users {
    export { type User as User, type UserRetrieveResponse as UserRetrieveResponse, type UsersPageCursorURL as UsersPageCursorURL, type UserListParams as UserListParams, };
}
//# sourceMappingURL=users.d.ts.map