@knocklabs/node 0.6.19 → 1.1.0

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,48 @@
+// 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.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const activity of client.messages.activities.list(
+   *   'message_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  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 };