@knocklabs/node 0.6.19 → 1.0.0

package/src/resources/recipients/channel-data.ts

@@ -0,0 +1,255 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+
+export class ChannelData extends APIResource {}
+
+/**
+ * Channel data for a given channel type.
+ */
+export interface ChannelData {
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * The unique identifier for the channel.
+   */
+  channel_id: string;
+
+  /**
+   * Channel data for a given channel type.
+   */
+  data: PushChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData | OneSignalChannelData;
+
+  /**
+   * The type of provider.
+   */
+  provider?:
+    | 'push_fcm'
+    | 'push_apns'
+    | 'push_expo'
+    | 'push_one_signal'
+    | 'chat_slack'
+    | 'chat_ms_teams'
+    | 'chat_discord'
+    | 'http_knock_webhook';
+}
+
+/**
+ * A request to set channel data for a type of channel.
+ */
+export interface ChannelDataRequest {
+  /**
+   * Channel data for a given channel type.
+   */
+  data: PushChannelData | OneSignalChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData;
+}
+
+/**
+ * Discord channel data.
+ */
+export interface DiscordChannelData {
+  /**
+   * List of Discord channel connections.
+   */
+  connections: Array<
+    DiscordChannelData.DiscordChannelConnection | DiscordChannelData.DiscordIncomingWebhookConnection
+  >;
+}
+
+export namespace DiscordChannelData {
+  /**
+   * Discord channel connection.
+   */
+  export interface DiscordChannelConnection {
+    /**
+     * Discord channel ID.
+     */
+    channel_id: string;
+  }
+
+  /**
+   * Discord incoming webhook connection.
+   */
+  export interface DiscordIncomingWebhookConnection {
+    /**
+     * Discord incoming webhook object.
+     */
+    incoming_webhook: DiscordIncomingWebhookConnection.IncomingWebhook;
+  }
+
+  export namespace DiscordIncomingWebhookConnection {
+    /**
+     * Discord incoming webhook object.
+     */
+    export interface IncomingWebhook {
+      /**
+       * Incoming webhook URL.
+       */
+      url: string;
+    }
+  }
+}
+
+/**
+ * A request to set channel data for a type of channel inline.
+ */
+export type InlineChannelDataRequest = Record<string, ChannelDataRequest>;
+
+/**
+ * Microsoft Teams channel connection.
+ */
+export interface MsTeamsChannelData {
+  /**
+   * List of Microsoft Teams connections.
+   */
+  connections: Array<
+    MsTeamsChannelData.MsTeamsTokenConnection | MsTeamsChannelData.MsTeamsIncomingWebhookConnection
+  >;
+
+  /**
+   * Microsoft Teams tenant ID.
+   */
+  ms_teams_tenant_id?: string | null;
+}
+
+export namespace MsTeamsChannelData {
+  /**
+   * Microsoft Teams token connection.
+   */
+  export interface MsTeamsTokenConnection {
+    /**
+     * Microsoft Teams channel ID.
+     */
+    ms_teams_channel_id?: string | null;
+
+    /**
+     * Microsoft Teams team ID.
+     */
+    ms_teams_team_id?: string | null;
+
+    /**
+     * Microsoft Teams tenant ID.
+     */
+    ms_teams_tenant_id?: string | null;
+
+    /**
+     * Microsoft Teams user ID.
+     */
+    ms_teams_user_id?: string | null;
+  }
+
+  /**
+   * Microsoft Teams incoming webhook connection.
+   */
+  export interface MsTeamsIncomingWebhookConnection {
+    /**
+     * Microsoft Teams incoming webhook.
+     */
+    incoming_webhook: MsTeamsIncomingWebhookConnection.IncomingWebhook;
+  }
+
+  export namespace MsTeamsIncomingWebhookConnection {
+    /**
+     * Microsoft Teams incoming webhook.
+     */
+    export interface IncomingWebhook {
+      /**
+       * Microsoft Teams incoming webhook URL.
+       */
+      url: string;
+    }
+  }
+}
+
+/**
+ * OneSignal channel data.
+ */
+export interface OneSignalChannelData {
+  /**
+   * A list of OneSignal player IDs.
+   */
+  player_ids: Array<string>;
+}
+
+/**
+ * The content of a push notification.
+ */
+export interface PushChannelData {
+  /**
+   * A list of push channel tokens.
+   */
+  tokens: Array<string>;
+}
+
+/**
+ * Slack channel data
+ */
+export interface SlackChannelData {
+  /**
+   * List of Slack channel connections.
+   */
+  connections: Array<SlackChannelData.SlackTokenConnection | SlackChannelData.SlackIncomingWebhookConnection>;
+
+  /**
+   * A Slack connection token.
+   */
+  token?: SlackChannelData.Token | null;
+}
+
+export namespace SlackChannelData {
+  /**
+   * A Slack connection token.
+   */
+  export interface SlackTokenConnection {
+    /**
+     * A Slack access token.
+     */
+    access_token?: string | null;
+
+    /**
+     * A Slack channel ID from the Slack provider.
+     */
+    channel_id?: string | null;
+
+    /**
+     * A Slack user ID from the Slack provider.
+     */
+    user_id?: string | null;
+  }
+
+  /**
+   * A Slack connection incoming webhook.
+   */
+  export interface SlackIncomingWebhookConnection {
+    /**
+     * The URL of the incoming webhook for a Slack connection.
+     */
+    url: string;
+  }
+
+  /**
+   * A Slack connection token.
+   */
+  export interface Token {
+    /**
+     * A Slack access token.
+     */
+    access_token: string | null;
+  }
+}
+
+export declare namespace ChannelData {
+  export {
+    type ChannelData as ChannelData,
+    type ChannelDataRequest as ChannelDataRequest,
+    type DiscordChannelData as DiscordChannelData,
+    type InlineChannelDataRequest as InlineChannelDataRequest,
+    type MsTeamsChannelData as MsTeamsChannelData,
+    type OneSignalChannelData as OneSignalChannelData,
+    type PushChannelData as PushChannelData,
+    type SlackChannelData as SlackChannelData,
+  };
+}

