@knocklabs/node 0.6.19 → 1.0.0

package/src/resources/tenants/tenants.ts

@@ -0,0 +1,300 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ChannelDataAPI from '../recipients/channel-data';
+import * as PreferencesAPI from '../recipients/preferences';
+import * as BulkAPI from './bulk';
+import { Bulk, BulkDeleteParams, BulkSetParams } from './bulk';
+import { APIPromise } from '../../core/api-promise';
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Tenants extends APIResource {
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+
+  /**
+   * List tenants for the current environment.
+   */
+  list(
+    query: TenantListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TenantsEntriesCursor, Tenant> {
+    return this._client.getAPIList('/v1/tenants', EntriesCursor<Tenant>, { query, ...options });
+  }
+
+  /**
+   * Delete a tenant and all associated data. This operation cannot be undone.
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<string> {
+    return this._client.delete(path`/v1/tenants/${id}`, options);
+  }
+
+  /**
+   * Get a tenant by ID.
+   */
+  get(id: string, options?: RequestOptions): APIPromise<Tenant> {
+    return this._client.get(path`/v1/tenants/${id}`, options);
+  }
+
+  /**
+   * Sets a tenant within an environment, performing an upsert operation. Any
+   * existing properties will be merged with the incoming properties.
+   */
+  set(id: string, body: TenantSetParams, options?: RequestOptions): APIPromise<Tenant> {
+    return this._client.put(path`/v1/tenants/${id}`, { body, ...options });
+  }
+}
+
+export type TenantsEntriesCursor = EntriesCursor<Tenant>;
+
+/**
+ * An request to set a tenant inline.
+ */
+export type InlineTenantRequest = string | TenantRequest;
+
+/**
+ * A tenant entity.
+ */
+export interface Tenant {
+  /**
+   * The unique identifier for the tenant.
+   */
+  id: string;
+
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * An optional name for the tenant.
+   */
+  name?: string | null;
+
+  /**
+   * The settings for the tenant. Includes branding and preference set.
+   */
+  settings?: Tenant.Settings | null;
+
+  [k: string]: unknown;
+}
+
+export namespace Tenant {
+  /**
+   * The settings for the tenant. Includes branding and preference set.
+   */
+  export interface Settings {
+    /**
+     * The branding for the tenant.
+     */
+    branding?: Settings.Branding | null;
+
+    /**
+     * A preference set represents a specific set of notification preferences for a
+     * recipient. A recipient can have multiple preference sets.
+     */
+    preference_set?: PreferencesAPI.PreferenceSet | null;
+  }
+
+  export namespace Settings {
+    /**
+     * The branding for the tenant.
+     */
+    export interface Branding {
+      /**
+       * The icon URL for the tenant. Must point to a valid image with an image MIME
+       * type.
+       */
+      icon_url?: string | null;
+
+      /**
+       * The logo URL for the tenant. Must point to a valid image with an image MIME
+       * type.
+       */
+      logo_url?: string | null;
+
+      /**
+       * The primary color for the tenant, provided as a hex value.
+       */
+      primary_color?: string | null;
+
+      /**
+       * The primary color contrast for the tenant, provided as a hex value.
+       */
+      primary_color_contrast?: string | null;
+    }
+  }
+}
+
+/**
+ * A tenant to be set in the system. You can supply any additional properties on
+ * the tenant object.
+ */
+export interface TenantRequest {
+  /**
+   * The unique identifier for the tenant.
+   */
+  id: string;
+
+  /**
+   * A request to set channel data for a type of channel inline.
+   */
+  channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
+
+  /**
+   * Inline set preferences for a recipient, where the key is the preference set id.
+   */
+  preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
+
+  /**
+   * The settings for the tenant. Includes branding and preference set.
+   */
+  settings?: TenantRequest.Settings;
+
+  [k: string]: unknown;
+}
+
+export namespace TenantRequest {
+  /**
+   * The settings for the tenant. Includes branding and preference set.
+   */
+  export interface Settings {
+    /**
+     * The branding for the tenant.
+     */
+    branding?: Settings.Branding;
+
+    /**
+     * A request to set a preference set for a recipient.
+     */
+    preference_set?: PreferencesAPI.PreferenceSetRequest | null;
+  }
+
+  export namespace Settings {
+    /**
+     * The branding for the tenant.
+     */
+    export interface Branding {
+      /**
+       * The icon URL for the tenant. Must point to a valid image with an image MIME
+       * type.
+       */
+      icon_url?: string | null;
+
+      /**
+       * The logo URL for the tenant. Must point to a valid image with an image MIME
+       * type.
+       */
+      logo_url?: string | null;
+
+      /**
+       * The primary color for the tenant, provided as a hex value.
+       */
+      primary_color?: string | null;
+
+      /**
+       * The primary color contrast for the tenant, provided as a hex value.
+       */
+      primary_color_contrast?: string | null;
+    }
+  }
+}
+
+/**
+ * A `204 No Content` response.
+ */
+export type TenantDeleteResponse = string;
+
+export interface TenantListParams extends EntriesCursorParams {
+  /**
+   * Filter tenants by name.
+   */
+  name?: string;
+
+  /**
+   * Filter tenants by ID.
+   */
+  tenant_id?: string;
+}
+
+export interface TenantSetParams {
+  /**
+   * A request to set channel data for a type of channel inline.
+   */
+  channel_data?: ChannelDataAPI.InlineChannelDataRequest | null;
+
+  /**
+   * Inline set preferences for a recipient, where the key is the preference set id.
+   */
+  preferences?: PreferencesAPI.InlinePreferenceSetRequest | null;
+
+  /**
+   * The settings for the tenant. Includes branding and preference set.
+   */
+  settings?: TenantSetParams.Settings;
+
+  [k: string]: unknown;
+}
+
+export namespace TenantSetParams {
+  /**
+   * The settings for the tenant. Includes branding and preference set.
+   */
+  export interface Settings {
+    /**
+     * The branding for the tenant.
+     */
+    branding?: Settings.Branding;
+
+    /**
+     * A request to set a preference set for a recipient.
+     */
+    preference_set?: PreferencesAPI.PreferenceSetRequest | null;
+  }
+
+  export namespace Settings {
+    /**
+     * The branding for the tenant.
+     */
+    export interface Branding {
+      /**
+       * The icon URL for the tenant. Must point to a valid image with an image MIME
+       * type.
+       */
+      icon_url?: string | null;
+
+      /**
+       * The logo URL for the tenant. Must point to a valid image with an image MIME
+       * type.
+       */
+      logo_url?: string | null;
+
+      /**
+       * The primary color for the tenant, provided as a hex value.
+       */
+      primary_color?: string | null;
+
+      /**
+       * The primary color contrast for the tenant, provided as a hex value.
+       */
+      primary_color_contrast?: string | null;
+    }
+  }
+}
+
+Tenants.Bulk = Bulk;
+
+export declare namespace Tenants {
+  export {
+    type InlineTenantRequest as InlineTenantRequest,
+    type Tenant as Tenant,
+    type TenantRequest as TenantRequest,
+    type TenantDeleteResponse as TenantDeleteResponse,
+    type TenantsEntriesCursor as TenantsEntriesCursor,
+    type TenantListParams as TenantListParams,
+    type TenantSetParams as TenantSetParams,
+  };
+
+  export { Bulk as Bulk, type BulkDeleteParams as BulkDeleteParams, type BulkSetParams as BulkSetParams };
+}

package/src/resources/tenants.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './tenants/index';

package/src/resources/users/bulk.ts

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BulkOperationsAPI from '../bulk-operations';
+import * as PreferencesAPI from '../recipients/preferences';
+import * as UsersAPI from './users';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Bulk extends APIResource {
+  /**
+   * Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+   * delete and returns a bulk operation that can be queried for progress.
+   */
+  delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation> {
+    return this._client.post('/v1/users/bulk/delete', { body, ...options });
+  }
+
+  /**
+   * Identifies multiple users in a single operation. Allows creating or updating up
+   * to 100 users in a single batch with various properties, preferences, and channel
+   * data.
+   */
+  identify(body: BulkIdentifyParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation> {
+    return this._client.post('/v1/users/bulk/identify', { body, ...options });
+  }
+
+  /**
+   * Sets preferences for multiple users in a single operation. Supports either
+   * setting the same preferences for multiple users or specific preferences for each
+   * user.
+   */
+  setPreferences(
+    body: BulkSetPreferencesParams,
+    options?: RequestOptions,
+  ): APIPromise<BulkOperationsAPI.BulkOperation> {
+    return this._client.post('/v1/users/bulk/preferences', { body, ...options });
+  }
+}
+
+export interface BulkDeleteParams {
+  /**
+   * A list of user IDs.
+   */
+  user_ids: Array<string>;
+}
+
+export interface BulkIdentifyParams {
+  /**
+   * A list of users.
+   */
+  users: Array<UsersAPI.InlineIdentifyUserRequest>;
+}
+
+export interface BulkSetPreferencesParams {
+  /**
+   * A request to set a preference set for a recipient.
+   */
+  preferences: PreferencesAPI.PreferenceSetRequest;
+
+  /**
+   * A list of user IDs.
+   */
+  user_ids: Array<string>;
+}
+
+export declare namespace Bulk {
+  export {
+    type BulkDeleteParams as BulkDeleteParams,
+    type BulkIdentifyParams as BulkIdentifyParams,
+    type BulkSetPreferencesParams as BulkSetPreferencesParams,
+  };
+}

package/src/resources/users/feeds.ts

@@ -0,0 +1,296 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MessagesAPI from '../messages/messages';
+import * as RecipientsAPI from '../recipients/recipients';
+import { APIPromise } from '../../core/api-promise';
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Feeds extends APIResource {
+  /**
+   * Returns the feed settings for a user.
+   */
+  getSettings(userID: string, id: string, options?: RequestOptions): APIPromise<FeedGetSettingsResponse> {
+    return this._client.get(path`/v1/users/${userID}/feeds/${id}/settings`, options);
+  }
+
+  /**
+   * Returns a paginated list of feed items for a user, including metadata about the
+   * feed.
+   */
+  listItems(
+    userID: string,
+    id: string,
+    query: FeedListItemsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FeedListItemsResponsesEntriesCursor, FeedListItemsResponse> {
+    return this._client.getAPIList(
+      path`/v1/users/${userID}/feeds/${id}`,
+      EntriesCursor<FeedListItemsResponse>,
+      { query, ...options },
+    );
+  }
+}
+
+export type FeedListItemsResponsesEntriesCursor = EntriesCursor<FeedListItemsResponse>;
+
+/**
+ * The response for the user's feed settings.
+ */
+export interface FeedGetSettingsResponse {
+  /**
+   * Features configuration for the user's feed.
+   */
+  features: FeedGetSettingsResponse.Features;
+}
+
+export namespace FeedGetSettingsResponse {
+  /**
+   * Features configuration for the user's feed.
+   */
+  export interface Features {
+    /**
+     * Whether branding is required for the user's feed.
+     */
+    branding_required: boolean;
+  }
+}
+
+/**
+ * An in-app feed message in a user's feed.
+ */
+export interface FeedListItemsResponse {
+  /**
+   * Unique identifier for the feed.
+   */
+  id: string;
+
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * List of activities associated with this feed item.
+   */
+  activities: Array<MessagesAPI.Activity>;
+
+  /**
+   * List of actors associated with this feed item.
+   */
+  actors: Array<RecipientsAPI.Recipient>;
+
+  /**
+   * Content blocks that make up the feed item.
+   */
+  blocks: Array<
+    FeedListItemsResponse.MessageInAppFeedContentBlock | FeedListItemsResponse.MessageInAppFeedButtonSetBlock
+  >;
+
+  /**
+   * Additional data associated with the feed item.
+   */
+  data: Record<string, unknown> | null;
+
+  /**
+   * Timestamp when the resource was created.
+   */
+  inserted_at: string;
+
+  /**
+   * Source information for the feed item.
+   */
+  source: FeedListItemsResponse.Source;
+
+  /**
+   * Tenant ID that the feed item belongs to.
+   */
+  tenant: string | null;
+
+  /**
+   * Total number of activities related to this feed item.
+   */
+  total_activities: number;
+
+  /**
+   * Total number of actors related to this feed item.
+   */
+  total_actors: number;
+
+  /**
+   * The timestamp when the resource was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * Timestamp when the feed item was archived.
+   */
+  archived_at?: string | null;
+
+  /**
+   * Timestamp when the feed item was clicked.
+   */
+  clicked_at?: string | null;
+
+  /**
+   * Timestamp when the feed item was interacted with.
+   */
+  interacted_at?: string | null;
+
+  /**
+   * Timestamp when a link within the feed item was clicked.
+   */
+  link_clicked_at?: string | null;
+
+  /**
+   * Timestamp when the feed item was marked as read.
+   */
+  read_at?: string | null;
+
+  /**
+   * Timestamp when the feed item was marked as seen.
+   */
+  seen_at?: string | null;
+}
+
+export namespace FeedListItemsResponse {
+  /**
+   * A block in a message in an app feed.
+   */
+  export interface MessageInAppFeedContentBlock {
+    /**
+     * The content of the block in a message in an app feed.
+     */
+    content: string;
+
+    /**
+     * The name of the block in a message in an app feed.
+     */
+    name: string;
+
+    /**
+     * The rendered HTML version of the content.
+     */
+    rendered: string;
+
+    /**
+     * The type of block in a message in an app feed.
+     */
+    type: 'markdown' | 'text';
+  }
+
+  /**
+   * A button set block in a message in an app feed.
+   */
+  export interface MessageInAppFeedButtonSetBlock {
+    /**
+     * A list of buttons in an in app feed message.
+     */
+    buttons: Array<MessageInAppFeedButtonSetBlock.Button>;
+
+    /**
+     * The name of the button set in a message in an app feed.
+     */
+    name: string;
+
+    /**
+     * The type of block in a message in an app feed.
+     */
+    type: 'button_set';
+  }
+
+  export namespace MessageInAppFeedButtonSetBlock {
+    /**
+     * A button in an in app feed message.
+     */
+    export interface Button {
+      /**
+       * The action to take when the button is clicked.
+       */
+      action: string;
+
+      /**
+       * The label of the button.
+       */
+      label: string;
+
+      /**
+       * The name of the button.
+       */
+      name: string;
+    }
+  }
+
+  /**
+   * Source information for the feed item.
+   */
+  export interface Source {
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+
+    /**
+     * Categories this workflow belongs to.
+     */
+    categories: Array<string>;
+
+    /**
+     * The key of the workflow.
+     */
+    key: string;
+
+    /**
+     * The workflow version ID.
+     */
+    version_id: string;
+  }
+}
+
+export interface FeedListItemsParams extends EntriesCursorParams {
+  /**
+   * The archived status of the feed items.
+   */
+  archived?: 'exclude' | 'include' | 'only';
+
+  /**
+   * Whether the feed items have a tenant.
+   */
+  has_tenant?: boolean;
+
+  /**
+   * The source of the feed items.
+   */
+  source?: string;
+
+  /**
+   * The status of the feed items.
+   */
+  status?: 'unread' | 'read' | 'unseen' | 'seen' | 'all';
+
+  /**
+   * The tenant associated with the feed items.
+   */
+  tenant?: string;
+
+  /**
+   * The trigger data of the feed items (as a JSON string).
+   */
+  trigger_data?: string;
+
+  /**
+   * The workflow categories of the feed items.
+   */
+  workflow_categories?: Array<string>;
+}
+
+export declare namespace Feeds {
+  export {
+    type FeedGetSettingsResponse as FeedGetSettingsResponse,
+    type FeedListItemsResponse as FeedListItemsResponse,
+    type FeedListItemsResponsesEntriesCursor as FeedListItemsResponsesEntriesCursor,
+    type FeedListItemsParams as FeedListItemsParams,
+  };
+}