@usepylon/sdk 0.1.0-beta.1 → 0.1.0-beta.2

package/dist/esm/api/types/ErrorApiResponseBody.d.ts

@@ -1,15 +1,21 @@
+import type * as Pylon from "../index.js";
 export interface ErrorApiResponseBody {
     /**
      * A stable machine-readable identifier for this failure, safe to branch on
      * instead of the message text. Omitted when the failure has no assigned code.
      *
-     * Known values: `recipients_suppressed`, `email_bounced`, `internal_issue_reply_not_allowed`, `duplicate_object`, `invalid_authorization_header`, `invalid_api_token`, `invalid_oauth_token`, `wrong_region_token`, `organization_deactivated`, `organization_suspended`, `permission_denied`, `oauth_not_permitted`, `rate_limited`, `not_found`, `method_not_allowed`, `payload_too_large`, `invalid_request_body`, `internal_error`, `invalid_webhook_credentials`, `organization_inactive`. This list is not exhaustive.
+     * Known values: `recipients_suppressed`, `email_bounced`, `internal_issue_reply_not_allowed`, `duplicate_object`, `invalid_authorization_header`, `invalid_api_token`, `invalid_oauth_token`, `wrong_region_token`, `organization_deactivated`, `organization_suspended`, `permission_denied`, `oauth_not_permitted`, `rate_limited`, `not_found`, `method_not_allowed`, `payload_too_large`, `invalid_request_body`, `internal_error`, `invalid_webhook_credentials`, `organization_inactive`, `invalid_filter`. This list is not exhaustive.
      */
     code?: string | undefined;
     /** The list of errors. */
     errors?: string[] | undefined;
     /** The ID of the object that already exists if this is a duplicate object error. */
     exists_id?: string | undefined;
+    /**
+     * One entry per problem found in the request's filter. Present only when code is
+     * "invalid_filter"; errors carries the same messages as plain text.
+     */
+    filter_errors?: Pylon.FilterError[] | undefined;
     /** The request ID for tracking. */
     request_id: string;
 }

package/dist/esm/api/types/Filter.d.ts