package/src/resources/recipients/index.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ChannelData,
+  type ChannelDataRequest,
+  type DiscordChannelData,
+  type InlineChannelDataRequest,
+  type MsTeamsChannelData,
+  type OneSignalChannelData,
+  type PushChannelData,
+  type SlackChannelData,
+} from './channel-data';
+export {
+  Preferences,
+  type InlinePreferenceSetRequest,
+  type PreferenceSet,
+  type PreferenceSetChannelTypeSetting,
+  type PreferenceSetChannelTypes,
+  type PreferenceSetRequest,
+} from './preferences';
+export { Recipients, type Recipient, type RecipientReference, type RecipientRequest } from './recipients';
+export { Subscriptions, type Subscription, type SubscriptionsEntriesCursor } from './subscriptions';

package/src/resources/recipients/preferences.ts

@@ -0,0 +1,192 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PreferencesAPI from './preferences';
+import * as SharedAPI from '../shared';
+
+export class Preferences extends APIResource {}
+
+/**
+ * Inline set preferences for a recipient, where the key is the preference set id.
+ */
+export type InlinePreferenceSetRequest = Record<string, PreferenceSetRequest>;
+
+/**
+ * A preference set represents a specific set of notification preferences for a
+ * recipient. A recipient can have multiple preference sets.
+ */
+export interface PreferenceSet {
+  /**
+   * Unique identifier for the preference set.
+   */
+  id: string;
+
+  /**
+   * An object where the key is the category and the values are the preference
+   * settings for that category.
+   */
+  categories?: Record<string, boolean | PreferenceSet.PreferenceSetWorkflowCategorySettingObject> | null;
+
+  /**
+   * Channel type preferences.
+   */
+  channel_types?: PreferenceSetChannelTypes | null;
+
+  /**
+   * An object where the key is the workflow key and the values are the preference
+   * settings for that workflow.
+   */
+  workflows?: Record<string, boolean | PreferenceSet.PreferenceSetWorkflowCategorySettingObject> | null;
+}
+
+export namespace PreferenceSet {
+  /**
+   * The settings object for a workflow or category, where you can specify channel
+   * types or conditions.
+   */
+  export interface PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * Channel type preferences.
+     */
+    channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+    /**
+     * A list of conditions to apply to a channel type.
+     */
+    conditions?: Array<SharedAPI.Condition> | null;
+  }
+
+  /**
+   * The settings object for a workflow or category, where you can specify channel
+   * types or conditions.
+   */
+  export interface PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * Channel type preferences.
+     */
+    channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+    /**
+     * A list of conditions to apply to a channel type.
+     */
+    conditions?: Array<SharedAPI.Condition> | null;
+  }
+}
+
+/**
+ * A set of settings for a channel type. Currently, this can only be a list of
+ * conditions to apply.
+ */
+export interface PreferenceSetChannelTypeSetting {
+  /**
+   * A list of conditions to apply to a channel type.
+   */
+  conditions: Array<SharedAPI.Condition>;
+}
+
+/**
+ * Channel type preferences.
+ */
+export interface PreferenceSetChannelTypes {
+  /**
+   * Whether the channel type is enabled for the preference set.
+   */
+  chat?: boolean | PreferenceSetChannelTypeSetting;
+
+  /**
+   * Whether the channel type is enabled for the preference set.
+   */
+  email?: boolean | PreferenceSetChannelTypeSetting;
+
+  /**
+   * Whether the channel type is enabled for the preference set.
+   */
+  http?: boolean | PreferenceSetChannelTypeSetting;
+
+  /**
+   * Whether the channel type is enabled for the preference set.
+   */
+  in_app_feed?: boolean | PreferenceSetChannelTypeSetting;
+
+  /**
+   * Whether the channel type is enabled for the preference set.
+   */
+  push?: boolean | PreferenceSetChannelTypeSetting;
+
+  /**
+   * Whether the channel type is enabled for the preference set.
+   */
+  sms?: boolean | PreferenceSetChannelTypeSetting;
+}
+
+/**
+ * A request to set a preference set for a recipient.
+ */
+export interface PreferenceSetRequest {
+  /**
+   * An object where the key is the category and the values are the preference
+   * settings for that category.
+   */
+  categories?: Record<
+    string,
+    boolean | PreferenceSetRequest.PreferenceSetWorkflowCategorySettingObject
+  > | null;
+
+  /**
+   * Channel type preferences.
+   */
+  channel_types?: PreferenceSetChannelTypes | null;
+
+  /**
+   * An object where the key is the workflow key and the values are the preference
+   * settings for that workflow.
+   */
+  workflows?: Record<
+    string,
+    boolean | PreferenceSetRequest.PreferenceSetWorkflowCategorySettingObject
+  > | null;
+}
+
+export namespace PreferenceSetRequest {
+  /**
+   * The settings object for a workflow or category, where you can specify channel
+   * types or conditions.
+   */
+  export interface PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * Channel type preferences.
+     */
+    channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+    /**
+     * A list of conditions to apply to a channel type.
+     */
+    conditions?: Array<SharedAPI.Condition> | null;
+  }
+
+  /**
+   * The settings object for a workflow or category, where you can specify channel
+   * types or conditions.
+   */
+  export interface PreferenceSetWorkflowCategorySettingObject {
+    /**
+     * Channel type preferences.
+     */
+    channel_types?: PreferencesAPI.PreferenceSetChannelTypes | null;
+
+    /**
+     * A list of conditions to apply to a channel type.
+     */
+    conditions?: Array<SharedAPI.Condition> | null;
+  }
+}
+
+export declare namespace Preferences {
+  export {
+    type InlinePreferenceSetRequest as InlinePreferenceSetRequest,
+    type PreferenceSet as PreferenceSet,
+    type PreferenceSetChannelTypeSetting as PreferenceSetChannelTypeSetting,
+    type PreferenceSetChannelTypes as PreferenceSetChannelTypes,
+    type PreferenceSetRequest as PreferenceSetRequest,
+  };
+}

