@usepylon/sdk 0.0.0-stage → 0.1.0-alpha.3

package/dist/esm/api/resources/customFields/types/ListCustomFieldsRequestObjectType.js

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListCustomFieldsRequestObjectType = {
+    Account: "account",
+    Issue: "issue",
+    Contact: "contact",
+    Task: "task",
+    Project: "project",
+    Meeting: "meeting",
+    Opportunity: "opportunity",
+};

package/dist/esm/api/resources/customFields/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./ListCustomFieldsRequestObjectType.js";

package/dist/esm/api/resources/customFields/types/index.js

@@ -0,0 +1 @@
+export * from "./ListCustomFieldsRequestObjectType.js";

package/dist/esm/api/resources/customObjects/client/Client.d.ts

@@ -0,0 +1,201 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pylon from "../../../index.js";
+export declare namespace CustomObjectsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class CustomObjectsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<CustomObjectsClient.Options>;
+    constructor(options: CustomObjectsClient.Options);
+    /**
+     * Returns paginated custom objects of the given type.
+     *
+     * **Rate limit:** 300 requests per minute
+     *
+     * @param {Pylon.CustomObjectsListRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.list({
+     *         type: "type"
+     *     })
+     */
+    list(request: Pylon.CustomObjectsListRequest, requestOptions?: CustomObjectsClient.RequestOptions): Promise<core.Page<Pylon.ApiCustomObject, Pylon.GetCustomObjectsResponseBody>>;
+    /**
+     * Creates a new custom object instance of the given type. To link the object to an account, pass the built-in Account relationship field in `custom_fields`: `{"name":"Example","custom_fields":{"account":{"value":"account_uuid"}}}`.
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {Pylon.CustomObjectsCreateRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.create({
+     *         type: "type",
+     *         name: "name"
+     *     })
+     */
+    create(request: Pylon.CustomObjectsCreateRequest, requestOptions?: CustomObjectsClient.RequestOptions): core.HttpResponsePromise<Pylon.CreateCustomObjectResponseBody>;
+    private __create;
+    /**
+     * Applies the same update to multiple custom objects of the given type in a single request. Pass between 1 and 100 IDs and the custom field values to set; only the provided fields are modified on each object. To update the linked account, pass the built-in Account relationship field in `custom_fields`: `{"ids":["object_uuid"],"custom_fields":{"account":{"value":"account_uuid"}}}`. To unset a field, pass its slug with an empty value.
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {Pylon.CustomObjectsBulkUpdateRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.bulkUpdate({
+     *         type: "type",
+     *         ids: ["ids"]
+     *     })
+     */
+    bulkUpdate(request: Pylon.CustomObjectsBulkUpdateRequest, requestOptions?: CustomObjectsClient.RequestOptions): core.HttpResponsePromise<Pylon.UpdateCustomObjectsResponseBody>;
+    private __bulkUpdate;
+    /**
+     * Filterable fields and their allowed operators:
+     *
+     *  Field | Allowed operators |
+     *  --- | --- |
+     *  `name` | `equals`, `in`, `not_in`, `string_contains`, `string_does_not_contain`, `is_set`, `is_unset` |
+     *  `account` | `equals`, `in`, `not_in`, `is_set`, `is_unset` |
+     *  `created_at` | `time_is_after`, `time_is_before`, `time_range` |
+     *  `updated_at` | `time_is_after`, `time_is_before`, `time_range` |
+     *
+     * `account` is the built-in Account relationship field present on every custom object type; its values are account IDs.
+     * Timestamp values use RFC3339 format. For custom fields, pass the field slug as `field`.
+     *
+     * A `{type}` of `opportunity` is an alias for the opportunities API and filters on a different set of fields:
+     *
+     *  Field | Allowed operators |
+     *  --- | --- |
+     *  `name` | `equals`, `in`, `not_in`, `string_contains` |
+     *  `account_id` | `equals`, `in`, `not_in` |
+     *  `source` | `equals`, `in`, `not_in` |
+     *  `created_at` | `time_is_after`, `time_is_before`, `time_range` |
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {Pylon.CustomObjectsSearchRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.search({
+     *         type: "type"
+     *     })
+     */
+    search(request: Pylon.CustomObjectsSearchRequest, requestOptions?: CustomObjectsClient.RequestOptions): Promise<core.Page<Pylon.ApiCustomObject, Pylon.SearchCustomObjectsResponseBody>>;
+    /**
+     * Returns a single custom object by ID, including its custom field values.
+     *
+     * **Rate limit:** 300 requests per minute
+     *
+     * @param {Pylon.CustomObjectsGetRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.get({
+     *         type: "type",
+     *         id: "id"
+     *     })
+     */
+    get(request: Pylon.CustomObjectsGetRequest, requestOptions?: CustomObjectsClient.RequestOptions): core.HttpResponsePromise<Pylon.GetCustomObjectResponseBody>;
+    private __get;
+    /**
+     * Deletes a custom object instance.
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {Pylon.CustomObjectsDeleteRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.delete({
+     *         type: "type",
+     *         id: "id"
+     *     })
+     */
+    delete(request: Pylon.CustomObjectsDeleteRequest, requestOptions?: CustomObjectsClient.RequestOptions): core.HttpResponsePromise<Pylon.DeleteCustomObjectResponseBody>;
+    private __delete;
+    /**
+     * Updates a custom object. Only provided fields are modified. To update the linked account, pass the built-in Account relationship field in `custom_fields`: `{"custom_fields":{"account":{"value":"account_uuid"}}}`.
+     *
+     * **Rate limit:** 120 requests per minute
+     *
+     * @param {Pylon.CustomObjectsUpdateRequest} request
+     * @param {CustomObjectsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pylon.BadRequestError}
+     * @throws {@link Pylon.UnauthorizedError}
+     * @throws {@link Pylon.ForbiddenError}
+     * @throws {@link Pylon.NotFoundError}
+     * @throws {@link Pylon.TooManyRequestsError}
+     * @throws {@link Pylon.InternalServerError}
+     * @throws {@link errors.PylonError}
+     * @throws {@link errors.PylonTimeoutError}
+     *
+     * @example
+     *     await client.customObjects.update({
+     *         type: "type",
+     *         id: "id"
+     *     })
+     */
+    update(request: Pylon.CustomObjectsUpdateRequest, requestOptions?: CustomObjectsClient.RequestOptions): core.HttpResponsePromise<Pylon.UpdateCustomObjectResponseBody>;
+    private __update;
+}