@usepylon/sdk 0.1.0-alpha.5 → 0.1.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/dist/cjs/BaseClient.js +1 -1
  2. package/dist/cjs/Client.d.ts +3 -0
  3. package/dist/cjs/Client.js +51 -46
  4. package/dist/cjs/api/resources/accounts/client/requests/AccountsSearchRequest.d.ts +2 -0
  5. package/dist/cjs/api/resources/contacts/client/Client.d.ts +25 -1
  6. package/dist/cjs/api/resources/contacts/client/Client.js +74 -1
  7. package/dist/cjs/api/resources/contacts/client/requests/ContactsMergeRequest.d.ts +1 -1
  8. package/dist/cjs/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.d.ts +10 -0
  9. package/dist/cjs/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.js +3 -0
  10. package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
  11. package/dist/cjs/api/resources/customerPortal/client/Client.d.ts +53 -0
  12. package/dist/cjs/api/resources/customerPortal/client/Client.js +193 -0
  13. package/dist/cjs/api/resources/customerPortal/client/index.d.ts +1 -0
  14. package/dist/cjs/api/resources/customerPortal/client/index.js +17 -0
  15. package/dist/cjs/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.d.ts +15 -0
  16. package/dist/cjs/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.js +3 -0
  17. package/dist/cjs/api/resources/customerPortal/client/requests/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/customerPortal/client/requests/index.js +2 -0
  19. package/dist/cjs/api/resources/customerPortal/exports.d.ts +2 -0
  20. package/dist/cjs/api/resources/customerPortal/exports.js +21 -0
  21. package/dist/cjs/api/resources/customerPortal/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/customerPortal/index.js +17 -0
  23. package/dist/cjs/api/resources/index.d.ts +2 -0
  24. package/dist/cjs/api/resources/index.js +3 -1
  25. package/dist/cjs/api/resources/issues/client/Client.d.ts +11 -0
  26. package/dist/cjs/api/resources/issues/client/Client.js +11 -0
  27. package/dist/cjs/api/resources/issues/client/requests/IssuesCreateRequest.d.ts +11 -0
  28. package/dist/cjs/api/resources/issues/client/requests/IssuesSearchRequest.d.ts +2 -0
  29. package/dist/cjs/api/resources/issues/resources/voiceCalls/client/Client.d.ts +1 -1
  30. package/dist/cjs/api/resources/issues/resources/voiceCalls/client/Client.js +1 -1
  31. package/dist/cjs/api/resources/teams/client/Client.d.ts +26 -0
  32. package/dist/cjs/api/resources/teams/client/Client.js +72 -0
  33. package/dist/cjs/api/resources/teams/client/requests/TeamsDeleteRequest.d.ts +10 -0
  34. package/dist/cjs/api/resources/teams/client/requests/TeamsDeleteRequest.js +3 -0
  35. package/dist/cjs/api/resources/teams/client/requests/index.d.ts +1 -0
  36. package/dist/cjs/api/resources/users/client/Client.d.ts +25 -0
  37. package/dist/cjs/api/resources/users/client/Client.js +71 -0
  38. package/dist/cjs/api/resources/users/client/requests/UsersInviteRequest.d.ts +15 -0
  39. package/dist/cjs/api/resources/users/client/requests/UsersInviteRequest.js +3 -0
  40. package/dist/cjs/api/resources/users/client/requests/index.d.ts +1 -0
  41. package/dist/cjs/api/types/ArticleVisibilityConfig.d.ts +5 -0
  42. package/dist/cjs/api/types/CustomerPortalAccessSettings.d.ts +16 -0
  43. package/dist/cjs/api/types/CustomerPortalAccessSettings.js +3 -0
  44. package/dist/cjs/api/types/CustomerPortalBranding.d.ts +14 -0
  45. package/dist/cjs/api/types/CustomerPortalBranding.js +3 -0
  46. package/dist/cjs/api/types/CustomerPortalDisplaySettings.d.ts +8 -0
  47. package/dist/cjs/api/types/CustomerPortalDisplaySettings.js +3 -0
  48. package/dist/cjs/api/types/CustomerPortalFooterCategory.d.ts +7 -0
  49. package/dist/cjs/api/types/CustomerPortalFooterCategory.js +3 -0
  50. package/dist/cjs/api/types/CustomerPortalInvitationResult.d.ts +4 -0
  51. package/dist/cjs/api/types/CustomerPortalInvitationResult.js +3 -0
  52. package/dist/cjs/api/types/CustomerPortalLink.d.ts +6 -0
  53. package/dist/cjs/api/types/CustomerPortalLink.js +3 -0
  54. package/dist/cjs/api/types/CustomerPortalNavigation.d.ts +7 -0
  55. package/dist/cjs/api/types/CustomerPortalNavigation.js +3 -0
  56. package/dist/cjs/api/types/CustomerPortalSettings.d.ts +11 -0
  57. package/dist/cjs/api/types/CustomerPortalSettings.js +3 -0
  58. package/dist/cjs/api/types/CustomerPortalTabs.d.ts +8 -0
  59. package/dist/cjs/api/types/CustomerPortalTabs.js +3 -0
  60. package/dist/cjs/api/types/CustomerPortalUserPermissions.d.ts +8 -0
  61. package/dist/cjs/api/types/CustomerPortalUserPermissions.js +3 -0
  62. package/dist/cjs/api/types/DeleteTeamResponseBody.d.ts +4 -0
  63. package/dist/cjs/api/types/DeleteTeamResponseBody.js +3 -0
  64. package/dist/cjs/api/types/DestinationMetadata.d.ts +2 -0
  65. package/dist/cjs/api/types/ErrorApiResponseBody.d.ts +7 -1
  66. package/dist/cjs/api/types/ExternalIssue.d.ts +8 -0
  67. package/dist/cjs/api/types/Filter.d.ts +17 -7
  68. package/dist/cjs/api/types/Filter.js +6 -1
  69. package/dist/cjs/api/types/FilterError.d.ts +26 -0
  70. package/dist/cjs/api/types/FilterError.js +3 -0
  71. package/dist/cjs/api/types/FilterRelatedObject.d.ts +14 -0
  72. package/dist/cjs/api/types/FilterRelatedObject.js +3 -0
  73. package/dist/cjs/api/types/GetCustomerPortalSettingsResponseBody.d.ts +6 -0
  74. package/dist/cjs/api/types/GetCustomerPortalSettingsResponseBody.js +3 -0
  75. package/dist/cjs/api/types/IssueThread.d.ts +6 -0
  76. package/dist/cjs/api/types/SearchAccountsSort.d.ts +23 -0
  77. package/dist/cjs/api/types/SearchAccountsSort.js +20 -0
  78. package/dist/cjs/api/types/SearchIssuesSort.d.ts +23 -0
  79. package/dist/cjs/api/types/SearchIssuesSort.js +20 -0
  80. package/dist/cjs/api/types/SendCustomerPortalInvitationResponseBody.d.ts +6 -0
  81. package/dist/cjs/api/types/SendCustomerPortalInvitationResponseBody.js +3 -0
  82. package/dist/cjs/api/types/Task.d.ts +2 -0
  83. package/dist/cjs/api/types/TicketFormLayoutField.d.ts +11 -1
  84. package/dist/cjs/api/types/UpdateCustomerPortalAccessSettings.d.ts +16 -0
  85. package/dist/cjs/api/types/UpdateCustomerPortalAccessSettings.js +3 -0
  86. package/dist/cjs/api/types/UpdateCustomerPortalBranding.d.ts +14 -0
  87. package/dist/cjs/api/types/UpdateCustomerPortalBranding.js +3 -0
  88. package/dist/cjs/api/types/UpdateCustomerPortalDisplaySettings.d.ts +8 -0
  89. package/dist/cjs/api/types/UpdateCustomerPortalDisplaySettings.js +3 -0
  90. package/dist/cjs/api/types/UpdateCustomerPortalNavigation.d.ts +7 -0
  91. package/dist/cjs/api/types/UpdateCustomerPortalNavigation.js +3 -0
  92. package/dist/cjs/api/types/UpdateCustomerPortalTabs.d.ts +8 -0
  93. package/dist/cjs/api/types/UpdateCustomerPortalTabs.js +3 -0
  94. package/dist/cjs/api/types/UpdateCustomerPortalUserPermissions.d.ts +8 -0
  95. package/dist/cjs/api/types/UpdateCustomerPortalUserPermissions.js +3 -0
  96. package/dist/cjs/api/types/VoiceCall.d.ts +2 -0
  97. package/dist/cjs/api/types/VoiceCallParticipant.d.ts +20 -0
  98. package/dist/cjs/api/types/VoiceCallParticipant.js +3 -0
  99. package/dist/cjs/api/types/index.d.ts +24 -0
  100. package/dist/cjs/api/types/index.js +24 -0
  101. package/dist/esm/BaseClient.js +1 -1
  102. package/dist/esm/Client.d.ts +3 -0
  103. package/dist/esm/Client.js +5 -0
  104. package/dist/esm/api/resources/accounts/client/requests/AccountsSearchRequest.d.ts +2 -0
  105. package/dist/esm/api/resources/contacts/client/Client.d.ts +25 -1
  106. package/dist/esm/api/resources/contacts/client/Client.js +74 -1
  107. package/dist/esm/api/resources/contacts/client/requests/ContactsMergeRequest.d.ts +1 -1
  108. package/dist/esm/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.d.ts +10 -0
  109. package/dist/esm/api/resources/contacts/client/requests/ContactsPortalInvitationRequest.js +2 -0
  110. package/dist/esm/api/resources/contacts/client/requests/index.d.ts +1 -0
  111. package/dist/esm/api/resources/customerPortal/client/Client.d.ts +53 -0
  112. package/dist/esm/api/resources/customerPortal/client/Client.js +156 -0
  113. package/dist/esm/api/resources/customerPortal/client/index.d.ts +1 -0
  114. package/dist/esm/api/resources/customerPortal/client/index.js +1 -0
  115. package/dist/esm/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.d.ts +15 -0
  116. package/dist/esm/api/resources/customerPortal/client/requests/CustomerPortalUpdateSettingsRequest.js +2 -0
  117. package/dist/esm/api/resources/customerPortal/client/requests/index.d.ts +1 -0
  118. package/dist/esm/api/resources/customerPortal/client/requests/index.js +1 -0
  119. package/dist/esm/api/resources/customerPortal/exports.d.ts +2 -0
  120. package/dist/esm/api/resources/customerPortal/exports.js +3 -0
  121. package/dist/esm/api/resources/customerPortal/index.d.ts +1 -0
  122. package/dist/esm/api/resources/customerPortal/index.js +1 -0
  123. package/dist/esm/api/resources/index.d.ts +2 -0
  124. package/dist/esm/api/resources/index.js +2 -0
  125. package/dist/esm/api/resources/issues/client/Client.d.ts +11 -0
  126. package/dist/esm/api/resources/issues/client/Client.js +11 -0
  127. package/dist/esm/api/resources/issues/client/requests/IssuesCreateRequest.d.ts +11 -0
  128. package/dist/esm/api/resources/issues/client/requests/IssuesSearchRequest.d.ts +2 -0
  129. package/dist/esm/api/resources/issues/resources/voiceCalls/client/Client.d.ts +1 -1
  130. package/dist/esm/api/resources/issues/resources/voiceCalls/client/Client.js +1 -1
  131. package/dist/esm/api/resources/teams/client/Client.d.ts +26 -0
  132. package/dist/esm/api/resources/teams/client/Client.js +72 -0
  133. package/dist/esm/api/resources/teams/client/requests/TeamsDeleteRequest.d.ts +10 -0
  134. package/dist/esm/api/resources/teams/client/requests/TeamsDeleteRequest.js +2 -0
  135. package/dist/esm/api/resources/teams/client/requests/index.d.ts +1 -0
  136. package/dist/esm/api/resources/users/client/Client.d.ts +25 -0
  137. package/dist/esm/api/resources/users/client/Client.js +71 -0
  138. package/dist/esm/api/resources/users/client/requests/UsersInviteRequest.d.ts +15 -0
  139. package/dist/esm/api/resources/users/client/requests/UsersInviteRequest.js +2 -0
  140. package/dist/esm/api/resources/users/client/requests/index.d.ts +1 -0
  141. package/dist/esm/api/types/ArticleVisibilityConfig.d.ts +5 -0
  142. package/dist/esm/api/types/CustomerPortalAccessSettings.d.ts +16 -0
  143. package/dist/esm/api/types/CustomerPortalAccessSettings.js +2 -0
  144. package/dist/esm/api/types/CustomerPortalBranding.d.ts +14 -0
  145. package/dist/esm/api/types/CustomerPortalBranding.js +2 -0
  146. package/dist/esm/api/types/CustomerPortalDisplaySettings.d.ts +8 -0
  147. package/dist/esm/api/types/CustomerPortalDisplaySettings.js +2 -0
  148. package/dist/esm/api/types/CustomerPortalFooterCategory.d.ts +7 -0
  149. package/dist/esm/api/types/CustomerPortalFooterCategory.js +2 -0
  150. package/dist/esm/api/types/CustomerPortalInvitationResult.d.ts +4 -0
  151. package/dist/esm/api/types/CustomerPortalInvitationResult.js +2 -0
  152. package/dist/esm/api/types/CustomerPortalLink.d.ts +6 -0
  153. package/dist/esm/api/types/CustomerPortalLink.js +2 -0
  154. package/dist/esm/api/types/CustomerPortalNavigation.d.ts +7 -0
  155. package/dist/esm/api/types/CustomerPortalNavigation.js +2 -0
  156. package/dist/esm/api/types/CustomerPortalSettings.d.ts +11 -0
  157. package/dist/esm/api/types/CustomerPortalSettings.js +2 -0
  158. package/dist/esm/api/types/CustomerPortalTabs.d.ts +8 -0
  159. package/dist/esm/api/types/CustomerPortalTabs.js +2 -0
  160. package/dist/esm/api/types/CustomerPortalUserPermissions.d.ts +8 -0
  161. package/dist/esm/api/types/CustomerPortalUserPermissions.js +2 -0
  162. package/dist/esm/api/types/DeleteTeamResponseBody.d.ts +4 -0
  163. package/dist/esm/api/types/DeleteTeamResponseBody.js +2 -0
  164. package/dist/esm/api/types/DestinationMetadata.d.ts +2 -0
  165. package/dist/esm/api/types/ErrorApiResponseBody.d.ts +7 -1
  166. package/dist/esm/api/types/ExternalIssue.d.ts +8 -0
  167. package/dist/esm/api/types/Filter.d.ts +17 -7
  168. package/dist/esm/api/types/Filter.js +6 -1
  169. package/dist/esm/api/types/FilterError.d.ts +26 -0
  170. package/dist/esm/api/types/FilterError.js +2 -0
  171. package/dist/esm/api/types/FilterRelatedObject.d.ts +14 -0
  172. package/dist/esm/api/types/FilterRelatedObject.js +2 -0
  173. package/dist/esm/api/types/GetCustomerPortalSettingsResponseBody.d.ts +6 -0
  174. package/dist/esm/api/types/GetCustomerPortalSettingsResponseBody.js +2 -0
  175. package/dist/esm/api/types/IssueThread.d.ts +6 -0
  176. package/dist/esm/api/types/SearchAccountsSort.d.ts +23 -0
  177. package/dist/esm/api/types/SearchAccountsSort.js +17 -0
  178. package/dist/esm/api/types/SearchIssuesSort.d.ts +23 -0
  179. package/dist/esm/api/types/SearchIssuesSort.js +17 -0
  180. package/dist/esm/api/types/SendCustomerPortalInvitationResponseBody.d.ts +6 -0
  181. package/dist/esm/api/types/SendCustomerPortalInvitationResponseBody.js +2 -0
  182. package/dist/esm/api/types/Task.d.ts +2 -0
  183. package/dist/esm/api/types/TicketFormLayoutField.d.ts +11 -1
  184. package/dist/esm/api/types/UpdateCustomerPortalAccessSettings.d.ts +16 -0
  185. package/dist/esm/api/types/UpdateCustomerPortalAccessSettings.js +2 -0
  186. package/dist/esm/api/types/UpdateCustomerPortalBranding.d.ts +14 -0
  187. package/dist/esm/api/types/UpdateCustomerPortalBranding.js +2 -0
  188. package/dist/esm/api/types/UpdateCustomerPortalDisplaySettings.d.ts +8 -0
  189. package/dist/esm/api/types/UpdateCustomerPortalDisplaySettings.js +2 -0
  190. package/dist/esm/api/types/UpdateCustomerPortalNavigation.d.ts +7 -0
  191. package/dist/esm/api/types/UpdateCustomerPortalNavigation.js +2 -0
  192. package/dist/esm/api/types/UpdateCustomerPortalTabs.d.ts +8 -0
  193. package/dist/esm/api/types/UpdateCustomerPortalTabs.js +2 -0
  194. package/dist/esm/api/types/UpdateCustomerPortalUserPermissions.d.ts +8 -0
  195. package/dist/esm/api/types/UpdateCustomerPortalUserPermissions.js +2 -0
  196. package/dist/esm/api/types/VoiceCall.d.ts +2 -0
  197. package/dist/esm/api/types/VoiceCallParticipant.d.ts +20 -0
  198. package/dist/esm/api/types/VoiceCallParticipant.js +2 -0
  199. package/dist/esm/api/types/index.d.ts +24 -0
  200. package/dist/esm/api/types/index.js +24 -0
  201. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  export var Filter;