package/src/resources/recipients/recipients.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ObjectsAPI from '../objects/objects';
+import * as ChannelDataAPI from './channel-data';
+import {
+  ChannelData,
+  ChannelDataRequest,
+  DiscordChannelData,
+  InlineChannelDataRequest,
+  MsTeamsChannelData,
+  OneSignalChannelData,
+  PushChannelData,
+  SlackChannelData,
+} from './channel-data';
+import * as PreferencesAPI from './preferences';
+import {
+  InlinePreferenceSetRequest,
+  PreferenceSet,
+  PreferenceSetChannelTypeSetting,
+  PreferenceSetChannelTypes,
+  PreferenceSetRequest,
+  Preferences,
+} from './preferences';
+import * as SubscriptionsAPI from './subscriptions';
+import { Subscription, Subscriptions } from './subscriptions';
+import * as UsersAPI from '../users/users';
+
+export class Recipients extends APIResource {
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+  preferences: PreferencesAPI.Preferences = new PreferencesAPI.Preferences(this._client);
+  channelData: ChannelDataAPI.ChannelData = new ChannelDataAPI.ChannelData(this._client);
+}
+
+/**
+ * A recipient of a notification, which is either a user or an object.
+ */
+export type Recipient = UsersAPI.User | ObjectsAPI.Object;
+
+/**
+ * A reference to a recipient, either a user identifier (string) or an object
+ * reference (ID, collection).
+ */
+export type RecipientReference = string | RecipientReference.ObjectReference;
+
+export namespace RecipientReference {
+  /**
+   * A reference to a recipient object.
+   */
+  export interface ObjectReference {
+    /**
+     * An identifier for the recipient object.
+     */
+    id?: string;
+
+    /**
+     * The collection the recipient object belongs to.
+     */
+    collection?: string;
+  }
+}
+
+/**
+ * Specifies a recipient in a request. This can either be a user identifier
+ * (string), an inline user request (object), or an inline object request, which is
+ * determined by the presence of a `collection` property.
+ */
+export type RecipientRequest = string | UsersAPI.InlineIdentifyUserRequest | ObjectsAPI.InlineObjectRequest;
+
+Recipients.Subscriptions = Subscriptions;
+Recipients.Preferences = Preferences;
+
+export declare namespace Recipients {
+  export {
+    type Recipient as Recipient,
+    type RecipientReference as RecipientReference,
+    type RecipientRequest as RecipientRequest,
+  };
+
+  export { Subscriptions as Subscriptions, type Subscription as Subscription };
+
+  export {
+    Preferences as Preferences,
+    type InlinePreferenceSetRequest as InlinePreferenceSetRequest,
+    type PreferenceSet as PreferenceSet,
+    type PreferenceSetChannelTypeSetting as PreferenceSetChannelTypeSetting,
+    type PreferenceSetChannelTypes as PreferenceSetChannelTypes,
+    type PreferenceSetRequest as PreferenceSetRequest,
+  };
+
+  export {
+    type ChannelData as ChannelData,
+    type ChannelDataRequest as ChannelDataRequest,
+    type DiscordChannelData as DiscordChannelData,
+    type InlineChannelDataRequest as InlineChannelDataRequest,
+    type MsTeamsChannelData as MsTeamsChannelData,
+    type OneSignalChannelData as OneSignalChannelData,
+    type PushChannelData as PushChannelData,
+    type SlackChannelData as SlackChannelData,
+  };
+}