@@ -7,8 +7,9 @@ export interface Filter {
      * field must be set, along with either value or values, depending on the operator.
      */
     field?: string | undefined;
-    /** The operator for this filter. */
-    operator: Filter.Operator;
+    /** The operator for this filter. Required unless related_object is set. */
+    operator?: Filter.Operator | undefined;
+    related_object?: Pylon.FilterRelatedObject | undefined;
     /**
      * Sub-filters for this filter.  Valid only when operator is "and", "or", or "not"; "not"
      * takes exactly one subfilter.
@@ -21,6 +22,8 @@ export interface Filter {
      * "starts_with", "ends_with", "time_is_after", "time_is_before", "time_is_in_last",
      * "time_is_not_in_last", "time_is_in_next", "time_is_not_in_next", "greater_than",
      * "less_than", "greater_than_or_equals", and "less_than_or_equals".
+     * On fields that hold user IDs, "current_user" means the API token's user; on fields that
+     * hold team IDs, "my_teams" means that user's teams. The same applies to values.
      */
     value?: string | undefined;
     /**
@@ -30,7 +33,7 @@ export interface Filter {
     values?: string[] | undefined;
 }
 export declare namespace Filter {
-    /** The operator for this filter. */
+    /** The operator for this filter. Required unless related_object is set. */
     const Operator: {
         readonly Equals: "equals";
         readonly NotEquals: "not_equals";

package/dist/esm/api/types/Filter.js

@@ -1,7 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 export var Filter;
 (function (Filter) {
-    /** The operator for this filter. */
+    /** The operator for this filter. Required unless related_object is set. */
     Filter.Operator = {
         Equals: "equals",
         NotEquals: "not_equals",

package/dist/esm/api/types/FilterError.d.ts

@@ -0,0 +1,26 @@
+export interface FilterError {
+    /**
+     * What is accepted in place of the rejected field, operator, value, or relationship.
+     * Long lists are cut off after 100 entries.
+     */
+    allowed?: string[] | undefined;
+    /**
+     * A stable machine-readable identifier for this problem.
+     *
+     * Known values: `invalid_shape`, `too_deep`, `unknown_operator`, `unknown_field`, `operator_not_allowed`, `missing_value`, `unexpected_value`, `invalid_value`, `unknown_relationship`, `unsupported`. This list is not exhaustive.
+     */
+    code: string;
+    /** The field of the filter at path, when it has one. */
+    field?: string | undefined;
+    /** What is wrong and how to fix it. */
+    message: string;
+    /** The operator of the filter at path, when it has one. */
+    operator?: string | undefined;
+    /**
+     * Where the problem is, as a JSONPath from the root of the filter, such as
+     * "$.subfilters[1].related_object.filter".
+     */
+    path: string;
+    /** The accepted entry closest to the rejected one, when one is close enough. */
+    suggestion?: string | undefined;
+}

package/dist/esm/api/types/FilterError.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/FilterRelatedObject.d.ts

@@ -0,0 +1,14 @@
+import type * as Pylon from "../index.js";
+export interface FilterRelatedObject {
+    /**
+     * The slug of a relationship custom field to follow. Returned when reading stored filters,
+     * such as ticket form conditions; search filters don't accept it yet.
+     */
+    custom_field?: string | undefined;
+    filter: Pylon.Filter;
+    /**
+     * The built-in relationship to follow, such as "account". Each search endpoint lists the
+     * relationships its filter accepts. Exactly one of relationship and custom_field is set.
+     */
+    relationship?: string | undefined;
+}

package/dist/esm/api/types/FilterRelatedObject.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GetCustomerPortalSettingsResponseBody.d.ts

@@ -0,0 +1,6 @@
+import type * as Pylon from "../index.js";
+export interface GetCustomerPortalSettingsResponseBody {
+    data: Pylon.CustomerPortalSettings;
+    /** The request ID for tracking. */
+    request_id: string;
+}

package/dist/esm/api/types/GetCustomerPortalSettingsResponseBody.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/IssueThread.d.ts

@@ -6,6 +6,12 @@
 export interface IssueThread {
     /** The ID of the channel that the thread belongs to, if the thread is being synced with a chat platform. */
     channel_id?: string | undefined;
+    /**
+     * The destination for messages in this thread, such as slack, email, or linear. None for Pylon-only threads.
+     *
+     * Known values: `email`, `slack`, `chat_widget`, `customer_portal`, `none`, `microsoft_teams`, `microsoft_teams_chat`, `discord`, `google_chat`, `whatsapp`, `telegram`, `sms`, `linear`, `jira`, `github`, `asana`, `shortcut`, `zendesk`, `salesforce_service`, `intercom`, `freshdesk`, `jira_service_management`, `hubspot_service`. This list is not exhaustive.
+     */
+    delivery_mode: string;
     /** The ID of the thread. */
     id: string;
     /** The issue ID that the thread belongs to. */

package/dist/esm/api/types/TicketFormLayoutField.d.ts

@@ -11,9 +11,17 @@ export interface TicketFormLayoutField {
     hidden: boolean;
     /** The name of the ticket form layout field. */
     name: string;
+    /**
+     * The URL query parameter used to prefill this field on the public form.
+     * Derived from the form's display label and changes when that label is renamed.
+     */
+    prefill_key: string;
     /** Indicates whether the field is required when submitting the ticket form. */
     required: boolean;
-    /** The slug of the ticket form layout field. */
+    /**
+     * The field identifier used for API submissions and visibility conditions.
+     * For custom fields, this is the underlying custom-field slug.
+     */
     slug: string;
     /** The type of the ticket form layout field. */
     type: string;

package/dist/esm/api/types/UpdateCustomerPortalAccessSettings.d.ts

@@ -0,0 +1,16 @@
+export interface UpdateCustomerPortalAccessSettings {
+    /**
+     * Whether new contacts get portal access with the default role when they are created. Applies only to contacts whose email
+     * domain matches their account.
+     */
+    auto_grant_new_contacts?: boolean | undefined;
+    /** Whether someone without a contact who logs in to the portal gets one created, if their email domain matches an existing account. */
+    create_contacts_on_login?: boolean | undefined;
+    /**
+     * The portal role contacts get when they are granted access without an explicit role: `no_access`, `member`, `admin`, or a
+     * custom role's slug or ID. Hidden roles cannot be the default.
+     */
+    default_role?: string | undefined;
+    /** Whether contacts granted access automatically are emailed a portal invitation. */
+    invite_auto_granted_contacts?: boolean | undefined;
+}

package/dist/esm/api/types/UpdateCustomerPortalAccessSettings.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UpdateCustomerPortalBranding.d.ts

@@ -0,0 +1,14 @@
+export interface UpdateCustomerPortalBranding {
+    /** The brand color as a 6-digit hex code, such as `#1A2B3C`. An empty string clears it. */
+    brand_color?: string | undefined;
+    /** The footer logo used in dark mode. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
+    dark_mode_footer_logo_url?: string | undefined;
+    /** The header logo used in dark mode. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
+    dark_mode_logo_url?: string | undefined;
+    /** The footer logo. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
+    footer_logo_url?: string | undefined;
+    /** Where the header logo links to. Must be an http or https URL; an empty string makes the logo not a link. */
+    logo_link_url?: string | undefined;
+    /** The header logo. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
+    logo_url?: string | undefined;
+}

package/dist/esm/api/types/UpdateCustomerPortalBranding.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UpdateCustomerPortalDisplaySettings.d.ts

@@ -0,0 +1,8 @@
+export interface UpdateCustomerPortalDisplaySettings {
+    /** Whether the portal shows feature request descriptions. */
+    feature_request_descriptions?: boolean | undefined;
+    /** Whether portal tasks show their linked issues. */
+    task_linked_issues?: boolean | undefined;
+    /** Whether portal tasks show their linked tasks. */
+    task_linked_tasks?: boolean | undefined;
+}

package/dist/esm/api/types/UpdateCustomerPortalDisplaySettings.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UpdateCustomerPortalNavigation.d.ts

@@ -0,0 +1,7 @@
+import type * as Pylon from "../index.js";
+export interface UpdateCustomerPortalNavigation {
+    /** The link groups in the portal footer, in order. Replaces the existing groups; an empty array removes them. */
+    footer_categories?: Pylon.CustomerPortalFooterCategory[] | undefined;
+    /** The links in the portal header, in order. Replaces the existing links; an empty array removes them. */
+    header_links?: Pylon.CustomerPortalLink[] | undefined;
+}

package/dist/esm/api/types/UpdateCustomerPortalNavigation.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UpdateCustomerPortalTabs.d.ts

@@ -0,0 +1,8 @@
+export interface UpdateCustomerPortalTabs {
+    /** Whether the portal shows the feature requests tab. */
+    feature_requests?: boolean | undefined;
+    /** Whether the portal shows the issues tab. */
+    issues?: boolean | undefined;
+    /** Whether the portal shows the projects and tasks tab. */
+    projects_and_tasks?: boolean | undefined;
+}

package/dist/esm/api/types/UpdateCustomerPortalTabs.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UpdateCustomerPortalUserPermissions.d.ts

@@ -0,0 +1,8 @@
+export interface UpdateCustomerPortalUserPermissions {
+    /** Whether portal users can edit their own profile. */
+    edit_profile?: boolean | undefined;
+    /** Whether portal users can edit the CC list on their replies. */
+    edit_reply_ccs?: boolean | undefined;
+    /** Whether portal users can export their issues as CSV. */
+    export_issues_csv?: boolean | undefined;
+}

package/dist/esm/api/types/UpdateCustomerPortalUserPermissions.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -62,7 +62,16 @@ export * from "./CrmDetails.js";
 export * from "./CrmSettings.js";
 export * from "./CsatResponse.js";
 export * from "./CustomActivity.js";
+export * from "./CustomerPortalAccessSettings.js";
+export * from "./CustomerPortalBranding.js";
+export * from "./CustomerPortalDisplaySettings.js";
+export * from "./CustomerPortalFooterCategory.js";
 export * from "./CustomerPortalInvitationResult.js";
+export * from "./CustomerPortalLink.js";
+export * from "./CustomerPortalNavigation.js";
+export * from "./CustomerPortalSettings.js";
+export * from "./CustomerPortalTabs.js";
+export * from "./CustomerPortalUserPermissions.js";
 export * from "./CustomFieldDefinition.js";
 export * from "./CustomFieldDefinitionSelectOption.js";
 export * from "./CustomFieldValue.js";
@@ -104,6 +113,8 @@ export * from "./FeatureRequest.js";
 export * from "./FeatureRequestEvidence.js";
 export * from "./FeatureRequestSearchResult.js";
 export * from "./Filter.js";
+export * from "./FilterError.js";
+export * from "./FilterRelatedObject.js";
 export * from "./Follower.js";
 export * from "./GetAccountNotebookNotesResponseBody.js";
 export * from "./GetAccountRelationshipsResponseBody.js";
@@ -120,6 +131,7 @@ export * from "./GetCollectionResponseBody.js";
 export * from "./GetCollectionsResponseBody.js";
 export * from "./GetContactResponseBody.js";
 export * from "./GetContactsResponseBody.js";
+export * from "./GetCustomerPortalSettingsResponseBody.js";
 export * from "./GetCustomFieldResponseBody.js";
 export * from "./GetCustomFieldsResponseBody.js";
 export * from "./GetCustomObjectResponseBody.js";
@@ -279,6 +291,12 @@ export * from "./UpdateCallRecordingResponseBody.js";
 export * from "./UpdateCollectionResponseBody.js";
 export * from "./UpdateContactEmail.js";
 export * from "./UpdateContactResponseBody.js";
+export * from "./UpdateCustomerPortalAccessSettings.js";
+export * from "./UpdateCustomerPortalBranding.js";
+export * from "./UpdateCustomerPortalDisplaySettings.js";
+export * from "./UpdateCustomerPortalNavigation.js";
+export * from "./UpdateCustomerPortalTabs.js";
+export * from "./UpdateCustomerPortalUserPermissions.js";
 export * from "./UpdateCustomFieldResponseBody.js";
 export * from "./UpdateCustomFieldSelectOptionResponseBody.js";
 export * from "./UpdateCustomObjectResponseBody.js";

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

@@ -62,7 +62,16 @@ export * from "./CrmDetails.js";
 export * from "./CrmSettings.js";
 export * from "./CsatResponse.js";
 export * from "./CustomActivity.js";
+export * from "./CustomerPortalAccessSettings.js";
+export * from "./CustomerPortalBranding.js";
+export * from "./CustomerPortalDisplaySettings.js";
+export * from "./CustomerPortalFooterCategory.js";
 export * from "./CustomerPortalInvitationResult.js";
+export * from "./CustomerPortalLink.js";
+export * from "./CustomerPortalNavigation.js";
+export * from "./CustomerPortalSettings.js";
+export * from "./CustomerPortalTabs.js";
+export * from "./CustomerPortalUserPermissions.js";
 export * from "./CustomFieldDefinition.js";
 export * from "./CustomFieldDefinitionSelectOption.js";
 export * from "./CustomFieldValue.js";
@@ -104,6 +113,8 @@ export * from "./FeatureRequest.js";
 export * from "./FeatureRequestEvidence.js";
 export * from "./FeatureRequestSearchResult.js";
 export * from "./Filter.js";
+export * from "./FilterError.js";
+export * from "./FilterRelatedObject.js";
 export * from "./Follower.js";
 export * from "./GetAccountNotebookNotesResponseBody.js";
 export * from "./GetAccountRelationshipsResponseBody.js";
@@ -120,6 +131,7 @@ export * from "./GetCollectionResponseBody.js";
 export * from "./GetCollectionsResponseBody.js";
 export * from "./GetContactResponseBody.js";
 export * from "./GetContactsResponseBody.js";
+export * from "./GetCustomerPortalSettingsResponseBody.js";
 export * from "./GetCustomFieldResponseBody.js";
 export * from "./GetCustomFieldsResponseBody.js";
 export * from "./GetCustomObjectResponseBody.js";
@@ -279,6 +291,12 @@ export * from "./UpdateCallRecordingResponseBody.js";
 export * from "./UpdateCollectionResponseBody.js";
 export * from "./UpdateContactEmail.js";
 export * from "./UpdateContactResponseBody.js";
+export * from "./UpdateCustomerPortalAccessSettings.js";
+export * from "./UpdateCustomerPortalBranding.js";
+export * from "./UpdateCustomerPortalDisplaySettings.js";
+export * from "./UpdateCustomerPortalNavigation.js";
+export * from "./UpdateCustomerPortalTabs.js";
+export * from "./UpdateCustomerPortalUserPermissions.js";
 export * from "./UpdateCustomFieldResponseBody.js";
 export * from "./UpdateCustomFieldSelectOptionResponseBody.js";
 export * from "./UpdateCustomObjectResponseBody.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usepylon/sdk",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.2",
   "description": "Official TypeScript SDK for the Pylon API",
   "license": "MIT",
   "homepage": "https://docs.usepylon.com",