SalesLoft Platform

/**
 * SalesLoftPlatform - generated by OmniStream from SalesLoft Platform's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/salesloft";

export class SalesLoftPlatformError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `SalesLoftPlatform error ${status}`);
    this.name = "SalesLoftPlatformError";
    this.status = status;
    this.code = code;
  }
}

export interface SalesLoftPlatformOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class SalesLoftPlatform {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: SalesLoftPlatformOptions = {}) {
    if (!token) throw new Error("SalesLoftPlatform: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new SalesLoftPlatformError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** List account stages */
  getv2AccountStagesJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/account_stages.json", { params });
  }

  /** Fetch an account stage */
  getv2AccountStagesIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/account_stages/{id}.json", { params });
  }

  /** List Account Tiers */
  getv2AccountTiersJson(params: { "ids"?: unknown[]; "name"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/account_tiers.json", { params });
  }

  /** Fetch an account tier */
  getv2AccountTiersIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/account_tiers/{id}.json", { params });
  }

  /** Upsert an account */
  postv2AccountUpsertsJson(): Promise<any> {
    return this._request("POST", "/v2/account_upserts.json", {  });
  }

  /** List accounts */
  getv2AccountsJson(params: { "ids"?: unknown[]; "crm_id"?: unknown[]; "tag"?: unknown[]; "tag_id"?: unknown[]; "created_at"?: unknown[]; "updated_at"?: unknown[]; "domain"?: string; "website"?: unknown[]; "archived"?: boolean; "name"?: unknown[]; "account_stage_id"?: unknown[]; "account_tier_id"?: unknown[]; "owner_id"?: unknown[]; "owner_is_active"?: boolean; "last_contacted"?: string; "custom_fields"?: string; "industry"?: unknown[]; "country"?: unknown[]; "state"?: unknown[]; "city"?: unknown[]; "owner_crm_id"?: unknown[]; "locales"?: unknown[]; "user_relationships"?: string; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/accounts.json", { params });
  }

  /** Create an account */
  postv2AccountsJson(): Promise<any> {
    return this._request("POST", "/v2/accounts.json", {  });
  }

  /** Fetch an account */
  getv2AccountsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/accounts/{id}.json", { params });
  }

  /** Update an existing Account */
  putv2AccountsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/accounts/{id}.json", { params });
  }

  /** Delete an account */
  deletev2AccountsIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/accounts/{id}.json", { params });
  }

  /** List call instructions */
  getv2ActionDetailsCallInstructionsJson(params: { "ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/action_details/call_instructions.json", { params });
  }

  /** Fetch a call instructions */
  getv2ActionDetailsCallInstructionsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/action_details/call_instructions/{id}.json", { params });
  }

  /** List actions */
  getv2ActionsJson(params: { "ids"?: unknown[]; "step_id"?: number; "type"?: string; "due_on"?: unknown[]; "user_guid"?: unknown[]; "person_id"?: unknown[]; "cadence_id"?: unknown[]; "multitouch_group_id"?: unknown[]; "updated_at"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/actions.json", { params });
  }

  /** Fetch an action */
  getv2ActionsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/actions/{id}.json", { params });
  }

  /** Create an activity */
  postv2ActivitiesJson(): Promise<any> {
    return this._request("POST", "/v2/activities.json", {  });
  }

  /** List calls */
  getv2ActivitiesCallsJson(params: { "ids"?: unknown[]; "created_at"?: unknown[]; "updated_at"?: unknown[]; "user_guid"?: unknown[]; "person_id"?: unknown[]; "sentiment"?: unknown[]; "disposition"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/activities/calls.json", { params });
  }

  /** Create a call */
  postv2ActivitiesCallsJson(): Promise<any> {
    return this._request("POST", "/v2/activities/calls.json", {  });
  }

  /** Fetch a call */
  getv2ActivitiesCallsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/activities/calls/{id}.json", { params });
  }

  /** List emails */
  getv2ActivitiesEmailsJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "bounced"?: boolean; "crm_activity_id"?: unknown[]; "action_id"?: unknown[]; "user_id"?: unknown[]; "status"?: unknown[]; "cadence_id"?: unknown[]; "step_id"?: unknown[]; "one_off"?: boolean; "scoped_fields"?: unknown[]; "person_id"?: unknown[]; "email_addresses"?: unknown[]; "personalization"?: unknown[]; "sent_at"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/activities/emails.json", { params });
  }

  /** Fetch an email */
  getv2ActivitiesEmailsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/activities/emails/{id}.json", { params });
  }

  /** List Past Activities */
  getv2ActivityHistories(params: { "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "sort_by"?: string; "sort_direction"?: string; "type"?: string; "_resource"?: string; "occurred_at"?: string; "pinned"?: boolean; "resource_type"?: string; "resource_id"?: unknown[]; "updated_at"?: string; "user_guid"?: string }): Promise<any> {
    return this._request("GET", "/v2/activity_histories", { params });
  }

  /** List bulk jobs */
  getv2BulkJobs(params: { "state"?: unknown[]; "id"?: string; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/v2/bulk_jobs", { params });
  }

  /** Create a bulk job */
  postv2BulkJobs(): Promise<any> {
    return this._request("POST", "/v2/bulk_jobs", {  });
  }

  /** List job data for a bulk job */
  getv2BulkJobsBulkJobsIdJobData(params: { "bulk_jobs_id": number; "status"?: unknown[]; "id"?: string; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/v2/bulk_jobs/{bulk_jobs_id}/job_data", { params });
  }

  /** Create job data for a bulk job */
  postv2BulkJobsBulkJobsIdJobData(params: { "bulk_jobs_id": number }): Promise<any> {
    return this._request("POST", "/v2/bulk_jobs/{bulk_jobs_id}/job_data", { params });
  }

  /** List job data for a completed bulk job. */
  getv2BulkJobsBulkJobsIdResults(params: { "bulk_jobs_id": number; "status"?: unknown[]; "id"?: string; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/v2/bulk_jobs/{bulk_jobs_id}/results", { params });
  }

  /** Fetch a bulk job */
  getv2BulkJobsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v2/bulk_jobs/{id}", { params });
  }

  /** Update a bulk job */
  putv2BulkJobsId(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v2/bulk_jobs/{id}", { params });
  }

  /** Export a cadence */
  getv2CadenceExportsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/cadence_exports/{id}.json", { params });
  }

  /** Import cadences from JSON */
  postv2CadenceImportsJson(): Promise<any> {
    return this._request("POST", "/v2/cadence_imports.json", {  });
  }

  /** List cadence memberships */
  getv2CadenceMembershipsJson(params: { "ids"?: unknown[]; "person_id"?: number; "cadence_id"?: number; "updated_at"?: unknown[]; "currently_on_cadence"?: boolean; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/cadence_memberships.json", { params });
  }

  /** Create a cadence membership */
  postv2CadenceMembershipsJson(params: { "person_id": number; "cadence_id": number; "user_id"?: number; "step_id"?: number }): Promise<any> {
    return this._request("POST", "/v2/cadence_memberships.json", { params });
  }

  /** Fetch a cadence membership */
  getv2CadenceMembershipsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/cadence_memberships/{id}.json", { params });
  }

  /** Delete a cadence membership */
  deletev2CadenceMembershipsIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/cadence_memberships/{id}.json", { params });
  }

  /** List cadences */
  getv2CadencesJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "team_cadence"?: boolean; "shared"?: boolean; "owned_by_guid"?: unknown[]; "people_addable"?: boolean; "name"?: unknown[]; "group_ids"?: string; "archived"?: boolean; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/cadences.json", { params });
  }

  /** Fetch a cadence */
  getv2CadencesIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/cadences/{id}.json", { params });
  }

  /** List calendar events */
  getv2CalendarEvents(params: { "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "sort_by"?: string; "sort_direction"?: string; "start_time"?: string; "end_time"?: string; "user_guid"?: string }): Promise<any> {
    return this._request("GET", "/v2/calendar/events", { params });
  }

  /** Upsert a calendar event */
  postv2CalendarEventsUpsert(): Promise<any> {
    return this._request("POST", "/v2/calendar/events/upsert", {  });
  }

  /** List call data records */
  getv2CallDataRecordsJson(params: { "ids"?: unknown[]; "has_call"?: boolean; "created_at"?: unknown[]; "updated_at"?: unknown[]; "user_guid"?: unknown[]; "person_id"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/call_data_records.json", { params });
  }

  /** Fetch a call data record */
  getv2CallDataRecordsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/call_data_records/{id}.json", { params });
  }

  /** List call dispositions */
  getv2CallDispositionsJson(params: { "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/call_dispositions.json", { params });
  }

  /** List call sentiments */
  getv2CallSentimentsJson(params: { "name"?: string; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/call_sentiments.json", { params });
  }

  /** Create Conversations Call */
  postv2ConversationsCalls(): Promise<any> {
    return this._request("POST", "/v2/conversations/calls", {  });
  }

  /** List crm activities */
  getv2CrmActivitiesJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/crm_activities.json", { params });
  }

  /** Fetch a crm activity */
  getv2CrmActivitiesIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/crm_activities/{id}.json", { params });
  }

  /** List crm activity fields */
  getv2CrmActivityFieldsJson(params: { "source"?: string; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/crm_activity_fields.json", { params });
  }

  /** List crm users */
  getv2CrmUsersJson(params: { "ids"?: unknown[]; "crm_id"?: unknown[]; "user_id"?: unknown[]; "user_guid"?: unknown[]; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean; "sort_by"?: string; "sort_direction"?: string }): Promise<any> {
    return this._request("GET", "/v2/crm_users.json", { params });
  }

  /** List custom fields */
  getv2CustomFieldsJson(params: { "ids"?: unknown[]; "field_type"?: string; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/custom_fields.json", { params });
  }

  /** Create a custom field */
  postv2CustomFieldsJson(): Promise<any> {
    return this._request("POST", "/v2/custom_fields.json", {  });
  }

  /** Fetch a custom field */
  getv2CustomFieldsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/custom_fields/{id}.json", { params });
  }

  /** Update a custom field */
  putv2CustomFieldsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/custom_fields/{id}.json", { params });
  }

  /** Delete a custom field */
  deletev2CustomFieldsIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/custom_fields/{id}.json", { params });
  }

  /** List email template attachments */
  getv2EmailTemplateAttachmentsJson(params: { "ids"?: unknown[]; "email_template_id"?: unknown[]; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/email_template_attachments.json", { params });
  }

  /** List email templates */
  getv2EmailTemplatesJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "linked_to_team_template"?: boolean; "search"?: string; "tag_ids"?: unknown[]; "tag"?: unknown[]; "filter_by_owner"?: boolean; "group_id"?: unknown[]; "include_cadence_templates"?: boolean; "include_archived_templates"?: boolean; "cadence_id"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/email_templates.json", { params });
  }

  /** Fetch an email template */
  getv2EmailTemplatesIdJson(params: { "id": string; "include_signature"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/email_templates/{id}.json", { params });
  }

  /** Create an External Email */
  postv2ExternalEmailsJson(): Promise<any> {
    return this._request("POST", "/v2/external_emails.json", {  });
  }

  /** List groups */
  getv2GroupsJson(params: { "ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string }): Promise<any> {
    return this._request("GET", "/v2/groups.json", { params });
  }

  /** Fetch a group */
  getv2GroupsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/groups/{id}.json", { params });
  }

  /** List imports */
  getv2ImportsJson(params: { "ids"?: unknown[]; "user_ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/imports.json", { params });
  }

  /** Create an import */
  postv2ImportsJson(): Promise<any> {
    return this._request("POST", "/v2/imports.json", {  });
  }

  /** Fetch an import */
  getv2ImportsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/imports/{id}.json", { params });
  }

  /** Update an import */
  putv2ImportsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/imports/{id}.json", { params });
  }

  /** Delete an import */
  deletev2ImportsIdJson(params: { "id": string; "undo"?: string }): Promise<any> {
    return this._request("DELETE", "/v2/imports/{id}.json", { params });
  }

  /** Create an Live Website Tracking Parameter */
  postv2LiveWebsiteTrackingParametersJson(): Promise<any> {
    return this._request("POST", "/v2/live_website_tracking_parameters.json", {  });
  }

  /** Fetch current user */
  getv2MeJson(): Promise<any> {
    return this._request("GET", "/v2/me.json", {});
  }

  /** List meetings */
  getv2MeetingsJson(params: { "ids"?: unknown[]; "status"?: string; "person_id"?: string; "account_id"?: string; "person_ids"?: unknown[]; "event_ids"?: unknown[]; "i_cal_uids"?: unknown[]; "task_ids"?: unknown[]; "include_meetings_settings"?: boolean; "start_time"?: unknown[]; "user_guids"?: unknown[]; "show_deleted"?: boolean; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/meetings.json", { params });
  }

  /** List meeting settings */
  postv2MeetingsSettingsSearchesJson(params: { "user_guids"?: unknown[]; "updated_at"?: unknown[]; "calendar_type"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("POST", "/v2/meetings/settings/searches.json", { params });
  }

  /** Update a meeting setting */
  putv2MeetingsSettingsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/meetings/settings/{id}.json", { params });
  }

  /** Update a meeting */
  putv2MeetingsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/meetings/{id}.json", { params });
  }

  /** Fetch the MIME content for email */
  getv2MimeEmailPayloadsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/mime_email_payloads/{id}.json", { params });
  }

  /** List notes */
  getv2NotesJson(params: { "associated_with_type"?: string; "associated_with_id"?: number; "updated_at"?: unknown[]; "ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/notes.json", { params });
  }

  /** Create a note */
  postv2NotesJson(): Promise<any> {
    return this._request("POST", "/v2/notes.json", {  });
  }

  /** Fetch a note */
  getv2NotesIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/notes/{id}.json", { params });
  }

  /** Update a note */
  putv2NotesIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/notes/{id}.json", { params });
  }

  /** Delete a note */
  deletev2NotesIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/notes/{id}.json", { params });
  }

  /** Create an ongoing action */
  postv2OngoingActionsJson(): Promise<any> {
    return this._request("POST", "/v2/ongoing_actions.json", {  });
  }

  /** Fetches a list of emails ready to be sent by an external email service. Only emails sent with an External Email Client will appear here. */
  getv2PendingEmailsJson(params: { "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/pending_emails.json", { params });
  }

  /** Updates the status of an email sent by an External Email Client */
  putv2PendingEmailsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/pending_emails/{id}.json", { params });
  }

  /** List people */
  getv2PeopleJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "email_addresses"?: unknown[]; "owned_by_guid"?: unknown[]; "person_stage_id"?: unknown[]; "crm_id"?: unknown[]; "owner_crm_id"?: unknown[]; "do_not_contact"?: boolean; "can_email"?: boolean; "can_call"?: boolean; "can_text"?: boolean; "account_id"?: unknown[]; "custom_fields"?: string; "import_id"?: unknown[]; "job_seniority"?: unknown[]; "tag_id"?: unknown[]; "owner_is_active"?: boolean; "cadence_id"?: unknown[]; "starred_by_guid"?: unknown[]; "replied"?: boolean; "bounced"?: boolean; "success"?: boolean; "eu_resident"?: boolean; "title"?: unknown[]; "country"?: unknown[]; "state"?: unknown[]; "city"?: unknown[]; "last_contacted"?: string; "created_at"?: string; "new"?: boolean; "phone_number"?: boolean; "locales"?: unknown[]; "owner_id"?: unknown[]; "_query"?: string; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/people.json", { params });
  }

  /** Create a person */
  postv2PeopleJson(): Promise<any> {
    return this._request("POST", "/v2/people.json", {  });
  }

  /** Fetch a person */
  getv2PeopleIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/people/{id}.json", { params });
  }

  /** Update a person */
  putv2PeopleIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/people/{id}.json", { params });
  }

  /** Delete a person */
  deletev2PeopleIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/people/{id}.json", { params });
  }

  /** List person stages */
  getv2PersonStagesJson(params: { "ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/person_stages.json", { params });
  }

  /** Create a person stage */
  postv2PersonStagesJson(): Promise<any> {
    return this._request("POST", "/v2/person_stages.json", {  });
  }

  /** Fetch a person stage */
  getv2PersonStagesIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/person_stages/{id}.json", { params });
  }

  /** Update a person stage */
  putv2PersonStagesIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/person_stages/{id}.json", { params });
  }

  /** Delete an person stage */
  deletev2PersonStagesIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/person_stages/{id}.json", { params });
  }

  /** Upsert a person */
  postv2PersonUpsertsJson(): Promise<any> {
    return this._request("POST", "/v2/person_upserts.json", {  });
  }

  /** List phone number assignments */
  getv2PhoneNumberAssignmentsJson(params: { "ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/phone_number_assignments.json", { params });
  }

  /** Fetch a phone number assignment */
  getv2PhoneNumberAssignmentsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/phone_number_assignments/{id}.json", { params });
  }

  /** List caller ids */
  getv2PhoneNumbersCallerIdsJson(params: { "phone_number": string }): Promise<any> {
    return this._request("GET", "/v2/phone_numbers/caller_ids.json", { params });
  }

  /** Fetch recording setting */
  getv2PhoneNumbersRecordingSettingsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/phone_numbers/recording_settings/{id}.json", { params });
  }

  /** List saved list views */
  getv2SavedListViewsJson(params: { "ids"?: unknown[]; "view"?: string; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/saved_list_views.json", { params });
  }

  /** Create a saved list view */
  postv2SavedListViewsJson(): Promise<any> {
    return this._request("POST", "/v2/saved_list_views.json", {  });
  }

  /** Fetch a saved list view */
  getv2SavedListViewsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/saved_list_views/{id}.json", { params });
  }

  /** Update a saved list view */
  putv2SavedListViewsIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/saved_list_views/{id}.json", { params });
  }

  /** Delete a saved list view */
  deletev2SavedListViewsIdJson(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/v2/saved_list_views/{id}.json", { params });
  }

  /** List steps */
  getv2StepsJson(params: { "ids"?: unknown[]; "cadence_id"?: number; "type"?: string; "has_due_actions"?: boolean; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/steps.json", { params });
  }

  /** Fetch a step */
  getv2StepsIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/steps/{id}.json", { params });
  }

  /** List successes */
  getv2SuccessesJson(params: { "ids"?: unknown[]; "person_id"?: unknown[]; "updated_at"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/successes.json", { params });
  }

  /** List team tags */
  getv2TagsJson(params: { "search"?: string; "ids"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/tags.json", { params });
  }

  /** List tasks */
  getv2TasksJson(params: { "ids"?: unknown[]; "user_id"?: unknown[]; "person_id"?: unknown[]; "account_id"?: unknown[]; "current_state"?: unknown[]; "task_type"?: unknown[]; "time_interval_filter"?: string; "idempotency_key"?: string; "locale"?: unknown[]; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/tasks.json", { params });
  }

  /** Create a Task */
  postv2TasksJson(): Promise<any> {
    return this._request("POST", "/v2/tasks.json", {  });
  }

  /** Fetch a task */
  getv2TasksIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/tasks/{id}.json", { params });
  }

  /** Update a Task */
  putv2TasksIdJson(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/v2/tasks/{id}.json", { params });
  }

  /** Fetch current team */
  getv2TeamJson(): Promise<any> {
    return this._request("GET", "/v2/team.json", {});
  }

  /** List team template attachments */
  getv2TeamTemplateAttachmentsJson(params: { "ids"?: unknown[]; "team_template_id"?: unknown[]; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/team_template_attachments.json", { params });
  }

  /** List team templates */
  getv2TeamTemplatesJson(params: { "ids"?: unknown[]; "updated_at"?: unknown[]; "search"?: string; "tag_ids"?: unknown[]; "tag"?: unknown[]; "include_archived_templates"?: boolean; "sort_by"?: string; "sort_direction"?: string; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "limit_paging_counts"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/team_templates.json", { params });
  }

  /** Fetch a team template */
  getv2TeamTemplatesIdJson(params: { "id": string; "include_signature"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/team_templates/{id}.json", { params });
  }

  /** Create a live feed item */
  postv2ThirdPartyLiveFeedItems(): Promise<any> {
    return this._request("POST", "/v2/third_party_live_feed_items", {  });
  }

  /** List users */
  getv2UsersJson(params: { "ids"?: unknown[]; "guid"?: unknown[]; "group_id"?: unknown[]; "role_id"?: unknown[]; "search"?: string; "active"?: boolean; "visible_only"?: boolean; "per_page"?: number; "page"?: number; "include_paging_counts"?: boolean; "has_crm_user"?: boolean; "work_country"?: unknown[]; "sort_by"?: string; "sort_direction"?: string }): Promise<any> {
    return this._request("GET", "/v2/users.json", { params });
  }

  /** Fetch a user */
  getv2UsersIdJson(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v2/users/{id}.json", { params });
  }

  /** List webhook subscriptions */
  getv2WebhookSubscriptions(params: { "enabled"?: boolean }): Promise<any> {
    return this._request("GET", "/v2/webhook_subscriptions", { params });
  }

  /** Create a webhook subscription */
  postv2WebhookSubscriptions(): Promise<any> {
    return this._request("POST", "/v2/webhook_subscriptions", {  });
  }

  /** Fetch a webhook subscription */
  getv2WebhookSubscriptionsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v2/webhook_subscriptions/{id}", { params });
  }

  /** Update a webhook subscription */
  putv2WebhookSubscriptionsId(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v2/webhook_subscriptions/{id}", { params });
  }

  /** Delete a webhook subscription */
  deletev2WebhookSubscriptionsId(params: { "id": number }): Promise<any> {
    return this._request("DELETE", "/v2/webhook_subscriptions/{id}", { params });
  }
}

export default SalesLoftPlatform;