package/src/resources/recipients/subscriptions.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ObjectsAPI from '../objects/objects';
+import * as RecipientsAPI from './recipients';
+import { EntriesCursor } from '../../core/pagination';
+
+export class Subscriptions extends APIResource {}
+
+export type SubscriptionsEntriesCursor = EntriesCursor<Subscription>;
+
+/**
+ * A subscription object.
+ */
+export interface Subscription {
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * Timestamp when the resource was created.
+   */
+  inserted_at: string;
+
+  /**
+   * A custom [Object](/concepts/objects) entity which belongs to a collection.
+   */
+  object: ObjectsAPI.Object;
+
+  /**
+   * A recipient of a notification, which is either a user or an object.
+   */
+  recipient: RecipientsAPI.Recipient;
+
+  /**
+   * The timestamp when the resource was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The custom properties associated with the subscription relationship.
+   */
+  properties?: Record<string, unknown> | null;
+}
+
+export declare namespace Subscriptions {
+  export { type Subscription as Subscription };
+}

package/src/resources/recipients.ts

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

package/src/resources/schedules/bulk.ts

@@ -0,0 +1,82 @@
+// 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 RecipientsAPI from '../recipients/recipients';
+import * as SchedulesAPI from './schedules';
+import * as TenantsAPI from '../tenants/tenants';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Bulk extends APIResource {
+  /**
+   * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
+   * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+   * for the `actor`, `recipient`, and `tenant` fields.
+   */
+  create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation> {
+    return this._client.post('/v1/schedules/bulk/create', { body, ...options });
+  }
+}
+
+export interface BulkCreateParams {
+  /**
+   * A list of schedules.
+   */
+  schedules: Array<BulkCreateParams.Schedule>;
+}
+
+export namespace BulkCreateParams {
+  /**
+   * A schedule represents a recurring workflow execution.
+   */
+  export interface Schedule {
+    /**
+     * The key of the workflow.
+     */
+    workflow: string;
+
+    /**
+     * Specifies a recipient in a request. This can either be a user identifier
+     * (string), an inline user request (object), or an inline object request, which is
+     * determined by the presence of a `collection` property.
+     */
+    actor?: RecipientsAPI.RecipientRequest | null;
+
+    /**
+     * An optional map of data to pass into the workflow execution.
+     */
+    data?: Record<string, unknown> | null;
+
+    /**
+     * The ending date and time for the schedule.
+     */
+    ending_at?: string | null;
+
+    /**
+     * Specifies a recipient in a request. This can either be a user identifier
+     * (string), an inline user request (object), or an inline object request, which is
+     * determined by the presence of a `collection` property.
+     */
+    recipient?: RecipientsAPI.RecipientRequest;
+
+    /**
+     * The repeat rule for the schedule.
+     */
+    repeats?: Array<SchedulesAPI.ScheduleRepeatRule>;
+
+    /**
+     * The starting date and time for the schedule.
+     */
+    scheduled_at?: string | null;
+
+    /**
+     * An request to set a tenant inline.
+     */
+    tenant?: TenantsAPI.InlineTenantRequest | null;
+  }
+}
+
+export declare namespace Bulk {
+  export { type BulkCreateParams as BulkCreateParams };
+}