@human2human/sdk 0.2.0 → 0.4.0

package/dist/resources/search-groups/items/index.d.ts

@@ -6,3 +6,9 @@ export { ItemsClient } from "./resource-client";
 /**
  * Generated by Sideko (sideko.dev)
  **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/

package/dist/resources/search-groups/items/index.js

@@ -9,3 +9,9 @@ Object.defineProperty(exports, "ItemsClient", { enumerable: true, get: function
 /**
  * Generated by Sideko (sideko.dev)
  **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/

package/dist/resources/search-groups/items/resource-client.d.ts

@@ -4,6 +4,12 @@
 import { ApiPromise, CoreClient, CoreResourceClient, RequestOptions, ResourceClientOptions } from "make-api-request-js";
 import * as requests from "../../../resources/search-groups/items/request-types";
 import * as types from "../../../types";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
 /**
  * Generated by Sideko (sideko.dev)
  **/
@@ -12,18 +18,24 @@ export declare class ItemsClient extends CoreResourceClient {
     /**
      * Get a search item by id
      *
+     * Retrieve a single search item by its ID.
+     *
      * GET /search_groups/items/{id}
      */
     get(request: requests.GetRequest, opts?: RequestOptions): ApiPromise<types.SearchGroupsItemsGetResponse>;
     /**
      * List search items in a search group
      *
+     * Retrieve a paginated list of search items that belong to a specific search group.
+     *
      * GET /search_groups/{id}/items
      */
     list(request: requests.ListRequest, opts?: RequestOptions): ApiPromise<types.SearchGroupsItemsListResponseItem[]>;
     /**
      * Create a new search item in a search group
      *
+     * Create a new search item under the specified search group.
+     *
      * POST /search_groups/{id}/items
      */
     create(request: requests.CreateRequest, opts?: RequestOptions): ApiPromise<types.SearchGroupsItemsCreateResponseUnion0Obj0 | types.SearchGroupsItemsCreateResponseUnion0Obj1 | Record<string, any | undefined>>;

package/dist/resources/search-groups/items/resource-client.js

@@ -45,6 +45,12 @@ const search_groups_items_create_response_union0_obj0_1 = require("../../../type
 const search_groups_items_create_response_union0_obj1_1 = require("../../../types/search-groups-items-create-response-union0-obj1");
 const search_groups_items_get_response_1 = require("../../../types/search-groups-items-get-response");
 const search_groups_items_list_response_item_1 = require("../../../types/search-groups-items-list-response-item");
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
 /**
  * Generated by Sideko (sideko.dev)
  **/
@@ -55,6 +61,8 @@ class ItemsClient extends make_api_request_js_1.CoreResourceClient {
     /**
      * Get a search item by id
      *
+     * Retrieve a single search item by its ID.
+     *
      * GET /search_groups/items/{id}
      */
     get(request, opts) {
@@ -69,6 +77,8 @@ class ItemsClient extends make_api_request_js_1.CoreResourceClient {
     /**
      * List search items in a search group
      *
+     * Retrieve a paginated list of search items that belong to a specific search group.
+     *
      * GET /search_groups/{id}/items
      */
     list(request, opts) {
@@ -97,6 +107,8 @@ class ItemsClient extends make_api_request_js_1.CoreResourceClient {
     /**
      * Create a new search item in a search group
      *
+     * Create a new search item under the specified search group.
+     *
      * POST /search_groups/{id}/items
      */
     create(request, opts) {

package/dist/resources/search-groups/resource-client.d.ts

@@ -5,6 +5,12 @@ import { ApiPromise, CoreClient, CoreResourceClient, RequestOptions, ResourceCli
 import { ItemsClient } from "../../resources/search-groups/items";
 import * as requests from "../../resources/search-groups/request-types";
 import * as types from "../../types";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
 /**
  * Generated by Sideko (sideko.dev)
  **/
@@ -15,18 +21,24 @@ export declare class SearchGroupsClient extends CoreResourceClient {
     /**
      * List search groups
      *
+     * Retrieve a paginated list of search groups, optionally filtered by search group type.
+     *
      * GET /search_groups
      */
     list(request?: requests.ListRequest, opts?: RequestOptions): ApiPromise<types.SearchGroupsListResponseItem[]>;
     /**
      * Get a search group by id
      *
+     * Retrieve a single search group by its ID.
+     *
      * GET /search_groups/{id}
      */
     get(request: requests.GetRequest, opts?: RequestOptions): ApiPromise<types.SearchGroupsGetResponse>;
     /**
      * Create a new dictionary
      *
+     * Create a new search group for dictionary, meta tag, or document search items.
+     *
      * POST /search_groups
      */
     create(request?: requests.CreateRequest, opts?: RequestOptions): ApiPromise<types.SearchGroupsCreateResponse>;

package/dist/resources/search-groups/resource-client.js

@@ -43,6 +43,12 @@ const search_groups_create_body_1 = require("../../types/search-groups-create-bo
 const search_groups_create_response_1 = require("../../types/search-groups-create-response");
 const search_groups_get_response_1 = require("../../types/search-groups-get-response");
 const search_groups_list_response_item_1 = require("../../types/search-groups-list-response-item");
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
 /**
  * Generated by Sideko (sideko.dev)
  **/
@@ -60,6 +66,8 @@ class SearchGroupsClient extends make_api_request_js_1.CoreResourceClient {
     /**
      * List search groups
      *
+     * Retrieve a paginated list of search groups, optionally filtered by search group type.
+     *
      * GET /search_groups
      */
     list(request = {}, opts) {
@@ -97,6 +105,8 @@ class SearchGroupsClient extends make_api_request_js_1.CoreResourceClient {
     /**
      * Get a search group by id
      *
+     * Retrieve a single search group by its ID.
+     *
      * GET /search_groups/{id}
      */
     get(request, opts) {
@@ -111,6 +121,8 @@ class SearchGroupsClient extends make_api_request_js_1.CoreResourceClient {
     /**
      * Create a new dictionary
      *
+     * Create a new search group for dictionary, meta tag, or document search items.
+     *
      * POST /search_groups
      */
     create(request = {}, opts) {

package/dist/resources/subscriptions/events/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+export { CreateRequest, DeleteRequest, GetRequest, ListRequest, } from "./request-types";
+export { EventsClient } from "./resource-client";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/

package/dist/resources/subscriptions/events/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventsClient = void 0;
+var resource_client_1 = require("./resource-client");
+Object.defineProperty(exports, "EventsClient", { enumerable: true, get: function () { return resource_client_1.EventsClient; } });
+/**
+ * Generated by Sideko (sideko.dev)
+ **/

package/dist/resources/subscriptions/events/request-types.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+import * as z from "zod";
+/**
+ * DeleteRequest
+ */
+export type DeleteRequest = {
+    /**
+     * The event subscription ID
+     */
+    id: string;
+};
+/**
+ * @internal
+ * DeleteRequest without any key transformation, this is what
+ * we expect to come in as network data
+ */
+export type External$DeleteRequest = {
+    id: string;
+};
+export declare const Schemas$DeleteRequest: {
+    in: z.ZodType<DeleteRequest, z.ZodTypeDef, unknown>;
+    out: z.ZodType<External$DeleteRequest, z.ZodTypeDef, DeleteRequest>;
+};
+/**
+ * ListRequest
+ */
+export type ListRequest = {
+    /**
+     * Number of items per page
+     */
+    limit?: number | undefined;
+    /**
+     * Page number (1-based)
+     */
+    page?: number | undefined;
+};
+/**
+ * @internal
+ * ListRequest without any key transformation, this is what
+ * we expect to come in as network data
+ */
+export type External$ListRequest = {
+    limit?: number | undefined;
+    page?: number | undefined;
+};
+export declare const Schemas$ListRequest: {
+    in: z.ZodType<ListRequest, z.ZodTypeDef, unknown>;
+    out: z.ZodType<External$ListRequest, z.ZodTypeDef, ListRequest>;
+};
+/**
+ * GetRequest
+ */
+export type GetRequest = {
+    /**
+     * The event subscription ID
+     */
+    id: string;
+};
+/**
+ * @internal
+ * GetRequest without any key transformation, this is what
+ * we expect to come in as network data
+ */
+export type External$GetRequest = {
+    id: string;
+};
+export declare const Schemas$GetRequest: {
+    in: z.ZodType<GetRequest, z.ZodTypeDef, unknown>;
+    out: z.ZodType<External$GetRequest, z.ZodTypeDef, GetRequest>;
+};
+/**
+ * CreateRequest
+ */
+export type CreateRequest = {
+    /**
+     * The ID of the consumer resource
+     */
+    consumerId: string;
+    /**
+     * The type of the consumer resource
+     */
+    consumerType: "workflow_origins" | "workflows";
+    /**
+     * Array of event patterns to subscribe to (e.g. ["feed_items", "create"])
+     */
+    events: string[];
+    /**
+     * The ID of the producer resource
+     */
+    producerId: string;
+    /**
+     * The type of the producer resource
+     */
+    producerType: "feeds" | "workflows";
+    [additionalProperty: string]: string | ("workflow_origins" | "workflows") | string[] | string | ("feeds" | "workflows") | any | null | undefined;
+};
+/**
+ * @internal
+ * CreateRequest without any key transformation, this is what
+ * we expect to come in as network data
+ */
+export type External$CreateRequest = {
+    consumer_id: string;
+    consumer_type: "workflow_origins" | "workflows";
+    events: string[];
+    producer_id: string;
+    producer_type: "feeds" | "workflows";
+    [additionalProperty: string]: string | ("workflow_origins" | "workflows") | string[] | string | ("feeds" | "workflows") | External$CreateRequest | null | undefined;
+};
+export declare const Schemas$CreateRequest: {
+    in: z.ZodType<CreateRequest, z.ZodTypeDef, unknown>;
+    out: z.ZodType<External$CreateRequest, z.ZodTypeDef, CreateRequest>;
+};

package/dist/resources/subscriptions/events/request-types.js

@@ -0,0 +1,179 @@
+"use strict";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schemas$CreateRequest = exports.Schemas$GetRequest = exports.Schemas$ListRequest = exports.Schemas$DeleteRequest = void 0;
+const make_api_request_js_1 = require("make-api-request-js");
+const z = __importStar(require("zod"));
+/**
+ * Takes network data, validates it, and transforms keys to match typescript object DeleteRequest
+ */
+const SchemaIn$DeleteRequest = z
+    .object({
+    id: z.string(),
+})
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        id: "id",
+    });
+});
+/**
+ * @internal
+ * Takes typescript data, validates it, and maps keys to match the expected external object External$DeleteRequest
+ */
+const SchemaOut$DeleteRequest = z
+    .object({
+    id: z.string(),
+})
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        id: "id",
+    });
+});
+exports.Schemas$DeleteRequest = {
+    in: SchemaIn$DeleteRequest,
+    out: SchemaOut$DeleteRequest,
+};
+/**
+ * Takes network data, validates it, and transforms keys to match typescript object ListRequest
+ */
+const SchemaIn$ListRequest = z
+    .object({
+    limit: z.number().optional(),
+    page: z.number().optional(),
+})
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        limit: "limit",
+        page: "page",
+    });
+});
+/**
+ * @internal
+ * Takes typescript data, validates it, and maps keys to match the expected external object External$ListRequest
+ */
+const SchemaOut$ListRequest = z
+    .object({
+    limit: z.number().optional(),
+    page: z.number().optional(),
+})
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        limit: "limit",
+        page: "page",
+    });
+});
+exports.Schemas$ListRequest = {
+    in: SchemaIn$ListRequest,
+    out: SchemaOut$ListRequest,
+};
+/**
+ * Takes network data, validates it, and transforms keys to match typescript object GetRequest
+ */
+const SchemaIn$GetRequest = z
+    .object({
+    id: z.string(),
+})
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        id: "id",
+    });
+});
+/**
+ * @internal
+ * Takes typescript data, validates it, and maps keys to match the expected external object External$GetRequest
+ */
+const SchemaOut$GetRequest = z
+    .object({
+    id: z.string(),
+})
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        id: "id",
+    });
+});
+exports.Schemas$GetRequest = {
+    in: SchemaIn$GetRequest,
+    out: SchemaOut$GetRequest,
+};
+/**
+ * Takes network data, validates it, and transforms keys to match typescript object CreateRequest
+ */
+const SchemaIn$CreateRequest = z
+    .object({
+    consumer_id: z.string(),
+    consumer_type: z.enum(["workflow_origins", "workflows"]),
+    events: z.array(z.string()),
+    producer_id: z.string(),
+    producer_type: z.enum(["feeds", "workflows"]),
+})
+    .catchall(make_api_request_js_1.zodRequiredAny)
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        consumer_id: "consumerId",
+        consumer_type: "consumerType",
+        events: "events",
+        producer_id: "producerId",
+        producer_type: "producerType",
+    });
+});
+/**
+ * @internal
+ * Takes typescript data, validates it, and maps keys to match the expected external object External$CreateRequest
+ */
+const SchemaOut$CreateRequest = z
+    .object({
+    consumerId: z.string(),
+    consumerType: z.enum(["workflow_origins", "workflows"]),
+    events: z.array(z.string()),
+    producerId: z.string(),
+    producerType: z.enum(["feeds", "workflows"]),
+})
+    .catchall(make_api_request_js_1.zodRequiredAny)
+    .transform((obj) => {
+    return (0, make_api_request_js_1.zodTransform)(obj, {
+        consumerId: "consumer_id",
+        consumerType: "consumer_type",
+        events: "events",
+        producerId: "producer_id",
+        producerType: "producer_type",
+    });
+});
+exports.Schemas$CreateRequest = {
+    in: SchemaIn$CreateRequest,
+    out: SchemaOut$CreateRequest,
+};

