@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/tracks.ts

@@ -0,0 +1,72 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Tracks extends APIResource {
+  /**
+   * Retrieve a specific track
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<TrackRetrieveResponse> {
+    return this._client.get(path`/tracks/${id}`, options);
+  }
+
+  /**
+   * A List of tracks
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: TrackListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TracksPageCursorURL, Track> {
+    return this._client.getAPIList('/tracks', PageCursorURL<Track>, { query, ...options });
+  }
+}
+
+export type TracksPageCursorURL = PageCursorURL<Track>;
+
+export interface Track {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the track. Must be unique within the company or organization.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface TrackRetrieveResponse extends BusinessPartnersAPI.Meta, Track {}
+
+export interface TrackListParams {
+  order_by?: string;
+}
+
+export declare namespace Tracks {
+  export {
+    type Track as Track,
+    type TrackRetrieveResponse as TrackRetrieveResponse,
+    type TracksPageCursorURL as TracksPageCursorURL,
+    type TrackListParams as TrackListParams,
+  };
+}

package/src/resources/users.ts

@@ -0,0 +1,255 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Users extends APIResource {
+  /**
+   * Retrieve a specific user
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse> {
+    return this._client.get(path`/users/${id}`, options);
+  }
+
+  /**
+   * 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> {
+    return this._client.getAPIList('/users', PageCursorURL<User>, { query, ...options });
+  }
+}
+
+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 namespace User {
+  export 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';
+  }
+
+  export 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.
+   */
+  export 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;
+  }
+
+  export 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;
+  }
+
+  export 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 {
+  order_by?: string;
+}
+
+export declare namespace Users {
+  export {
+    type User as User,
+    type UserRetrieveResponse as UserRetrieveResponse,
+    type UsersPageCursorURL as UsersPageCursorURL,
+    type UserListParams as UserListParams,
+  };
+}

package/src/resources/work-locations.ts

@@ -0,0 +1,78 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class WorkLocations extends APIResource {
+  /**
+   * Retrieve a specific work location
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<WorkLocationRetrieveResponse> {
+    return this._client.get(path`/work-locations/${id}`, options);
+  }
+
+  /**
+   * A List of work locations
+   *
+   * - Requires: `API Tier 1`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: WorkLocationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WorkLocationsPageCursorURL, WorkLocation> {
+    return this._client.getAPIList('/work-locations', PageCursorURL<WorkLocation>, { query, ...options });
+  }
+}
+
+export type WorkLocationsPageCursorURL = PageCursorURL<WorkLocation>;
+
+export interface WorkLocation {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The address for the work location.
+   */
+  address: Shared.Address;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the work location.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface WorkLocationRetrieveResponse extends BusinessPartnersAPI.Meta, WorkLocation {}
+
+export interface WorkLocationListParams {
+  order_by?: string;
+}
+
+export declare namespace WorkLocations {
+  export {
+    type WorkLocation as WorkLocation,
+    type WorkLocationRetrieveResponse as WorkLocationRetrieveResponse,
+    type WorkLocationsPageCursorURL as WorkLocationsPageCursorURL,
+    type WorkLocationListParams as WorkLocationListParams,
+  };
+}