intercom-client 6.0.0-beta.3 → 6.0.0

package/src/resources/admins/activity-logs.ts

@@ -1,269 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as ActivityLogsAPI from './activity-logs';
-import * as Shared from '../shared';
-
-export class ActivityLogs extends APIResource {
-  /**
-   * You can get a log of activities by all admins in an app.
-   */
-  list(params: ActivityLogListParams, options?: Core.RequestOptions): Core.APIPromise<ActivityLogList> {
-    const { 'Intercom-Version': intercomVersion, ...query } = params;
-    return this._client.get('/admins/activity_logs', {
-      query,
-      ...options,
-      headers: {
-        ...(intercomVersion?.toString() != null ?
-          { 'Intercom-Version': intercomVersion?.toString() }
-        : undefined),
-        ...options?.headers,
-      },
-    });
-  }
-}
-
-/**
- * A paginated list of activity logs.
- */
-export interface ActivityLogList {
-  /**
-   * An array of activity logs
-   */
-  activity_logs?: Array<ActivityLogList.ActivityLog | null>;
-
-  /**
-   * Cursor-based pagination is a technique used in the Intercom API to navigate
-   * through large amounts of data. A "cursor" or pointer is used to keep track of
-   * the current position in the result set, allowing the API to return the data in
-   * small chunks or "pages" as needed.
-   */
-  pages?: Shared.CursorPages | null;
-
-  /**
-   * String representing the object's type. Always has the value `activity_log.list`.
-   */
-  type?: string;
-}
-
-export namespace ActivityLogList {
-  /**
-   * Activities performed by Admins.
-   */
-  export interface ActivityLog {
-    /**
-     * The id representing the activity.
-     */
-    id?: string;
-
-    /**
-     * A sentence or two describing the activity.
-     */
-    activity_description?: string;
-
-    activity_type?:
-      | 'admin_assignment_limit_change'
-      | 'admin_away_mode_change'
-      | 'admin_deletion'
-      | 'admin_deprovisioned'
-      | 'admin_impersonation_end'
-      | 'admin_impersonation_start'
-      | 'admin_invite_change'
-      | 'admin_invite_creation'
-      | 'admin_invite_deletion'
-      | 'admin_login_failure'
-      | 'admin_login_success'
-      | 'admin_logout'
-      | 'admin_password_reset_request'
-      | 'admin_password_reset_success'
-      | 'admin_permission_change'
-      | 'admin_provisioned'
-      | 'admin_two_factor_auth_change'
-      | 'admin_unauthorized_sign_in_method'
-      | 'app_admin_join'
-      | 'app_authentication_method_change'
-      | 'app_data_deletion'
-      | 'app_data_export'
-      | 'app_google_sso_domain_change'
-      | 'app_identity_verification_change'
-      | 'app_name_change'
-      | 'app_outbound_address_change'
-      | 'app_package_installation'
-      | 'app_package_token_regeneration'
-      | 'app_package_uninstallation'
-      | 'app_team_creation'
-      | 'app_team_deletion'
-      | 'app_team_membership_modification'
-      | 'app_timezone_change'
-      | 'app_webhook_creation'
-      | 'app_webhook_deletion'
-      | 'articles_in_messenger_enabled_change'
-      | 'bulk_delete'
-      | 'bulk_export'
-      | 'campaign_deletion'
-      | 'campaign_state_change'
-      | 'conversation_part_deletion'
-      | 'conversation_topic_change'
-      | 'conversation_topic_creation'
-      | 'conversation_topic_deletion'
-      | 'help_center_settings_change'
-      | 'inbound_conversations_change'
-      | 'inbox_access_change'
-      | 'message_deletion'
-      | 'message_state_change'
-      | 'messenger_look_and_feel_change'
-      | 'messenger_search_required_change'
-      | 'messenger_spaces_change'
-      | 'office_hours_change'
-      | 'role_change'
-      | 'role_creation'
-      | 'role_deletion'
-      | 'ruleset_activation_title_preview'
-      | 'ruleset_creation'
-      | 'ruleset_deletion'
-      | 'search_browse_enabled_change'
-      | 'search_browse_required_change'
-      | 'seat_change'
-      | 'seat_revoke'
-      | 'security_settings_change'
-      | 'temporary_expectation_change'
-      | 'upfront_email_collection_change'
-      | 'welcome_message_change';
-
-    /**
-     * The time the activity was created.
-     */
-    created_at?: number;
-
-    /**
-     * Additional data provided about Admin activity.
-     */
-    metadata?: ActivityLog.Metadata | null;
-
-    /**
-     * Details about the Admin involved in the activity.
-     */
-    performed_by?: ActivityLog.PerformedBy;
-  }
-
-  export namespace ActivityLog {
-    /**
-     * Additional data provided about Admin activity.
-     */
-    export interface Metadata {
-      /**
-       * Indicates if the status was changed automatically or manually.
-       */
-      auto_changed?: string | null;
-
-      /**
-       * The away mode status which is set to true when away and false when returned.
-       */
-      away_mode?: boolean | null;
-
-      /**
-       * The reason the Admin is away.
-       */
-      away_status_reason?: string | null;
-
-      /**
-       * The unique identifier for the contact which is provided by the Client.
-       */
-      external_id?: string | null;
-
-      /**
-       * Indicates if conversations should be reassigned while an Admin is away.
-       */
-      reassign_conversations?: boolean | null;
-
-      /**
-       * The way the admin signed in.
-       */
-      sign_in_method?: string | null;
-
-      /**
-       * The action that initiated the status change.
-       */
-      source?: string | null;
-
-      /**
-       * The ID of the Admin who initiated the activity.
-       */
-      update_by?: number | null;
-
-      /**
-       * The name of the Admin who initiated the activity.
-       */
-      update_by_name?: string | null;
-    }
-
-    /**
-     * Details about the Admin involved in the activity.
-     */
-    export interface PerformedBy {
-      /**
-       * The id representing the admin.
-       */
-      id?: string;
-
-      /**
-       * The email of the admin.
-       */
-      email?: string;
-
-      /**
-       * The IP address of the admin.
-       */
-      ip?: string;
-
-      /**
-       * String representing the object's type. Always has the value `admin`.
-       */
-      type?: string;
-    }
-  }
-}
-
-export interface ActivityLogListParams {
-  /**
-   * Query param: The start date that you request data for. It must be formatted as a
-   * UNIX timestamp.
-   */
-  created_at_after: string;
-
-  /**
-   * Query param: The end date that you request data for. It must be formatted as a
-   * UNIX timestamp.
-   */
-  created_at_before?: string;
-
-  /**
-   * Header param: Intercom API version.By default, it's equal to the version set in
-   * the app package.
-   */
-  'Intercom-Version'?:
-    | '1.0'
-    | '1.1'
-    | '1.2'
-    | '1.3'
-    | '1.4'
-    | '2.0'
-    | '2.1'
-    | '2.2'
-    | '2.3'
-    | '2.4'
-    | '2.5'
-    | '2.6'
-    | '2.7'
-    | '2.8'
-    | '2.9'
-    | '2.10'
-    | '2.11'
-    | 'Unstable';
-}
-
-export namespace ActivityLogs {
-  export import ActivityLogList = ActivityLogsAPI.ActivityLogList;
-  export import ActivityLogListParams = ActivityLogsAPI.ActivityLogListParams;
-}

