@knocklabs/node 0.6.19 → 1.0.0

package/src/resources/bulk-operations.ts

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class BulkOperations extends APIResource {
+  /**
+   * Retrieves a bulk operation (if it exists) and displays the current state of it.
+   */
+  get(id: string, options?: RequestOptions): APIPromise<BulkOperation> {
+    return this._client.get(path`/v1/bulk_operations/${id}`, options);
+  }
+}
+
+/**
+ * A bulk operation entity.
+ */
+export interface BulkOperation {
+  /**
+   * Unique identifier for the bulk operation.
+   */
+  id: string;
+
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * The estimated total number of rows to process.
+   */
+  estimated_total_rows: number;
+
+  /**
+   * Timestamp when the resource was created.
+   */
+  inserted_at: string;
+
+  /**
+   * The name of the bulk operation.
+   */
+  name: string;
+
+  /**
+   * The number of rows processed so far.
+   */
+  processed_rows: number;
+
+  /**
+   * The status of the bulk operation.
+   */
+  status: 'queued' | 'processing' | 'completed' | 'failed';
+
+  /**
+   * The number of successful operations.
+   */
+  success_count: number;
+
+  /**
+   * The timestamp when the resource was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * Timestamp when the bulk operation was completed.
+   */
+  completed_at?: string | null;
+
+  /**
+   * The number of failed operations.
+   */
+  error_count?: number;
+
+  /**
+   * A list of items that failed to be processed.
+   */
+  error_items?: Array<BulkOperation.ErrorItem>;
+
+  /**
+   * Timestamp when the bulk operation failed.
+   */
+  failed_at?: string | null;
+
+  /**
+   * The URI to the bulk operation's progress.
+   */
+  progress_path?: string;
+
+  /**
+   * Timestamp when the bulk operation was started.
+   */
+  started_at?: string | null;
+}
+
+export namespace BulkOperation {
+  export interface ErrorItem {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+
+    /**
+     * The collection this object belongs to.
+     */
+    collection?: string | null;
+  }
+}
+
+export declare namespace BulkOperations {
+  export { type BulkOperation as BulkOperation };
+}

package/src/resources/channels/bulk.ts

@@ -0,0 +1,107 @@
+// 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 { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Bulk extends APIResource {
+  /**
+   * Bulk update the status of messages for a specific channel. The channel is
+   * specified by the `channel_id` parameter. The action to perform is specified by
+   * the `action` parameter, where the action is a status change action (e.g.
+   * `archive`, `unarchive`).
+   */
+  updateMessageStatus(
+    channelID: string,
+    action:
+      | 'seen'
+      | 'unseen'
+      | 'read'
+      | 'unread'
+      | 'archived'
+      | 'unarchived'
+      | 'interacted'
+      | 'archive'
+      | 'unarchive'
+      | 'delete',
+    body: BulkUpdateMessageStatusParams,
+    options?: RequestOptions,
+  ): APIPromise<BulkOperationsAPI.BulkOperation> {
+    return this._client.post(path`/v1/channels/${channelID}/messages/bulk/${action}`, { body, ...options });
+  }
+}
+
+export interface BulkUpdateMessageStatusParams {
+  /**
+   * Limits the results to messages with the given archived status.
+   */
+  archived?: 'exclude' | 'include' | 'only';
+
+  /**
+   * Limits the results to messages with the given delivery status.
+   */
+  delivery_status?:
+    | 'queued'
+    | 'sent'
+    | 'delivered'
+    | 'delivery_attempted'
+    | 'undelivered'
+    | 'not_sent'
+    | 'bounced';
+
+  /**
+   * Limits the results to messages with the given engagement status.
+   */
+  engagement_status?:
+    | 'seen'
+    | 'unseen'
+    | 'read'
+    | 'unread'
+    | 'archived'
+    | 'unarchived'
+    | 'link_clicked'
+    | 'interacted';
+
+  /**
+   * Limits the results to messages that have a tenant or not.
+   */
+  has_tenant?: boolean;
+
+  /**
+   * Limits the results to messages inserted after the given date.
+   */
+  newer_than?: string;
+
+  /**
+   * Limits the results to messages inserted before the given date.
+   */
+  older_than?: string;
+
+  /**
+   * Limits the results to messages with the given recipient IDs.
+   */
+  recipient_ids?: Array<string>;
+
+  /**
+   * Limits the results to messages with the given tenant IDs.
+   */
+  tenants?: Array<string>;
+
+  /**
+   * Limits the results to only messages that were generated with the given data. See
+   * [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
+   * more information.
+   */
+  trigger_data?: string;
+
+  /**
+   * Limits the results to messages with the given workflow keys.
+   */
+  workflows?: Array<string>;
+}
+
+export declare namespace Bulk {
+  export { type BulkUpdateMessageStatusParams as BulkUpdateMessageStatusParams };
+}