package/dist/resources/subscriptions/events/resource-client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+import { ApiPromise, CoreClient, CoreResourceClient, RequestOptions, ResourceClientOptions } from "make-api-request-js";
+import * as requests from "../../../resources/subscriptions/events/request-types";
+import * as types from "../../../types";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+export declare class EventsClient extends CoreResourceClient {
+    constructor(coreClient: CoreClient, opts: ResourceClientOptions);
+    /**
+     * Delete an event subscription
+     *
+     * Delete an event subscription by its ID.
+     *
+     * DELETE /subscriptions/events/{id}
+     */
+    delete(request: requests.DeleteRequest, opts?: RequestOptions): ApiPromise<types.SubscriptionsEventsDeleteResponse>;
+    /**
+     * List event subscriptions
+     *
+     * Retrieve a paginated list of event subscriptions for the authenticated user.
+     *
+     * GET /subscriptions/events
+     */
+    list(request?: requests.ListRequest, opts?: RequestOptions): ApiPromise<types.SubscriptionsEventsListResponseItem[]>;
+    /**
+     * Get an event subscription
+     *
+     * Retrieve a single event subscription by its ID.
+     *
+     * GET /subscriptions/events/{id}
+     */
+    get(request: requests.GetRequest, opts?: RequestOptions): ApiPromise<types.SubscriptionsEventsGetResponse>;
+    /**
+     * Create an event subscription
+     *
+     * Create a new event subscription that links a producer to a consumer via event patterns.
+     *
+     * POST /subscriptions/events
+     */
+    create(request: requests.CreateRequest, opts?: RequestOptions): ApiPromise<types.SubscriptionsEventsCreateResponse>;
+}

