// 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 { buildHeaders } from '../internal/headers';
import { RequestOptions } from '../internal/request-options';
import { path } from '../internal/utils/path';

export class CustomSettings extends APIResource {
  /**
   * A list of Setting.
   *
   * - Requires: `API Tier 1`
   * - Sortable fields: `id`, `created_at`, `updated_at`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /custom-settings/?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",
   *       "display_name": "string",
   *       "api_name": "string",
   *       "data_type": "string",
   *       "secret_value": "string",
   *       "string_value": "string",
   *       "number_value": 0,
   *       "boolean_value": false
   *     }
   *   ],
   *   "next_link": "string"
   * }
   * ```
   */
  list(
    query: CustomSettingListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
    return this._client.getAPIList('/custom-settings/', PageCursorURL<CustomSettingListResponse>, {
      query,
      ...options,
    });
  }

  /**
   * Create a new Setting
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * POST /custom-settings/ HTTP/1.1
   * Host: rest.ripplingapis.com
   * Content-Type: application/json
   * 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",
   *   "display_name": "string",
   *   "api_name": "string",
   *   "data_type": "string",
   *   "secret_value": "string",
   *   "string_value": "string",
   *   "number_value": 0,
   *   "boolean_value": false
   * }
   * ```
   */
  create(
    body: CustomSettingCreateParams | null | undefined = {},
    options?: RequestOptions,
  ): APIPromise<CustomSettingCreateResponse> {
    return this._client.post('/custom-settings/', { body, ...options });
  }

  /**
   * Retrieve a specific Setting
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /custom-settings/{id}/ 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": [
   *       {}
   *     ]
   *   }
   * }
   * ```
   */
  retrieve(id: string, options?: RequestOptions): APIPromise<CustomSettingRetrieveResponse> {
    return this._client.get(path`/custom-settings/${id}/`, options);
  }

  /**
   * Update a specific Setting.
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * PATCH /custom-settings/{id}/ HTTP/1.1
   * Host: rest.ripplingapis.com
   * Content-Type: application/json
   * 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",
   *   "display_name": "string",
   *   "api_name": "string",
   *   "data_type": "string",
   *   "secret_value": "string",
   *   "string_value": "string",
   *   "number_value": 0,
   *   "boolean_value": false
   * }
   * ```
   */
  update(
    id: string,
    body: CustomSettingUpdateParams | null | undefined = {},
    options?: RequestOptions,
  ): APIPromise<CustomSettingUpdateResponse> {
    return this._client.patch(path`/custom-settings/${id}/`, { body, ...options });
  }

  /**
   * Delete a Setting
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * DELETE /custom-settings/{id}/ HTTP/1.1
   * Host: rest.ripplingapis.com
   * Rippling-Api-Version: 2024-08-01
   *
   * HTTP/1.1 204 No Content
   * ```
   */
  delete(id: string, options?: RequestOptions): APIPromise<void> {
    return this._client.delete(path`/custom-settings/${id}/`, {
      ...options,
      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
    });
  }
}

export type CustomSettingListResponsesPageCursorURL = PageCursorURL<CustomSettingListResponse>;

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

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

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

  /**
   * The unique api name of the setting
   */
  api_name?: string;

  /**
   * Boolean value of the setting, if it has boolean data type
   */
  boolean_value?: boolean;

  /**
   * Data type of the setting
   */
  data_type?: string;

  /**
   * The display name of setting
   */
  display_name?: string;

  /**
   * Number value of the setting, if it has number data type
   */
  number_value?: number;

  /**
   * Secret value of the setting, if it has secret data type
   */
  secret_value?: string;

  /**
   * String value of the setting, if it has string data type
   */
  string_value?: string;
}

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

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

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

  /**
   * The unique api name of the setting
   */
  api_name?: string;

  /**
   * Boolean value of the setting, if it has boolean data type
   */
  boolean_value?: boolean;

  /**
   * Data type of the setting
   */
  data_type?: string;

  /**
   * The display name of setting
   */
  display_name?: string;

  /**
   * Number value of the setting, if it has number data type
   */
  number_value?: number;

  /**
   * Secret value of the setting, if it has secret data type
   */
  secret_value?: string;

  /**
   * String value of the setting, if it has string data type
   */
  string_value?: string;
}

/**
 * Meta information for the response.
 */
export interface CustomSettingRetrieveResponse extends BusinessPartnersAPI.Meta {
  /**
   * Identifier field
   */
  id: string;

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

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

  /**
   * The unique api name of the setting
   */
  api_name?: string;

  /**
   * Boolean value of the setting, if it has boolean data type
   */
  boolean_value?: boolean;

  /**
   * Data type of the setting
   */
  data_type?: string;

  /**
   * The display name of setting
   */
  display_name?: string;

  /**
   * Number value of the setting, if it has number data type
   */
  number_value?: number;

  /**
   * Secret value of the setting, if it has secret data type
   */
  secret_value?: string;

  /**
   * String value of the setting, if it has string data type
   */
  string_value?: string;
}

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

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

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

  /**
   * The unique api name of the setting
   */
  api_name?: string;

  /**
   * Boolean value of the setting, if it has boolean data type
   */
  boolean_value?: boolean;

  /**
   * Data type of the setting
   */
  data_type?: string;

  /**
   * The display name of setting
   */
  display_name?: string;

  /**
   * Number value of the setting, if it has number data type
   */
  number_value?: number;

  /**
   * Secret value of the setting, if it has secret data type
   */
  secret_value?: string;

  /**
   * String value of the setting, if it has string data type
   */
  string_value?: string;
}

export interface CustomSettingListParams {
  cursor?: string;

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

  order_by?: string;
}

export interface CustomSettingCreateParams {
  /**
   * The unique api name of the setting
   */
  api_name?: string;

  /**
   * Boolean value of the setting, if it has boolean data type
   */
  boolean_value?: boolean;

  /**
   * Data type of the setting
   */
  data_type?: string;

  /**
   * The display name of setting
   */
  display_name?: string;

  /**
   * Number value of the setting, if it has number data type
   */
  number_value?: number;

  /**
   * Secret value of the setting, if it has secret data type
   */
  secret_value?: string;

  /**
   * String value of the setting, if it has string data type
   */
  string_value?: string;
}

export interface CustomSettingUpdateParams {
  /**
   * The unique api name of the setting
   */
  api_name?: string;

  /**
   * Boolean value of the setting, if it has boolean data type
   */
  boolean_value?: boolean;

  /**
   * Data type of the setting
   */
  data_type?: string;

  /**
   * The display name of setting
   */
  display_name?: string;

  /**
   * Number value of the setting, if it has number data type
   */
  number_value?: number;

  /**
   * Secret value of the setting, if it has secret data type
   */
  secret_value?: string;

  /**
   * String value of the setting, if it has string data type
   */
  string_value?: string;
}

export declare namespace CustomSettings {
  export {
    type CustomSettingListResponse as CustomSettingListResponse,
    type CustomSettingCreateResponse as CustomSettingCreateResponse,
    type CustomSettingRetrieveResponse as CustomSettingRetrieveResponse,
    type CustomSettingUpdateResponse as CustomSettingUpdateResponse,
    type CustomSettingListResponsesPageCursorURL as CustomSettingListResponsesPageCursorURL,
    type CustomSettingListParams as CustomSettingListParams,
    type CustomSettingCreateParams as CustomSettingCreateParams,
    type CustomSettingUpdateParams as CustomSettingUpdateParams,
  };
}