package/src/resources/channels/channels.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BulkAPI from './bulk';
+import { Bulk, BulkUpdateMessageStatusParams } from './bulk';
+
+export class Channels extends APIResource {
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+}
+
+Channels.Bulk = Bulk;
+
+export declare namespace Channels {
+  export { Bulk as Bulk, type BulkUpdateMessageStatusParams as BulkUpdateMessageStatusParams };
+}

package/src/resources/channels/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Bulk, type BulkUpdateMessageStatusParams } from './bulk';
+export { Channels } from './channels';

package/src/resources/channels.ts

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

package/src/resources/index.ts

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Audiences,
+  type AudienceMember,
+  type AudienceAddMembersResponse,
+  type AudienceListMembersResponse,
+  type AudienceRemoveMembersResponse,
+  type AudienceAddMembersParams,
+  type AudienceRemoveMembersParams,
+} from './audiences';
+export { BulkOperations, type BulkOperation } from './bulk-operations';
+export { Channels } from './channels/channels';
+export { Integrations } from './integrations/integrations';
+export {
+  Messages,
+  type Activity,
+  type Message,
+  type MessageDeliveryLog,
+  type MessageEvent,
+  type MessageGetContentResponse,
+  type MessageListParams,
+  type MessageListActivitiesParams,
+  type MessageListDeliveryLogsParams,
+  type MessageListEventsParams,
+  type MessageMarkAsInteractedParams,
+  type MessagesEntriesCursor,
+  type ActivitiesItemsCursor,
+  type MessageDeliveryLogsEntriesCursor,
+  type MessageEventsEntriesCursor,
+} from './messages/messages';
+export {
+  Objects,
+  type InlineObjectRequest,
+  type Object,
+  type ObjectDeleteResponse,
+  type ObjectAddSubscriptionsResponse,
+  type ObjectDeleteSubscriptionsResponse,
+  type ObjectListPreferencesResponse,
+  type ObjectUnsetChannelDataResponse,
+  type ObjectListParams,
+  type ObjectAddSubscriptionsParams,
+  type ObjectDeleteSubscriptionsParams,
+  type ObjectListMessagesParams,
+  type ObjectListSchedulesParams,
+  type ObjectListSubscriptionsParams,
+  type ObjectSetParams,
+  type ObjectSetChannelDataParams,
+  type ObjectSetPreferencesParams,
+  type ObjectsEntriesCursor,
+} from './objects/objects';
+export { Providers } from './providers/providers';
+export {
+  Recipients,
+  type Recipient,
+  type RecipientReference,
+  type RecipientRequest,
+} from './recipients/recipients';
+export {
+  Schedules,
+  type Schedule,
+  type ScheduleRepeatRule,
+  type ScheduleCreateResponse,
+  type ScheduleUpdateResponse,
+  type ScheduleDeleteResponse,
+  type ScheduleCreateParams,
+  type ScheduleUpdateParams,
+  type ScheduleListParams,
+  type ScheduleDeleteParams,
+  type SchedulesEntriesCursor,
+} from './schedules/schedules';
+export { Shared, type Condition, type PageInfo } from './shared';
+export {
+  Tenants,
+  type InlineTenantRequest,
+  type Tenant,
+  type TenantRequest,
+  type TenantDeleteResponse,
+  type TenantListParams,
+  type TenantSetParams,
+  type TenantsEntriesCursor,
+} from './tenants/tenants';
+export {
+  Users,
+  type IdentifyUserRequest,
+  type InlineIdentifyUserRequest,
+  type User,
+  type UserDeleteResponse,
+  type UserListPreferencesResponse,
+  type UserUnsetChannelDataResponse,
+  type UserUpdateParams,
+  type UserListParams,
+  type UserGetPreferencesParams,
+  type UserListMessagesParams,
+  type UserListSchedulesParams,
+  type UserListSubscriptionsParams,
+  type UserMergeParams,
+  type UserSetChannelDataParams,
+  type UserSetPreferencesParams,
+  type UsersEntriesCursor,
+} from './users/users';
+export {
+  Workflows,
+  type WorkflowCancelResponse,
+  type WorkflowTriggerResponse,
+  type WorkflowCancelParams,
+  type WorkflowTriggerParams,
+} from './workflows';