package/dist/resources/subscriptions/events/resource-client.js

@@ -0,0 +1,135 @@
+"use strict";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventsClient = void 0;
+const make_api_request_js_1 = require("make-api-request-js");
+const z = __importStar(require("zod"));
+const subscriptions_events_create_body_1 = require("../../../types/subscriptions-events-create-body");
+const subscriptions_events_create_response_1 = require("../../../types/subscriptions-events-create-response");
+const subscriptions_events_delete_response_1 = require("../../../types/subscriptions-events-delete-response");
+const subscriptions_events_get_response_1 = require("../../../types/subscriptions-events-get-response");
+const subscriptions_events_list_response_item_1 = require("../../../types/subscriptions-events-list-response-item");
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+class EventsClient extends make_api_request_js_1.CoreResourceClient {
+    constructor(coreClient, opts) {
+        super(coreClient, opts);
+    }
+    /**
+     * Delete an event subscription
+     *
+     * Delete an event subscription by its ID.
+     *
+     * DELETE /subscriptions/events/{id}
+     */
+    delete(request, opts) {
+        return this._client.makeRequest({
+            method: "delete",
+            path: `/subscriptions/events/${request.id}`,
+            auth: ["ApiKeyAuth", "BearerAuth"],
+            responseSchema: subscriptions_events_delete_response_1.Schemas$SubscriptionsEventsDeleteResponse.in,
+            opts,
+        });
+    }
+    /**
+     * List event subscriptions
+     *
+     * Retrieve a paginated list of event subscriptions for the authenticated user.
+     *
+     * GET /subscriptions/events
+     */
+    list(request = {}, opts) {
+        return this._client.makeRequest({
+            method: "get",
+            path: "/subscriptions/events",
+            auth: ["ApiKeyAuth", "BearerAuth"],
+            query: [
+                (0, make_api_request_js_1.encodeQueryParam)({
+                    name: "limit",
+                    value: z.number().optional().parse(request.limit),
+                    style: "form",
+                    explode: true,
+                }),
+                (0, make_api_request_js_1.encodeQueryParam)({
+                    name: "page",
+                    value: z.number().optional().parse(request.page),
+                    style: "form",
+                    explode: true,
+                }),
+            ],
+            responseSchema: z.array(subscriptions_events_list_response_item_1.Schemas$SubscriptionsEventsListResponseItem.in),
+            opts,
+        });
+    }
+    /**
+     * Get an event subscription
+     *
+     * Retrieve a single event subscription by its ID.
+     *
+     * GET /subscriptions/events/{id}
+     */
+    get(request, opts) {
+        return this._client.makeRequest({
+            method: "get",
+            path: `/subscriptions/events/${request.id}`,
+            auth: ["ApiKeyAuth", "BearerAuth"],
+            responseSchema: subscriptions_events_get_response_1.Schemas$SubscriptionsEventsGetResponse.in,
+            opts,
+        });
+    }
+    /**
+     * Create an event subscription
+     *
+     * Create a new event subscription that links a producer to a consumer via event patterns.
+     *
+     * POST /subscriptions/events
+     */
+    create(request, opts) {
+        return this._client.makeRequest({
+            method: "post",
+            path: "/subscriptions/events",
+            auth: ["ApiKeyAuth", "BearerAuth"],
+            contentType: "application/json",
+            body: subscriptions_events_create_body_1.Schemas$SubscriptionsEventsCreateBody.out.parse(request),
+            responseSchema: subscriptions_events_create_response_1.Schemas$SubscriptionsEventsCreateResponse.in,
+            opts,
+        });
+    }
+}
+exports.EventsClient = EventsClient;

package/dist/resources/subscriptions/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generated by Sideko (sideko.dev)
+ **/
+export * as events from "./events";
+export { SubscriptionsClient } from "./resource-client";
+/**
+ * Generated by Sideko (sideko.dev)
+ **/