package/src/resources/admins/admins.ts

@@ -1,200 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as AdminsAPI from './admins';
-import * as Shared from '../shared';
-import * as ActivityLogsAPI from './activity-logs';
-
-export class Admins extends APIResource {
-  activityLogs: ActivityLogsAPI.ActivityLogs = new ActivityLogsAPI.ActivityLogs(this._client);
-
-  /**
-   * You can retrieve the details of a single admin.
-   */
-  retrieve(
-    id: number,
-    params?: AdminRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Shared.Admin | null>;
-  retrieve(id: number, options?: Core.RequestOptions): Core.APIPromise<Shared.Admin | null>;
-  retrieve(
-    id: number,
-    params: AdminRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Shared.Admin | null> {
-    if (isRequestOptions(params)) {
-      return this.retrieve(id, {}, params);
-    }
-    const { 'Intercom-Version': intercomVersion } = params;
-    return this._client.get(`/admins/${id}`, {
-      ...options,
-      headers: {
-        ...(intercomVersion?.toString() != null ?
-          { 'Intercom-Version': intercomVersion?.toString() }
-        : undefined),
-        ...options?.headers,
-      },
-    });
-  }
-
-  /**
-   * You can fetch a list of admins for a given workspace.
-   */
-  list(params?: AdminListParams, options?: Core.RequestOptions): Core.APIPromise<AdminList>;
-  list(options?: Core.RequestOptions): Core.APIPromise<AdminList>;
-  list(
-    params: AdminListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AdminList> {
-    if (isRequestOptions(params)) {
-      return this.list({}, params);
-    }
-    const { 'Intercom-Version': intercomVersion } = params;
-    return this._client.get('/admins', {
-      ...options,
-      headers: {
-        ...(intercomVersion?.toString() != null ?
-          { 'Intercom-Version': intercomVersion?.toString() }
-        : undefined),
-        ...options?.headers,
-      },
-    });
-  }
-
-  /**
-   * You can set an Admin as away for the Inbox.
-   */
-  setAway(
-    id: number,
-    params: AdminSetAwayParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Shared.Admin | null> {
-    const { 'Intercom-Version': intercomVersion, ...body } = params;
-    return this._client.put(`/admins/${id}/away`, {
-      body,
-      ...options,
-      headers: {
-        ...(intercomVersion?.toString() != null ?
-          { 'Intercom-Version': intercomVersion?.toString() }
-        : undefined),
-        ...options?.headers,
-      },
-    });
-  }
-}
-
-/**
- * A list of admins associated with a given workspace.
- */
-export interface AdminList {
-  /**
-   * A list of admins associated with a given workspace.
-   */
-  admins?: Array<Shared.Admin | null>;
-
-  /**
-   * String representing the object's type. Always has the value `admin.list`.
-   */
-  type?: string;
-}
-
-export interface AdminRetrieveParams {
-  /**
-   * Intercom API version.By default, it's equal to the version set in the app
-   * package.
-   */
-  'Intercom-Version'?:
-    | '1.0'
-    | '1.1'
-    | '1.2'
-    | '1.3'
-    | '1.4'
-    | '2.0'
-    | '2.1'
-    | '2.2'
-    | '2.3'
-    | '2.4'
-    | '2.5'
-    | '2.6'
-    | '2.7'
-    | '2.8'
-    | '2.9'
-    | '2.10'
-    | '2.11'
-    | 'Unstable';
-}
-
-export interface AdminListParams {
-  /**
-   * Intercom API version.By default, it's equal to the version set in the app
-   * package.
-   */
-  'Intercom-Version'?:
-    | '1.0'
-    | '1.1'
-    | '1.2'
-    | '1.3'
-    | '1.4'
-    | '2.0'
-    | '2.1'
-    | '2.2'
-    | '2.3'
-    | '2.4'
-    | '2.5'
-    | '2.6'
-    | '2.7'
-    | '2.8'
-    | '2.9'
-    | '2.10'
-    | '2.11'
-    | 'Unstable';
-}
-
-export interface AdminSetAwayParams {
-  /**
-   * Body param: Set to "true" to change the status of the admin to away.
-   */
-  away_mode_enabled: boolean;
-
-  /**
-   * Body param: Set to "true" to assign any new conversation replies to your default
-   * inbox.
-   */
-  away_mode_reassign: boolean;
-
-  /**
-   * Header param: Intercom API version.By default, it's equal to the version set in
-   * the app package.
-   */
-  'Intercom-Version'?:
-    | '1.0'
-    | '1.1'
-    | '1.2'
-    | '1.3'
-    | '1.4'
-    | '2.0'
-    | '2.1'
-    | '2.2'
-    | '2.3'
-    | '2.4'
-    | '2.5'
-    | '2.6'
-    | '2.7'
-    | '2.8'
-    | '2.9'
-    | '2.10'
-    | '2.11'
-    | 'Unstable';
-}
-
-export namespace Admins {
-  export import AdminList = AdminsAPI.AdminList;
-  export import AdminRetrieveParams = AdminsAPI.AdminRetrieveParams;
-  export import AdminListParams = AdminsAPI.AdminListParams;
-  export import AdminSetAwayParams = AdminsAPI.AdminSetAwayParams;
-  export import ActivityLogs = ActivityLogsAPI.ActivityLogs;
-  export import ActivityLogList = ActivityLogsAPI.ActivityLogList;
-  export import ActivityLogListParams = ActivityLogsAPI.ActivityLogListParams;
-}

package/src/resources/admins/index.ts

@@ -1,4 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export { ActivityLogList, ActivityLogListParams, ActivityLogs } from './activity-logs';
-export { AdminList, AdminRetrieveParams, AdminListParams, AdminSetAwayParams, Admins } from './admins';