@knocklabs/node 0.6.19 → 1.1.0

package/src/resources/tenants/tenants.ts

@@ -0,0 +1,333 @@
+// 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.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const tenant of client.tenants.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  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.
+   *
+   * @example
+   * ```ts
+   * const tenant = await client.tenants.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<string> {
+    return this._client.delete(path`/v1/tenants/${id}`, options);
+  }
+
+  /**
+   * Get a tenant by ID.
+   *
+   * @example
+   * ```ts
+   * const tenant = await client.tenants.get('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.
+   *
+   * @example
+   * ```ts
+   * const tenant = await client.tenants.set('id', {
+   *   settings: {
+   *     branding: {
+   *       icon_url:
+   *         'https://example.com/trex_silhouette_icon.png',
+   *       logo_url: 'https://example.com/amber_fossil_logo.png',
+   *       primary_color: '#DF1A22',
+   *       primary_color_contrast: '#FFDE00',
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  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,114 @@
+// 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.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation = await client.users.bulk.delete({
+   *   user_ids: ['user_1', 'user_2'],
+   * });
+   * ```
+   */
+  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.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation = await client.users.bulk.identify({
+   *   users: [
+   *     {
+   *       email: 'jane@ingen.net',
+   *       id: 'user_1',
+   *       name: 'Jane Doe',
+   *       timezone: 'America/New_York',
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  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.
+   *
+   * @example
+   * ```ts
+   * const bulkOperation =
+   *   await client.users.bulk.setPreferences({
+   *     preferences: {
+   *       categories: {
+   *         marketing: false,
+   *         transactional: { channel_types: { email: false } },
+   *       },
+   *       channel_types: { email: true },
+   *       workflows: {
+   *         'dinosaurs-loose': {
+   *           channel_types: { email: false },
+   *         },
+   *       },
+   *     },
+   *     user_ids: ['user_1', 'user_2'],
+   *   });
+   * ```
+   */
+  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,
+  };
+}