@knocklabs/node 0.6.19 → 1.1.0

package/src/resources/schedules/bulk.ts

@@ -0,0 +1,112 @@
+// 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.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation = await client.schedules.bulk.create({
+   *   schedules: [
+   *     {
+   *       data: { ... },
+   *       ending_at: null,
+   *       recipient: 'dnedry',
+   *       repeats: [
+   *         { ... },
+   *       ],
+   *       scheduled_at: null,
+   *       tenant: 'acme_corp',
+   *       workflow: 'comment-created',
+   *     },
+   *     {
+   *       data: { ... },
+   *       ending_at: null,
+   *       recipient: 'esattler',
+   *       repeats: [
+   *         { ... },
+   *       ],
+   *       scheduled_at: null,
+   *       tenant: 'acme_corp',
+   *       workflow: 'comment-created',
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  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 };
+}

package/src/resources/schedules/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Bulk, type BulkCreateParams } from './bulk';
+export {
+  Schedules,
+  type Schedule,
+  type ScheduleRepeatRule,
+  type ScheduleCreateResponse,
+  type ScheduleUpdateResponse,
+  type ScheduleDeleteResponse,
+  type ScheduleCreateParams,
+  type ScheduleUpdateParams,
+  type ScheduleListParams,
+  type ScheduleDeleteParams,
+  type SchedulesEntriesCursor,
+} from './schedules';

package/src/resources/schedules/schedules.ts