3
3
  (function (Filter) {
4
- /** The operator for this filter. */
4
+ /** The operator for this filter. Required unless related_object is set. */
5
5
  Filter.Operator = {
6
6
  Equals: "equals",
7
7
  NotEquals: "not_equals",
@@ -11,6 +11,7 @@ export var Filter;
11
11
  NotIn: "not_in",
12
12
  And: "and",
13
13
  Or: "or",
14
+ Not: "not",
14
15
  TimeIsAfter: "time_is_after",
15
16
  TimeIsBefore: "time_is_before",
16
17
  TimeRange: "time_range",
@@ -25,5 +26,9 @@ export var Filter;
25
26
  IncludesAllOf: "includes_all_of",
26
27
  StartsWith: "starts_with",
27
28
  EndsWith: "ends_with",
29
+ TimeIsInLast: "time_is_in_last",
30
+ TimeIsNotInLast: "time_is_not_in_last",
31
+ TimeIsInNext: "time_is_in_next",
32
+ TimeIsNotInNext: "time_is_not_in_next",
28
33
  };
29
34
  })(Filter || (Filter = {}));
@@ -0,0 +1,26 @@
1
+ export interface FilterError {
2
+ /**
3
+ * What is accepted in place of the rejected field, operator, value, or relationship.
4
+ * Long lists are cut off after 100 entries.
5
+ */
6
+ allowed?: string[] | undefined;
7
+ /**
8
+ * A stable machine-readable identifier for this problem.
9
+ *
10
+ * 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.
11
+ */
12
+ code: string;
13
+ /** The field of the filter at path, when it has one. */
14
+ field?: string | undefined;
15
+ /** What is wrong and how to fix it. */
16
+ message: string;
17
+ /** The operator of the filter at path, when it has one. */
18
+ operator?: string | undefined;
19
+ /**
20
+ * Where the problem is, as a JSONPath from the root of the filter, such as
21
+ * "$.subfilters[1].related_object.filter".
22
+ */
23
+ path: string;
24
+ /** The accepted entry closest to the rejected one, when one is close enough. */
25
+ suggestion?: string | undefined;
26
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,14 @@
1
+ import type * as Pylon from "../index.js";
2
+ export interface FilterRelatedObject {
3
+ /**
4
+ * The slug of a relationship custom field to follow. Returned when reading stored filters,
5
+ * such as ticket form conditions; search filters don't accept it yet.
6
+ */
7
+ custom_field?: string | undefined;
8
+ filter: Pylon.Filter;
9
+ /**
10
+ * The built-in relationship to follow, such as "account". Each search endpoint lists the
11
+ * relationships its filter accepts. Exactly one of relationship and custom_field is set.
12
+ */
13
+ relationship?: string | undefined;
14
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ import type * as Pylon from "../index.js";
2
+ export interface GetCustomerPortalSettingsResponseBody {
3
+ data: Pylon.CustomerPortalSettings;
4
+ /** The request ID for tracking. */
5
+ request_id: string;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -6,6 +6,12 @@
6
6
  export interface IssueThread {
7
7
  /** The ID of the channel that the thread belongs to, if the thread is being synced with a chat platform. */
8
8
  channel_id?: string | undefined;
9
+ /**
10
+ * The destination for messages in this thread, such as slack, email, or linear. None for Pylon-only threads.
11
+ *
12
+ * 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.
13
+ */
14
+ delivery_mode: string;
9
15
  /** The ID of the thread. */
10
16
  id: string;
11
17
  /** The issue ID that the thread belongs to. */
@@ -0,0 +1,23 @@
1
+ export interface SearchAccountsSort {
2
+ /** The field to sort by. */
3
+ field: SearchAccountsSort.Field;
4
+ /** The sort direction. Defaults to desc. */
5
+ order?: SearchAccountsSort.Order | undefined;
6
+ }
7
+ export declare namespace SearchAccountsSort {
8
+ /** The field to sort by. */
9
+ const Field: {
10
+ readonly Name: "name";
11
+ readonly CreatedAt: "created_at";
12
+ readonly LastCustomerActivityAt: "last_customer_activity_at";
13
+ readonly LastVendorActivityAt: "last_vendor_activity_at";
14
+ readonly IssueCountLast90Days: "issue_count_last_90_days";
15
+ };
16
+ type Field = (typeof Field)[keyof typeof Field];
17
+ /** The sort direction. Defaults to desc. */
18
+ const Order: {
19
+ readonly Asc: "asc";
20
+ readonly Desc: "desc";
21
+ };
22
+ type Order = (typeof Order)[keyof typeof Order];
23
+ }
@@ -0,0 +1,17 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var SearchAccountsSort;
3
+ (function (SearchAccountsSort) {
4
+ /** The field to sort by. */
5
+ SearchAccountsSort.Field = {
6
+ Name: "name",
7
+ CreatedAt: "created_at",
8
+ LastCustomerActivityAt: "last_customer_activity_at",
9
+ LastVendorActivityAt: "last_vendor_activity_at",
10
+ IssueCountLast90Days: "issue_count_last_90_days",
11
+ };
12
+ /** The sort direction. Defaults to desc. */
13
+ SearchAccountsSort.Order = {
14
+ Asc: "asc",
15
+ Desc: "desc",
16
+ };
17
+ })(SearchAccountsSort || (SearchAccountsSort = {}));
@@ -0,0 +1,23 @@
1
+ export interface SearchIssuesSort {
2
+ /** The field to sort by. response_breach_time uses the latest issue-level response SLA (first response, next reply, or follow-up); resolution_breach_time uses the latest issue-level resolution SLA. Issues without a breach time sort last in either direction. Use asc for earliest deadlines first. */
3
+ field: SearchIssuesSort.Field;
4
+ /** The sort direction. Defaults to desc. */
5
+ order?: SearchIssuesSort.Order | undefined;
6
+ }
7
+ export declare namespace SearchIssuesSort {
8
+ /** The field to sort by. response_breach_time uses the latest issue-level response SLA (first response, next reply, or follow-up); resolution_breach_time uses the latest issue-level resolution SLA. Issues without a breach time sort last in either direction. Use asc for earliest deadlines first. */
9
+ const Field: {
10
+ readonly CreatedAt: "created_at";
11
+ readonly UpdatedAt: "updated_at";
12
+ readonly LatestMessageTime: "latest_message_time";
13
+ readonly ResponseBreachTime: "response_breach_time";
14
+ readonly ResolutionBreachTime: "resolution_breach_time";
15
+ };
16
+ type Field = (typeof Field)[keyof typeof Field];
17
+ /** The sort direction. Defaults to desc. */
18
+ const Order: {
19
+ readonly Asc: "asc";
20
+ readonly Desc: "desc";
21
+ };
22
+ type Order = (typeof Order)[keyof typeof Order];
23
+ }
@@ -0,0 +1,17 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var SearchIssuesSort;
3
+ (function (SearchIssuesSort) {
4
+ /** The field to sort by. response_breach_time uses the latest issue-level response SLA (first response, next reply, or follow-up); resolution_breach_time uses the latest issue-level resolution SLA. Issues without a breach time sort last in either direction. Use asc for earliest deadlines first. */
5
+ SearchIssuesSort.Field = {
6
+ CreatedAt: "created_at",
7
+ UpdatedAt: "updated_at",
8
+ LatestMessageTime: "latest_message_time",
9
+ ResponseBreachTime: "response_breach_time",
10
+ ResolutionBreachTime: "resolution_breach_time",
11
+ };
12
+ /** The sort direction. Defaults to desc. */
13
+ SearchIssuesSort.Order = {
14
+ Asc: "asc",
15
+ Desc: "desc",
16
+ };
17
+ })(SearchIssuesSort || (SearchIssuesSort = {}));
@@ -0,0 +1,6 @@
1
+ import type * as Pylon from "../index.js";
2
+ export interface SendCustomerPortalInvitationResponseBody {
3
+ data: Pylon.CustomerPortalInvitationResult;
4
+ /** The request ID for tracking. */
5
+ request_id: string;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -24,6 +24,8 @@ export interface Task {
24
24
  external_issues?: Pylon.ExternalIssue[] | undefined;
25
25
  /** The ID of the task. */
26
26
  id: string;
27
+ /** The link to the task in the Pylon app. Requires Pylon app access. */
28
+ link: string;
27
29
  /** The Pylon issues linked to the task that the current user can access, if any. */
28
30
  linked_issues?: Pylon.MiniIssue[] | undefined;
29
31
  milestone?: Pylon.MiniMilestone | undefined;
@@ -1,5 +1,7 @@
1
1
  import type * as Pylon from "../index.js";
2
2
  export interface TicketFormLayoutField {
3
+ /** The ID of the custom field definition. Set only when type is custom_field. */
4
+ custom_field_id?: string | undefined;
3
5
  /** The description of the ticket form layout field in HTML. */
4
6
  description_html: string;
5
7
  /**
@@ -9,9 +11,17 @@ export interface TicketFormLayoutField {
9
11
  hidden: boolean;
10
12
  /** The name of the ticket form layout field. */
11
13
  name: string;
14
+ /**
15
+ * The URL query parameter used to prefill this field on the public form.
16
+ * Derived from the form's display label and changes when that label is renamed.
17
+ */
18
+ prefill_key: string;
12
19
  /** Indicates whether the field is required when submitting the ticket form. */
13
20
  required: boolean;
14
- /** The slug of the ticket form layout field. */
21
+ /**
22
+ * The field identifier used for API submissions and visibility conditions.
23
+ * For custom fields, this is the underlying custom-field slug.
24
+ */
15
25
  slug: string;
16
26
  /** The type of the ticket form layout field. */
17
27
  type: string;
@@ -0,0 +1,16 @@
1
+ export interface UpdateCustomerPortalAccessSettings {
2
+ /**
3
+ * Whether new contacts get portal access with the default role when they are created. Applies only to contacts whose email
4
+ * domain matches their account.
5
+ */
6
+ auto_grant_new_contacts?: boolean | undefined;
7
+ /** Whether someone without a contact who logs in to the portal gets one created, if their email domain matches an existing account. */
8
+ create_contacts_on_login?: boolean | undefined;
9
+ /**
10
+ * The portal role contacts get when they are granted access without an explicit role: `no_access`, `member`, `admin`, or a
11
+ * custom role's slug or ID. Hidden roles cannot be the default.
12
+ */
13
+ default_role?: string | undefined;
14
+ /** Whether contacts granted access automatically are emailed a portal invitation. */
15
+ invite_auto_granted_contacts?: boolean | undefined;
16
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,14 @@
1
+ export interface UpdateCustomerPortalBranding {
2
+ /** The brand color as a 6-digit hex code, such as `#1A2B3C`. An empty string clears it. */
3
+ brand_color?: string | undefined;
4
+ /** The footer logo used in dark mode. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
5
+ dark_mode_footer_logo_url?: string | undefined;
6
+ /** The header logo used in dark mode. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
7
+ dark_mode_logo_url?: string | undefined;
8
+ /** The footer logo. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
9
+ footer_logo_url?: string | undefined;
10
+ /** Where the header logo links to. Must be an http or https URL; an empty string makes the logo not a link. */
11
+ logo_link_url?: string | undefined;
12
+ /** The header logo. Pylon copies the image at this https URL into its own storage. An empty string clears it. */
13
+ logo_url?: string | undefined;
14
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface UpdateCustomerPortalDisplaySettings {
2
+ /** Whether the portal shows feature request descriptions. */
3
+ feature_request_descriptions?: boolean | undefined;
4
+ /** Whether portal tasks show their linked issues. */
5
+ task_linked_issues?: boolean | undefined;
6
+ /** Whether portal tasks show their linked tasks. */
7
+ task_linked_tasks?: boolean | undefined;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as Pylon from "../index.js";
2
+ export interface UpdateCustomerPortalNavigation {
3
+ /** The link groups in the portal footer, in order. Replaces the existing groups; an empty array removes them. */
4
+ footer_categories?: Pylon.CustomerPortalFooterCategory[] | undefined;
5
+ /** The links in the portal header, in order. Replaces the existing links; an empty array removes them. */
6
+ header_links?: Pylon.CustomerPortalLink[] | undefined;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface UpdateCustomerPortalTabs {
2
+ /** Whether the portal shows the feature requests tab. */
3
+ feature_requests?: boolean | undefined;
4
+ /** Whether the portal shows the issues tab. */
5
+ issues?: boolean | undefined;
6
+ /** Whether the portal shows the projects and tasks tab. */
7
+ projects_and_tasks?: boolean | undefined;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface UpdateCustomerPortalUserPermissions {
2
+ /** Whether portal users can edit their own profile. */
3
+ edit_profile?: boolean | undefined;
4
+ /** Whether portal users can edit the CC list on their replies. */
5
+ edit_reply_ccs?: boolean | undefined;
6
+ /** Whether portal users can export their issues as CSV. */
7
+ export_issues_csv?: boolean | undefined;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -8,6 +8,8 @@ export interface VoiceCall {
8
8
  from_phone_number: string;
9
9
  /** The ID of the voice call. */
10
10
  id: string;
11
+ /** Everyone who was dialed into the call, one entry per call leg, so a person who is redialed appears again. Empty when the call has no participant records. */
12
+ participants?: (Pylon.VoiceCallParticipant[] | null) | undefined;
11
13
  /** Recordings produced for this call. */
12
14
  recordings?: (Pylon.VoiceCallRecording[] | null) | undefined;
13
15
  /** The phone number that was dialed. */
@@ -0,0 +1,20 @@
1
+ export interface VoiceCallParticipant {
2
+ /** The ID of the contact, for a customer. */
3
+ contact_id?: string | undefined;
4
+ /** The ID of the participant. */
5
+ id: string;
6
+ /** RFC3339 timestamp of when the participant joined the call. */
7
+ joined_at?: string | undefined;
8
+ /** RFC3339 timestamp of when the participant left the call. */
9
+ left_at?: string | undefined;
10
+ /** The phone number of a customer or external participant. */
11
+ phone_number?: string | undefined;
12
+ /** Whether the participant was asked to consent to recording, and their answer: `not_asked`, `granted` or `declined`. */
13
+ recording_consent: string;
14
+ /** The participant's role: `customer`, `agent` or `external`. */
15
+ role: string;
16
+ /** The participant's status: `dialing`, `joined`, `left`, `failed` or `voicemail`. */
17
+ status: string;
18
+ /** The ID of the user, for an agent. */
19
+ user_id?: string | undefined;
20
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -62,6 +62,16 @@ export * from "./CrmDetails.js";
62
62
  export * from "./CrmSettings.js";
63
63
  export * from "./CsatResponse.js";
64
64
  export * from "./CustomActivity.js";
65
+ export * from "./CustomerPortalAccessSettings.js";
66
+ export * from "./CustomerPortalBranding.js";
67
+ export * from "./CustomerPortalDisplaySettings.js";
68
+ export * from "./CustomerPortalFooterCategory.js";
69
+ export * from "./CustomerPortalInvitationResult.js";
70
+ export * from "./CustomerPortalLink.js";
71
+ export * from "./CustomerPortalNavigation.js";
72
+ export * from "./CustomerPortalSettings.js";
73
+ export * from "./CustomerPortalTabs.js";
74
+ export * from "./CustomerPortalUserPermissions.js";
65
75
  export * from "./CustomFieldDefinition.js";
66
76
  export * from "./CustomFieldDefinitionSelectOption.js";
67
77
  export * from "./CustomFieldValue.js";
@@ -87,6 +97,7 @@ export * from "./DeleteProjectResponseBody.js";
87
97
  export * from "./DeleteTagResponseBody.js";
88
98
  export * from "./DeleteTaskCommentResponseBody.js";
89
99
  export * from "./DeleteTaskResponseBody.js";
100
+ export * from "./DeleteTeamResponseBody.js";
90
101
  export * from "./DeleteTrainingDataDocumentsResponseBody.js";
91
102
  export * from "./DestinationMetadata.js";
92
103
  export * from "./EmailActivity.js";
@@ -102,6 +113,8 @@ export * from "./FeatureRequest.js";
102
113
  export * from "./FeatureRequestEvidence.js";
103
114
  export * from "./FeatureRequestSearchResult.js";
104
115
  export * from "./Filter.js";
116
+ export * from "./FilterError.js";
117
+ export * from "./FilterRelatedObject.js";
105
118
  export * from "./Follower.js";
106
119
  export * from "./GetAccountNotebookNotesResponseBody.js";
107
120
  export * from "./GetAccountRelationshipsResponseBody.js";
@@ -118,6 +131,7 @@ export * from "./GetCollectionResponseBody.js";
118
131
  export * from "./GetCollectionsResponseBody.js";
119
132
  export * from "./GetContactResponseBody.js";
120
133
  export * from "./GetContactsResponseBody.js";
134
+ export * from "./GetCustomerPortalSettingsResponseBody.js";
121
135
  export * from "./GetCustomFieldResponseBody.js";
122
136
  export * from "./GetCustomFieldsResponseBody.js";
123
137
  export * from "./GetCustomObjectResponseBody.js";
@@ -222,11 +236,13 @@ export * from "./RequestArticleReviewData.js";
222
236
  export * from "./RequestArticleReviewResponseBody.js";
223
237
  export * from "./RouteRedirect.js";
224
238
  export * from "./SearchAccountsResponseBody.js";
239
+ export * from "./SearchAccountsSort.js";
225
240
  export * from "./SearchCallRecordingsResponseBody.js";
226
241
  export * from "./SearchContactsResponseBody.js";
227
242
  export * from "./SearchCustomObjectsResponseBody.js";
228
243
  export * from "./SearchFeatureRequestsResponseBody.js";
229
244
  export * from "./SearchIssuesResponseBody.js";
245
+ export * from "./SearchIssuesSort.js";
230
246
  export * from "./SearchMilestonesResponseBody.js";
231
247
  export * from "./SearchProjectsResponseBody.js";
232
248
  export * from "./SearchSurveysResponseBody.js";
@@ -234,6 +250,7 @@ export * from "./SearchTagsResponseBody.js";
234
250
  export * from "./SearchTasksResponseBody.js";
235
251
  export * from "./SearchUsersResponseBody.js";
236
252
  export * from "./SelectMetadata.js";
253
+ export * from "./SendCustomerPortalInvitationResponseBody.js";
237
254
  export * from "./SetFeatureRequestPortalVisibilityResponseBody.js";
238
255
  export * from "./SkippedIssue.js";
239
256
  export * from "./SlackInfo.js";
@@ -274,6 +291,12 @@ export * from "./UpdateCallRecordingResponseBody.js";
274
291
  export * from "./UpdateCollectionResponseBody.js";
275
292
  export * from "./UpdateContactEmail.js";
276
293
  export * from "./UpdateContactResponseBody.js";
294
+ export * from "./UpdateCustomerPortalAccessSettings.js";
295
+ export * from "./UpdateCustomerPortalBranding.js";
296
+ export * from "./UpdateCustomerPortalDisplaySettings.js";
297
+ export * from "./UpdateCustomerPortalNavigation.js";
298
+ export * from "./UpdateCustomerPortalTabs.js";
299
+ export * from "./UpdateCustomerPortalUserPermissions.js";
277
300
  export * from "./UpdateCustomFieldResponseBody.js";
278
301
  export * from "./UpdateCustomFieldSelectOptionResponseBody.js";
279
302
  export * from "./UpdateCustomObjectResponseBody.js";
@@ -301,5 +324,6 @@ export * from "./UserStatus.js";
301
324
  export * from "./Visibility.js";
302
325
  export * from "./VisibilityInput.js";
303
326
  export * from "./VoiceCall.js";
327
+ export * from "./VoiceCallParticipant.js";
304
328
  export * from "./VoiceCallRecording.js";
305
329
  export * from "./VoiceCallTranscriptSegment.js";
@@ -62,6 +62,16 @@ export * from "./CrmDetails.js";
62
62
  export * from "./CrmSettings.js";
63
63
  export * from "./CsatResponse.js";
64
64
  export * from "./CustomActivity.js";
65
+ export * from "./CustomerPortalAccessSettings.js";
66
+ export * from "./CustomerPortalBranding.js";
67
+ export * from "./CustomerPortalDisplaySettings.js";
68
+ export * from "./CustomerPortalFooterCategory.js";
69
+ export * from "./CustomerPortalInvitationResult.js";
70
+ export * from "./CustomerPortalLink.js";
71
+ export * from "./CustomerPortalNavigation.js";
72
+ export * from "./CustomerPortalSettings.js";
73
+ export * from "./CustomerPortalTabs.js";
74
+ export * from "./CustomerPortalUserPermissions.js";
65
75
  export * from "./CustomFieldDefinition.js";
66
76
  export * from "./CustomFieldDefinitionSelectOption.js";
67
77
  export * from "./CustomFieldValue.js";
@@ -87,6 +97,7 @@ export * from "./DeleteProjectResponseBody.js";
87
97
  export * from "./DeleteTagResponseBody.js";
88
98
  export * from "./DeleteTaskCommentResponseBody.js";
89
99
  export * from "./DeleteTaskResponseBody.js";
100
+ export * from "./DeleteTeamResponseBody.js";
90
101
  export * from "./DeleteTrainingDataDocumentsResponseBody.js";
91
102
  export * from "./DestinationMetadata.js";
92
103
  export * from "./EmailActivity.js";
@@ -102,6 +113,8 @@ export * from "./FeatureRequest.js";
102
113
  export * from "./FeatureRequestEvidence.js";
103
114
  export * from "./FeatureRequestSearchResult.js";
104
115
  export * from "./Filter.js";
116
+ export * from "./FilterError.js";
117
+ export * from "./FilterRelatedObject.js";
105
118
  export * from "./Follower.js";
106
119
  export * from "./GetAccountNotebookNotesResponseBody.js";
107
120
  export * from "./GetAccountRelationshipsResponseBody.js";
@@ -118,6 +131,7 @@ export * from "./GetCollectionResponseBody.js";
118
131
  export * from "./GetCollectionsResponseBody.js";
119
132
  export * from "./GetContactResponseBody.js";
120
133
  export * from "./GetContactsResponseBody.js";
134
+ export * from "./GetCustomerPortalSettingsResponseBody.js";
121
135
  export * from "./GetCustomFieldResponseBody.js";
122
136
  export * from "./GetCustomFieldsResponseBody.js";
123
137
  export * from "./GetCustomObjectResponseBody.js";
@@ -222,11 +236,13 @@ export * from "./RequestArticleReviewData.js";
222
236
  export * from "./RequestArticleReviewResponseBody.js";
223
237
  export * from "./RouteRedirect.js";
224
238
  export * from "./SearchAccountsResponseBody.js";
239
+ export * from "./SearchAccountsSort.js";
225
240
  export * from "./SearchCallRecordingsResponseBody.js";
226
241
  export * from "./SearchContactsResponseBody.js";
227
242
  export * from "./SearchCustomObjectsResponseBody.js";
228
243
  export * from "./SearchFeatureRequestsResponseBody.js";
229
244
  export * from "./SearchIssuesResponseBody.js";
245
+ export * from "./SearchIssuesSort.js";
230
246
  export * from "./SearchMilestonesResponseBody.js";
231
247
  export * from "./SearchProjectsResponseBody.js";
232
248
  export * from "./SearchSurveysResponseBody.js";
@@ -234,6 +250,7 @@ export * from "./SearchTagsResponseBody.js";
234
250
  export * from "./SearchTasksResponseBody.js";
235
251
  export * from "./SearchUsersResponseBody.js";
236
252
  export * from "./SelectMetadata.js";
253
+ export * from "./SendCustomerPortalInvitationResponseBody.js";
237
254
  export * from "./SetFeatureRequestPortalVisibilityResponseBody.js";
238
255
  export * from "./SkippedIssue.js";
239
256
  export * from "./SlackInfo.js";
@@ -274,6 +291,12 @@ export * from "./UpdateCallRecordingResponseBody.js";
274
291
  export * from "./UpdateCollectionResponseBody.js";
275
292
  export * from "./UpdateContactEmail.js";
276
293
  export * from "./UpdateContactResponseBody.js";
294
+ export * from "./UpdateCustomerPortalAccessSettings.js";
295
+ export * from "./UpdateCustomerPortalBranding.js";
296
+ export * from "./UpdateCustomerPortalDisplaySettings.js";
297
+ export * from "./UpdateCustomerPortalNavigation.js";
298
+ export * from "./UpdateCustomerPortalTabs.js";
299
+ export * from "./UpdateCustomerPortalUserPermissions.js";
277
300
  export * from "./UpdateCustomFieldResponseBody.js";
278
301
  export * from "./UpdateCustomFieldSelectOptionResponseBody.js";
279
302
  export * from "./UpdateCustomObjectResponseBody.js";
@@ -301,5 +324,6 @@ export * from "./UserStatus.js";
301
324
  export * from "./Visibility.js";
302
325
  export * from "./VisibilityInput.js";
303
326
  export * from "./VoiceCall.js";
327
+ export * from "./VoiceCallParticipant.js";
304
328
  export * from "./VoiceCallRecording.js";
305
329
  export * from "./VoiceCallTranscriptSegment.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@usepylon/sdk",
3
- "version": "0.1.0-alpha.5",
3
+ "version": "0.1.0-beta.2",
4
4
  "description": "Official TypeScript SDK for the Pylon API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.usepylon.com",