package/src/resources/integrations/census.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Census extends APIResource {
+  /**
+   * Processes a Census custom destination RPC request.
+   */
+  customDestination(
+    body: CensusCustomDestinationParams,
+    options?: RequestOptions,
+  ): APIPromise<CensusCustomDestinationResponse> {
+    return this._client.post('/v1/integrations/census/custom-destination', { body, ...options });
+  }
+}
+
+export interface CensusCustomDestinationResponse {
+  /**
+   * The request ID.
+   */
+  id?: string;
+
+  /**
+   * The result of the RPC call.
+   */
+  result?: Record<string, unknown>;
+}
+
+export interface CensusCustomDestinationParams {
+  /**
+   * The unique identifier for the RPC request.
+   */
+  id: string;
+
+  /**
+   * The JSON-RPC version.
+   */
+  jsonrpc: string;
+
+  /**
+   * The method name to execute.
+   */
+  method: string;
+
+  /**
+   * The parameters for the method.
+   */
+  params?: Record<string, unknown>;
+}
+
+export declare namespace Census {
+  export {
+    type CensusCustomDestinationResponse as CensusCustomDestinationResponse,
+    type CensusCustomDestinationParams as CensusCustomDestinationParams,
+  };
+}

package/src/resources/integrations/hightouch.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Hightouch extends APIResource {
+  /**
+   * Processes a Hightouch embedded destination RPC request.
+   */
+  embeddedDestination(
+    body: HightouchEmbeddedDestinationParams,
+    options?: RequestOptions,
+  ): APIPromise<HightouchEmbeddedDestinationResponse> {
+    return this._client.post('/v1/integrations/hightouch/embedded-destination', { body, ...options });
+  }
+}
+
+export interface HightouchEmbeddedDestinationResponse {
+  /**
+   * The request ID.
+   */
+  id?: string;
+
+  /**
+   * The result of the RPC call.
+   */
+  result?: Record<string, unknown>;
+}
+
+export interface HightouchEmbeddedDestinationParams {
+  /**
+   * The unique identifier for the RPC request.
+   */
+  id: string;
+
+  /**
+   * The JSON-RPC version.
+   */
+  jsonrpc: string;
+
+  /**
+   * The method name to execute.
+   */
+  method: string;
+
+  /**
+   * The parameters for the method.
+   */
+  params?: Record<string, unknown>;
+}
+
+export declare namespace Hightouch {
+  export {
+    type HightouchEmbeddedDestinationResponse as HightouchEmbeddedDestinationResponse,
+    type HightouchEmbeddedDestinationParams as HightouchEmbeddedDestinationParams,
+  };
+}

package/src/resources/integrations/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Census, type CensusCustomDestinationResponse, type CensusCustomDestinationParams } from './census';
+export {
+  Hightouch,
+  type HightouchEmbeddedDestinationResponse,
+  type HightouchEmbeddedDestinationParams,
+} from './hightouch';
+export { Integrations } from './integrations';

package/src/resources/integrations/integrations.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CensusAPI from './census';
+import { Census, CensusCustomDestinationParams, CensusCustomDestinationResponse } from './census';
+import * as HightouchAPI from './hightouch';
+import {
+  Hightouch,
+  HightouchEmbeddedDestinationParams,
+  HightouchEmbeddedDestinationResponse,
+} from './hightouch';
+
+export class Integrations extends APIResource {
+  census: CensusAPI.Census = new CensusAPI.Census(this._client);
+  hightouch: HightouchAPI.Hightouch = new HightouchAPI.Hightouch(this._client);
+}
+
+Integrations.Census = Census;
+Integrations.Hightouch = Hightouch;
+
+export declare namespace Integrations {
+  export {
+    Census as Census,
+    type CensusCustomDestinationResponse as CensusCustomDestinationResponse,
+    type CensusCustomDestinationParams as CensusCustomDestinationParams,
+  };
+
+  export {
+    Hightouch as Hightouch,
+    type HightouchEmbeddedDestinationResponse as HightouchEmbeddedDestinationResponse,
+    type HightouchEmbeddedDestinationParams as HightouchEmbeddedDestinationParams,
+  };
+}

package/src/resources/integrations.ts

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

package/src/resources/messages/activities.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MessagesAPI from './messages';
+import { ActivitiesItemsCursor } from './messages';
+import { ItemsCursor, type ItemsCursorParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Activities extends APIResource {
+  /**
+   * Returns a paginated list of activities for the specified message.
+   */
+  list(
+    messageID: string,
+    query: ActivityListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ActivitiesItemsCursor, MessagesAPI.Activity> {
+    return this._client.getAPIList(
+      path`/v1/messages/${messageID}/activities`,
+      ItemsCursor<MessagesAPI.Activity>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface ActivityListParams extends ItemsCursorParams {
+  /**
+   * The trigger data to filter activities by.
+   */
+  trigger_data?: string;
+}
+
+export declare namespace Activities {
+  export { type ActivityListParams as ActivityListParams };
+}
+
+export { type ActivitiesItemsCursor };