@@ -0,0 +1,369 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RecipientsAPI from '../recipients/recipients';
+import * as BulkAPI from './bulk';
+import { Bulk, BulkCreateParams } from './bulk';
+import * as TenantsAPI from '../tenants/tenants';
+import { APIPromise } from '../../core/api-promise';
+import { EntriesCursor, type EntriesCursorParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Schedules extends APIResource {
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+
+  /**
+   * Creates one or more schedules for a workflow with the specified recipients,
+   * timing, and data. Schedules can be one-time or recurring. This endpoint also
+   * handles
+   * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+   * for the `actor`, `recipient`, and `tenant` fields.
+   *
+   * @example
+   * ```ts
+   * const schedules = await client.schedules.create({
+   *   recipients: ['user_123'],
+   *   repeats: [
+   *     {
+   *       __typename: 'ScheduleRepeat',
+   *       day_of_month: null,
+   *       days: [
+   *         'mon',
+   *         'tue',
+   *         'wed',
+   *         'thu',
+   *         'fri',
+   *         'sat',
+   *         'sun',
+   *       ],
+   *       frequency: 'daily',
+   *       hours: null,
+   *       interval: 1,
+   *       minutes: null,
+   *     },
+   *   ],
+   *   workflow: 'comment-created',
+   *   data: { key: 'value' },
+   *   tenant: 'acme_corp',
+   * });
+   * ```
+   */
+  create(body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduleCreateResponse> {
+    return this._client.post('/v1/schedules', { body, ...options });
+  }
+
+  /**
+   * Updates one or more existing schedules with new timing, data, or other
+   * properties. All specified schedule IDs will be updated with the same values.
+   * This endpoint also handles
+   * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+   * for the `actor`, `recipient`, and `tenant` fields.
+   *
+   * @example
+   * ```ts
+   * const schedules = await client.schedules.update({
+   *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+   *   data: { key: 'value' },
+   *   repeats: [
+   *     {
+   *       __typename: 'ScheduleRepeat',
+   *       day_of_month: null,
+   *       days: [
+   *         'mon',
+   *         'tue',
+   *         'wed',
+   *         'thu',
+   *         'fri',
+   *         'sat',
+   *         'sun',
+   *       ],
+   *       frequency: 'daily',
+   *       hours: null,
+   *       interval: 1,
+   *       minutes: null,
+   *     },
+   *   ],
+   *   tenant: 'acme_corp',
+   * });
+   * ```
+   */
+  update(body: ScheduleUpdateParams, options?: RequestOptions): APIPromise<ScheduleUpdateResponse> {
+    return this._client.put('/v1/schedules', { body, ...options });
+  }
+
+  /**
+   * Returns a paginated list of schedules for the current environment, filtered by
+   * workflow and optionally by recipients and tenant.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const schedule of client.schedules.list({
+   *   workflow: 'workflow',
+   * })) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(query: ScheduleListParams, options?: RequestOptions): PagePromise<SchedulesEntriesCursor, Schedule> {
+    return this._client.getAPIList('/v1/schedules', EntriesCursor<Schedule>, { query, ...options });
+  }
+
+  /**
+   * Permanently deletes one or more schedules identified by the provided schedule
+   * IDs. This operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const schedules = await client.schedules.delete({
+   *   schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'],
+   * });
+   * ```
+   */
+  delete(body: ScheduleDeleteParams, options?: RequestOptions): APIPromise<ScheduleDeleteResponse> {
+    return this._client.delete('/v1/schedules', { body, ...options });
+  }
+}
+
+export type SchedulesEntriesCursor = EntriesCursor<Schedule>;
+
+/**
+ * A schedule represents a recurring workflow execution.
+ */
+export interface Schedule {
+  /**
+   * Unique identifier for the schedule.
+   */
+  id: string;
+
+  /**
+   * Timestamp when the resource was created.
+   */
+  inserted_at: string;
+
+  /**
+   * A recipient of a notification, which is either a user or an object.
+   */
+  recipient: RecipientsAPI.Recipient;
+
+  /**
+   * The repeat rule for the schedule.
+   */
+  repeats: Array<ScheduleRepeatRule>;
+
+  /**
+   * The timestamp when the resource was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The workflow the schedule is applied to.
+   */
+  workflow: string;
+
+  /**
+   * The typename of the schema.
+   */
+  __typename?: string;
+
+  /**
+   * A recipient of a notification, which is either a user or an object.
+   */
+  actor?: RecipientsAPI.Recipient | null;
+
+  /**
+   * An optional map of data to pass into the workflow execution.
+   */
+  data?: Record<string, unknown> | null;
+
+  /**
+   * The last occurrence of the schedule.
+   */
+  last_occurrence_at?: string | null;
+
+  /**
+   * The next occurrence of the schedule.
+   */
+  next_occurrence_at?: string | null;
+
+  /**
+   * The tenant to trigger the workflow for. Triggering with a tenant will use any
+   * tenant-level overrides associated with the tenant object, and all messages
+   * produced from workflow runs will be tagged with the tenant.
+   */
+  tenant?: string | null;
+}
+
+/**
+ * The repeat rule for the schedule.
+ */
+export interface ScheduleRepeatRule {
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * The frequency of the schedule.
+   */
+  frequency: 'daily' | 'weekly' | 'monthly' | 'hourly';
+
+  /**
+   * The day of the month to repeat the schedule.
+   */
+  day_of_month?: number | null;
+
+  /**
+   * The days of the week to repeat the schedule.
+   */
+  days?: Array<'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun'> | null;
+
+  /**
+   * The hour of the day to repeat the schedule.
+   */
+  hours?: number | null;
+
+  /**
+   * The interval of the schedule.
+   */
+  interval?: number;
+
+  /**
+   * The minute of the hour to repeat the schedule.
+   */
+  minutes?: number | null;
+}
+
+/**
+ * A list of schedules.
+ */
+export type ScheduleCreateResponse = Array<Schedule>;
+
+/**
+ * A list of schedules.
+ */
+export type ScheduleUpdateResponse = Array<Schedule>;
+
+/**
+ * A list of schedules.
+ */
+export type ScheduleDeleteResponse = Array<Schedule>;
+
+export interface ScheduleCreateParams {
+  /**
+   * The recipients to trigger the workflow for. Can inline identify users, objects,
+   * or use a list of user IDs. Limited to 1,000 recipients.
+   */
+  recipients: Array<RecipientsAPI.RecipientRequest>;
+
+  /**
+   * The repeat rule for the schedule.
+   */
+  repeats: Array<ScheduleRepeatRule>;
+
+  /**
+   * The key of the workflow.
+   */
+  workflow: string;
+
+  /**
+   * 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;
+
+  /**
+   * The starting date and time for the schedule.
+   */
+  scheduled_at?: string | null;
+
+  /**
+   * An request to set a tenant inline.
+   */
+  tenant?: TenantsAPI.InlineTenantRequest | null;
+}
+
+export interface ScheduleUpdateParams {
+  /**
+   * A list of schedule IDs.
+   */
+  schedule_ids: Array<string>;
+
+  /**
+   * A reference to a recipient, either a user identifier (string) or an object
+   * reference (ID, collection).
+   */
+  actor?: RecipientsAPI.RecipientReference | 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;
+
+  /**
+   * The repeat rule for the schedule.
+   */
+  repeats?: Array<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 interface ScheduleListParams extends EntriesCursorParams {
+  /**
+   * Filter by workflow key.
+   */
+  workflow: string;
+
+  /**
+   * Filter by recipient IDs.
+   */
+  recipients?: Array<string>;
+
+  /**
+   * Filter by tenant ID.
+   */
+  tenant?: string;
+}
+
+export interface ScheduleDeleteParams {
+  /**
+   * A list of schedule IDs.
+   */
+  schedule_ids: Array<string>;
+}
+
+Schedules.Bulk = Bulk;
+
+export declare namespace Schedules {
+  export {
+    type Schedule as Schedule,
+    type ScheduleRepeatRule as ScheduleRepeatRule,
+    type ScheduleCreateResponse as ScheduleCreateResponse,
+    type ScheduleUpdateResponse as ScheduleUpdateResponse,
+    type ScheduleDeleteResponse as ScheduleDeleteResponse,
+    type SchedulesEntriesCursor as SchedulesEntriesCursor,
+    type ScheduleCreateParams as ScheduleCreateParams,
+    type ScheduleUpdateParams as ScheduleUpdateParams,
+    type ScheduleListParams as ScheduleListParams,
+    type ScheduleDeleteParams as ScheduleDeleteParams,
+  };
+
+  export { Bulk as Bulk, type BulkCreateParams as BulkCreateParams };
+}

package/src/resources/schedules.ts

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

package/src/resources/shared.ts

@@ -0,0 +1,72 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+
+export class Shared extends APIResource {}
+
+/**
+ * A condition to be evaluated.
+ */
+export interface Condition {
+  /**
+   * The argument value to compare against in the condition.
+   */
+  argument: string | null;
+
+  /**
+   * The operator to use in the condition evaluation.
+   */
+  operator:
+    | 'equal_to'
+    | 'not_equal_to'
+    | 'greater_than'
+    | 'less_than'
+    | 'greater_than_or_equal_to'
+    | 'less_than_or_equal_to'
+    | 'contains'
+    | 'not_contains'
+    | 'empty'
+    | 'not_empty'
+    | 'contains_all'
+    | 'is_timestamp'
+    | 'is_not_timestamp'
+    | 'is_timestamp_after'
+    | 'is_timestamp_before'
+    | 'is_timestamp_between'
+    | 'is_audience_member'
+    | 'is_not_audience_member';
+
+  /**
+   * The variable to be evaluated in the condition.
+   */
+  variable: string;
+}
+
+/**
+ * Pagination information for a list of resources.
+ */
+export interface PageInfo {
+  /**
+   * The typename of the schema.
+   */
+  __typename: string;
+
+  /**
+   * The number of items per page.
+   */
+  page_size: number;
+
+  /**
+   * The cursor to fetch entries after.
+   */
+  after?: string | null;
+
+  /**
+   * The cursor to fetch entries before.
+   */
+  before?: string | null;
+}
+
+export declare namespace Shared {
+  export { type Condition as Condition, type PageInfo as PageInfo };
+}

package/src/resources/tenants/bulk.ts

@@ -0,0 +1,56 @@
+// 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 TenantsAPI from './tenants';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Bulk extends APIResource {
+  /**
+   * Delete multiple tenants in a single operation. This operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation = await client.tenants.bulk.delete({
+   *   tenant_ids: ['string'],
+   * });
+   * ```
+   */
+  delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation> {
+    const { tenant_ids } = params;
+    return this._client.post('/v1/tenants/bulk/delete', { query: { tenant_ids }, ...options });
+  }
+
+  /**
+   * Set or update up to 1,000 tenants in a single operation.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation = await client.tenants.bulk.set({
+   *   tenants: ['[object Object]'],
+   * });
+   * ```
+   */
+  set(body: BulkSetParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation> {
+    return this._client.post('/v1/tenants/bulk/set', { body, ...options });
+  }
+}
+
+export interface BulkDeleteParams {
+  /**
+   * The IDs of the tenants to delete.
+   */
+  tenant_ids: Array<string>;
+}
+
+export interface BulkSetParams {
+  /**
+   * The tenants to be upserted.
+   */
+  tenants: Array<TenantsAPI.InlineTenantRequest>;
+}
+
+export declare namespace Bulk {
+  export { type BulkDeleteParams as BulkDeleteParams, type BulkSetParams as BulkSetParams };
+}

package/src/resources/tenants/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Bulk, type BulkDeleteParams, type BulkSetParams } from './bulk';
+export {
+  Tenants,
+  type InlineTenantRequest,
+  type Tenant,
+  type TenantRequest,
+  type TenantDeleteResponse,
+  type TenantListParams,
+  type TenantSetParams,
+  type TenantsEntriesCursor,
+} from './tenants';