@cstar.help/js 0.17.4 → 0.17.5
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.
- package/README.md +18 -1
- package/dist/auth/index.d.cts +1 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/community/index.d.cts +1 -1
- package/dist/community/index.d.ts +1 -1
- package/dist/errors-bW8CwTn4.d.cts +121 -0
- package/dist/errors-bW8CwTn4.d.ts +121 -0
- package/dist/index.cjs +6 -4
- package/dist/index.d.cts +12 -4
- package/dist/index.d.ts +12 -4
- package/dist/index.js +6 -4
- package/dist/library/index.d.cts +1 -1
- package/dist/library/index.d.ts +1 -1
- package/dist/quickhelp/index.d.cts +1 -1
- package/dist/quickhelp/index.d.ts +1 -1
- package/package.json +1 -1
- package/dist/errors-b5A4wfAg.d.cts +0 -398
- package/dist/errors-b5A4wfAg.d.ts +0 -398
package/README.md
CHANGED
|
@@ -71,6 +71,23 @@ for await (const ticket of cstar.tickets.listAutoPaginating({ status: 'open' }))
|
|
|
71
71
|
|
|
72
72
|
Created, retrieved and updated resources are returned directly. List methods return `{ data, pagination, hasMore }`. Search returns `{ results, total, query }`. Read `cstar.lastMeta.requestId` immediately after a call when you need its request ID.
|
|
73
73
|
|
|
74
|
+
### Private notes and message history
|
|
75
|
+
|
|
76
|
+
Run message management on your server with a secret key. Internal notes stay inside the support team.
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
const note = await cstar.tickets.messages.create('tkt_123', {
|
|
80
|
+
content: 'The customer has already tried resetting their password.',
|
|
81
|
+
messageType: 'internal'
|
|
82
|
+
});
|
|
83
|
+
console.log(note.isInternal);
|
|
84
|
+
|
|
85
|
+
const page = await cstar.tickets.messages.list('tkt_123', { page: 2, pageSize: 25 });
|
|
86
|
+
console.log(page.data, page.pagination.hasMore);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The `isInternal` boolean is also accepted when creating a note. If you supply both privacy options, they must agree. Message history is paginated, so request the next page while `hasMore` is true.
|
|
90
|
+
|
|
74
91
|
### Full Resource Reference
|
|
75
92
|
|
|
76
93
|
**Core Resources** — Tickets, customers, and knowledge base.
|
|
@@ -78,7 +95,7 @@ Created, retrieved and updated resources are returned directly. List methods ret
|
|
|
78
95
|
| Resource | Methods |
|
|
79
96
|
| ------------------------ | ----------------------------------------------------------------------------------------------- |
|
|
80
97
|
| `cstar.tickets` | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()` |
|
|
81
|
-
| `cstar.tickets.messages` | `.list(ticketId)` `.create(ticketId, params)`
|
|
98
|
+
| `cstar.tickets.messages` | `.list(ticketId, params?)` `.create(ticketId, params)` |
|
|
82
99
|
| `cstar.customers` | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()` |
|
|
83
100
|
| `cstar.articles` | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()` |
|
|
84
101
|
| `cstar.categories` | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` |
|
package/dist/auth/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
1
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
|
|
2
2
|
|
|
3
3
|
/** Configuration for the AuthClient. */
|
|
4
4
|
interface AuthConfig {
|
package/dist/auth/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
1
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
|
|
2
2
|
|
|
3
3
|
/** Configuration for the AuthClient. */
|
|
4
4
|
interface AuthConfig {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.cjs';
|
|
2
2
|
export { n as CommunityComment } from '../types-DF7GprCV.cjs';
|
|
3
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
3
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Public community client. No authentication required.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.js';
|
|
2
2
|
export { n as CommunityComment } from '../types-DF7GprCV.js';
|
|
3
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
3
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* Public community client. No authentication required.
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Error classes for the cStar SDK.
|
|
3
|
+
*
|
|
4
|
+
* NEW-v3-01 — Cross-subpath instanceof identity.
|
|
5
|
+
*
|
|
6
|
+
* Each public subpath (`/library`, `/auth`, `/community`, `/quickhelp`, ...)
|
|
7
|
+
* is bundled as a separate tsup entry with `splitting: false`, so each one
|
|
8
|
+
* carries its own copy of this module. Without deduplication, errors thrown
|
|
9
|
+
* by `LibraryClient` carry the LibraryClient-bundled `CStarError` class —
|
|
10
|
+
* not the one a consumer imports from `@cstar.help/js`. That makes
|
|
11
|
+
* `instanceof CStarError` checks fail silently, invalidating every "did the
|
|
12
|
+
* SDK throw a typed cStar error?" branch in user code.
|
|
13
|
+
*
|
|
14
|
+
* Fix: register each class on a `Symbol.for(...)` slot of `globalThis`. The
|
|
15
|
+
* symbol is realm-shared, so every bundled copy of this module resolves to
|
|
16
|
+
* the SAME class identity at runtime — the first copy to load wins, and all
|
|
17
|
+
* subsequent copies surface the canonical class via the same slot. The
|
|
18
|
+
* inline `Impl` definitions are only used as the seed for the very first
|
|
19
|
+
* copy to register. Internal `parseError` / `parsePublicError` reference the
|
|
20
|
+
* EXPORTED canonical names so instances they construct also land on the
|
|
21
|
+
* canonical class.
|
|
22
|
+
*/
|
|
23
|
+
/** Error type constants matching the cStar API. */
|
|
24
|
+
declare const ErrorType: {
|
|
25
|
+
readonly AUTHENTICATION_ERROR: "authentication_error";
|
|
26
|
+
readonly PERMISSION_ERROR: "permission_error";
|
|
27
|
+
readonly INVALID_REQUEST_ERROR: "invalid_request_error";
|
|
28
|
+
readonly NOT_FOUND_ERROR: "not_found_error";
|
|
29
|
+
readonly CONFLICT_ERROR: "conflict_error";
|
|
30
|
+
readonly RATE_LIMIT_ERROR: "rate_limit_error";
|
|
31
|
+
readonly FEATURE_NOT_CONFIGURED: "feature_not_configured";
|
|
32
|
+
readonly API_ERROR: "api_error";
|
|
33
|
+
readonly SERVER_ERROR: "server_error";
|
|
34
|
+
};
|
|
35
|
+
/** Shape of the error object returned by the cStar API. */
|
|
36
|
+
interface ApiErrorBody {
|
|
37
|
+
type: string;
|
|
38
|
+
code: string;
|
|
39
|
+
message: string;
|
|
40
|
+
param?: string;
|
|
41
|
+
doc_url: string;
|
|
42
|
+
request_id?: string;
|
|
43
|
+
feature?: string;
|
|
44
|
+
enable_url?: string;
|
|
45
|
+
}
|
|
46
|
+
/** Base error class for all cStar API errors. */
|
|
47
|
+
declare class CStarErrorImpl extends Error {
|
|
48
|
+
readonly type: string;
|
|
49
|
+
readonly code: string;
|
|
50
|
+
readonly param?: string;
|
|
51
|
+
readonly docUrl: string;
|
|
52
|
+
readonly requestId?: string;
|
|
53
|
+
readonly statusCode: number;
|
|
54
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
55
|
+
}
|
|
56
|
+
declare class CStarAuthenticationErrorImpl extends CStarErrorImpl {
|
|
57
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
58
|
+
}
|
|
59
|
+
declare class CStarRateLimitErrorImpl extends CStarErrorImpl {
|
|
60
|
+
readonly retryAfter: number;
|
|
61
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number);
|
|
62
|
+
}
|
|
63
|
+
declare class CStarNotFoundErrorImpl extends CStarErrorImpl {
|
|
64
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
65
|
+
}
|
|
66
|
+
declare class CStarValidationErrorImpl extends CStarErrorImpl {
|
|
67
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
68
|
+
}
|
|
69
|
+
declare class CStarPermissionErrorImpl extends CStarErrorImpl {
|
|
70
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
71
|
+
}
|
|
72
|
+
declare class CStarConflictErrorImpl extends CStarErrorImpl {
|
|
73
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
74
|
+
}
|
|
75
|
+
declare class CStarServerErrorImpl extends CStarErrorImpl {
|
|
76
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
77
|
+
}
|
|
78
|
+
declare class CStarFeatureDisabledErrorImpl extends CStarErrorImpl {
|
|
79
|
+
readonly feature: string;
|
|
80
|
+
readonly enableUrl: string;
|
|
81
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
82
|
+
}
|
|
83
|
+
declare class CStarRealtimeUnavailableErrorImpl extends CStarErrorImpl {
|
|
84
|
+
constructor(message?: string);
|
|
85
|
+
}
|
|
86
|
+
declare const CStarError: typeof CStarErrorImpl;
|
|
87
|
+
type CStarError = InstanceType<typeof CStarErrorImpl>;
|
|
88
|
+
declare const CStarAuthenticationError: typeof CStarAuthenticationErrorImpl;
|
|
89
|
+
type CStarAuthenticationError = InstanceType<typeof CStarAuthenticationErrorImpl>;
|
|
90
|
+
declare const CStarRateLimitError: typeof CStarRateLimitErrorImpl;
|
|
91
|
+
type CStarRateLimitError = InstanceType<typeof CStarRateLimitErrorImpl>;
|
|
92
|
+
declare const CStarNotFoundError: typeof CStarNotFoundErrorImpl;
|
|
93
|
+
type CStarNotFoundError = InstanceType<typeof CStarNotFoundErrorImpl>;
|
|
94
|
+
declare const CStarValidationError: typeof CStarValidationErrorImpl;
|
|
95
|
+
type CStarValidationError = InstanceType<typeof CStarValidationErrorImpl>;
|
|
96
|
+
declare const CStarPermissionError: typeof CStarPermissionErrorImpl;
|
|
97
|
+
type CStarPermissionError = InstanceType<typeof CStarPermissionErrorImpl>;
|
|
98
|
+
declare const CStarConflictError: typeof CStarConflictErrorImpl;
|
|
99
|
+
type CStarConflictError = InstanceType<typeof CStarConflictErrorImpl>;
|
|
100
|
+
declare const CStarServerError: typeof CStarServerErrorImpl;
|
|
101
|
+
type CStarServerError = InstanceType<typeof CStarServerErrorImpl>;
|
|
102
|
+
declare const CStarFeatureDisabledError: typeof CStarFeatureDisabledErrorImpl;
|
|
103
|
+
type CStarFeatureDisabledError = InstanceType<typeof CStarFeatureDisabledErrorImpl>;
|
|
104
|
+
declare const CStarRealtimeUnavailableError: typeof CStarRealtimeUnavailableErrorImpl;
|
|
105
|
+
type CStarRealtimeUnavailableError = InstanceType<typeof CStarRealtimeUnavailableErrorImpl>;
|
|
106
|
+
/**
|
|
107
|
+
* Parse a public-route response (anonymous LibraryClient, CommunityClient,
|
|
108
|
+
* QuickHelpClient, AuthClient) into a typed `CStarError`.
|
|
109
|
+
*
|
|
110
|
+
* Public routes don't always emit the structured `{error: {type, code,
|
|
111
|
+
* doc_url, ...}}` envelope — many emit `{error: 'message string'}` or
|
|
112
|
+
* `{message: '...'}`. This helper normalizes both shapes and dispatches
|
|
113
|
+
* on HTTP status (closes F-026 and F-034 — Library/Auth used to throw
|
|
114
|
+
* plain `Error`).
|
|
115
|
+
*/
|
|
116
|
+
declare function parsePublicError(status: number, body: unknown, fallbackMessage: string): CStarError;
|
|
117
|
+
declare function parseError(statusCode: number, body: {
|
|
118
|
+
error?: ApiErrorBody;
|
|
119
|
+
} | null, retryAfter?: number): CStarError;
|
|
120
|
+
|
|
121
|
+
export { type ApiErrorBody as A, CStarAuthenticationError as C, ErrorType as E, CStarConflictError as a, CStarError as b, CStarFeatureDisabledError as c, CStarNotFoundError as d, CStarPermissionError as e, CStarRateLimitError as f, CStarRealtimeUnavailableError as g, CStarServerError as h, CStarValidationError as i, parsePublicError as j, parseError as p };
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Error classes for the cStar SDK.
|
|
3
|
+
*
|
|
4
|
+
* NEW-v3-01 — Cross-subpath instanceof identity.
|
|
5
|
+
*
|
|
6
|
+
* Each public subpath (`/library`, `/auth`, `/community`, `/quickhelp`, ...)
|
|
7
|
+
* is bundled as a separate tsup entry with `splitting: false`, so each one
|
|
8
|
+
* carries its own copy of this module. Without deduplication, errors thrown
|
|
9
|
+
* by `LibraryClient` carry the LibraryClient-bundled `CStarError` class —
|
|
10
|
+
* not the one a consumer imports from `@cstar.help/js`. That makes
|
|
11
|
+
* `instanceof CStarError` checks fail silently, invalidating every "did the
|
|
12
|
+
* SDK throw a typed cStar error?" branch in user code.
|
|
13
|
+
*
|
|
14
|
+
* Fix: register each class on a `Symbol.for(...)` slot of `globalThis`. The
|
|
15
|
+
* symbol is realm-shared, so every bundled copy of this module resolves to
|
|
16
|
+
* the SAME class identity at runtime — the first copy to load wins, and all
|
|
17
|
+
* subsequent copies surface the canonical class via the same slot. The
|
|
18
|
+
* inline `Impl` definitions are only used as the seed for the very first
|
|
19
|
+
* copy to register. Internal `parseError` / `parsePublicError` reference the
|
|
20
|
+
* EXPORTED canonical names so instances they construct also land on the
|
|
21
|
+
* canonical class.
|
|
22
|
+
*/
|
|
23
|
+
/** Error type constants matching the cStar API. */
|
|
24
|
+
declare const ErrorType: {
|
|
25
|
+
readonly AUTHENTICATION_ERROR: "authentication_error";
|
|
26
|
+
readonly PERMISSION_ERROR: "permission_error";
|
|
27
|
+
readonly INVALID_REQUEST_ERROR: "invalid_request_error";
|
|
28
|
+
readonly NOT_FOUND_ERROR: "not_found_error";
|
|
29
|
+
readonly CONFLICT_ERROR: "conflict_error";
|
|
30
|
+
readonly RATE_LIMIT_ERROR: "rate_limit_error";
|
|
31
|
+
readonly FEATURE_NOT_CONFIGURED: "feature_not_configured";
|
|
32
|
+
readonly API_ERROR: "api_error";
|
|
33
|
+
readonly SERVER_ERROR: "server_error";
|
|
34
|
+
};
|
|
35
|
+
/** Shape of the error object returned by the cStar API. */
|
|
36
|
+
interface ApiErrorBody {
|
|
37
|
+
type: string;
|
|
38
|
+
code: string;
|
|
39
|
+
message: string;
|
|
40
|
+
param?: string;
|
|
41
|
+
doc_url: string;
|
|
42
|
+
request_id?: string;
|
|
43
|
+
feature?: string;
|
|
44
|
+
enable_url?: string;
|
|
45
|
+
}
|
|
46
|
+
/** Base error class for all cStar API errors. */
|
|
47
|
+
declare class CStarErrorImpl extends Error {
|
|
48
|
+
readonly type: string;
|
|
49
|
+
readonly code: string;
|
|
50
|
+
readonly param?: string;
|
|
51
|
+
readonly docUrl: string;
|
|
52
|
+
readonly requestId?: string;
|
|
53
|
+
readonly statusCode: number;
|
|
54
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
55
|
+
}
|
|
56
|
+
declare class CStarAuthenticationErrorImpl extends CStarErrorImpl {
|
|
57
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
58
|
+
}
|
|
59
|
+
declare class CStarRateLimitErrorImpl extends CStarErrorImpl {
|
|
60
|
+
readonly retryAfter: number;
|
|
61
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number);
|
|
62
|
+
}
|
|
63
|
+
declare class CStarNotFoundErrorImpl extends CStarErrorImpl {
|
|
64
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
65
|
+
}
|
|
66
|
+
declare class CStarValidationErrorImpl extends CStarErrorImpl {
|
|
67
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
68
|
+
}
|
|
69
|
+
declare class CStarPermissionErrorImpl extends CStarErrorImpl {
|
|
70
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
71
|
+
}
|
|
72
|
+
declare class CStarConflictErrorImpl extends CStarErrorImpl {
|
|
73
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
74
|
+
}
|
|
75
|
+
declare class CStarServerErrorImpl extends CStarErrorImpl {
|
|
76
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
77
|
+
}
|
|
78
|
+
declare class CStarFeatureDisabledErrorImpl extends CStarErrorImpl {
|
|
79
|
+
readonly feature: string;
|
|
80
|
+
readonly enableUrl: string;
|
|
81
|
+
constructor(messageOrStatus: string | number, body?: ApiErrorBody);
|
|
82
|
+
}
|
|
83
|
+
declare class CStarRealtimeUnavailableErrorImpl extends CStarErrorImpl {
|
|
84
|
+
constructor(message?: string);
|
|
85
|
+
}
|
|
86
|
+
declare const CStarError: typeof CStarErrorImpl;
|
|
87
|
+
type CStarError = InstanceType<typeof CStarErrorImpl>;
|
|
88
|
+
declare const CStarAuthenticationError: typeof CStarAuthenticationErrorImpl;
|
|
89
|
+
type CStarAuthenticationError = InstanceType<typeof CStarAuthenticationErrorImpl>;
|
|
90
|
+
declare const CStarRateLimitError: typeof CStarRateLimitErrorImpl;
|
|
91
|
+
type CStarRateLimitError = InstanceType<typeof CStarRateLimitErrorImpl>;
|
|
92
|
+
declare const CStarNotFoundError: typeof CStarNotFoundErrorImpl;
|
|
93
|
+
type CStarNotFoundError = InstanceType<typeof CStarNotFoundErrorImpl>;
|
|
94
|
+
declare const CStarValidationError: typeof CStarValidationErrorImpl;
|
|
95
|
+
type CStarValidationError = InstanceType<typeof CStarValidationErrorImpl>;
|
|
96
|
+
declare const CStarPermissionError: typeof CStarPermissionErrorImpl;
|
|
97
|
+
type CStarPermissionError = InstanceType<typeof CStarPermissionErrorImpl>;
|
|
98
|
+
declare const CStarConflictError: typeof CStarConflictErrorImpl;
|
|
99
|
+
type CStarConflictError = InstanceType<typeof CStarConflictErrorImpl>;
|
|
100
|
+
declare const CStarServerError: typeof CStarServerErrorImpl;
|
|
101
|
+
type CStarServerError = InstanceType<typeof CStarServerErrorImpl>;
|
|
102
|
+
declare const CStarFeatureDisabledError: typeof CStarFeatureDisabledErrorImpl;
|
|
103
|
+
type CStarFeatureDisabledError = InstanceType<typeof CStarFeatureDisabledErrorImpl>;
|
|
104
|
+
declare const CStarRealtimeUnavailableError: typeof CStarRealtimeUnavailableErrorImpl;
|
|
105
|
+
type CStarRealtimeUnavailableError = InstanceType<typeof CStarRealtimeUnavailableErrorImpl>;
|
|
106
|
+
/**
|
|
107
|
+
* Parse a public-route response (anonymous LibraryClient, CommunityClient,
|
|
108
|
+
* QuickHelpClient, AuthClient) into a typed `CStarError`.
|
|
109
|
+
*
|
|
110
|
+
* Public routes don't always emit the structured `{error: {type, code,
|
|
111
|
+
* doc_url, ...}}` envelope — many emit `{error: 'message string'}` or
|
|
112
|
+
* `{message: '...'}`. This helper normalizes both shapes and dispatches
|
|
113
|
+
* on HTTP status (closes F-026 and F-034 — Library/Auth used to throw
|
|
114
|
+
* plain `Error`).
|
|
115
|
+
*/
|
|
116
|
+
declare function parsePublicError(status: number, body: unknown, fallbackMessage: string): CStarError;
|
|
117
|
+
declare function parseError(statusCode: number, body: {
|
|
118
|
+
error?: ApiErrorBody;
|
|
119
|
+
} | null, retryAfter?: number): CStarError;
|
|
120
|
+
|
|
121
|
+
export { type ApiErrorBody as A, CStarAuthenticationError as C, ErrorType as E, CStarConflictError as a, CStarError as b, CStarFeatureDisabledError as c, CStarNotFoundError as d, CStarPermissionError as e, CStarRateLimitError as f, CStarRealtimeUnavailableError as g, CStarServerError as h, CStarValidationError as i, parsePublicError as j, parseError as p };
|
package/dist/index.cjs
CHANGED
|
@@ -278,7 +278,7 @@ function parseError(statusCode, body, retryAfter) {
|
|
|
278
278
|
}
|
|
279
279
|
|
|
280
280
|
// src/client.ts
|
|
281
|
-
var SDK_VERSION = "0.17.
|
|
281
|
+
var SDK_VERSION = "0.17.5";
|
|
282
282
|
var DEFAULT_BASE_URL = "https://www.cstar.help";
|
|
283
283
|
var DEFAULT_API_VERSION = "2026-03-01";
|
|
284
284
|
var DEFAULT_MAX_RETRIES = 3;
|
|
@@ -1162,9 +1162,11 @@ var TicketMessagesResource = class {
|
|
|
1162
1162
|
constructor(client) {
|
|
1163
1163
|
this.client = client;
|
|
1164
1164
|
}
|
|
1165
|
-
/** List
|
|
1166
|
-
async list(ticketId) {
|
|
1167
|
-
return this.client.request("GET", `/tickets/${ticketId}/messages
|
|
1165
|
+
/** List one page of a ticket history. Use pagination.hasMore to request the next page. */
|
|
1166
|
+
async list(ticketId, params) {
|
|
1167
|
+
return this.client.request("GET", `/tickets/${ticketId}/messages`, {
|
|
1168
|
+
query: params ? { ...params } : void 0
|
|
1169
|
+
});
|
|
1168
1170
|
}
|
|
1169
1171
|
/** Add a message to a ticket. */
|
|
1170
1172
|
async create(ticketId, params, options) {
|
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { W as WebhookEventType, a as WebhookEventDataMap } from './webhookEvents-1N2i2GcQ.cjs';
|
|
2
2
|
export { b as WEBHOOK_EVENT_CATALOG, c as WEBHOOK_EVENT_SAMPLES, d as WebhookEvent } from './webhookEvents-1N2i2GcQ.cjs';
|
|
3
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, h as CStarServerError, i as CStarValidationError, E as ErrorType } from './errors-
|
|
3
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, h as CStarServerError, i as CStarValidationError, E as ErrorType } from './errors-bW8CwTn4.cjs';
|
|
4
4
|
|
|
5
5
|
/** Metadata: string key-value pairs. Max 50 keys, 40-char keys, 500-char values. */
|
|
6
6
|
type Metadata = Record<string, string>;
|
|
@@ -279,6 +279,9 @@ declare class CStarRealtime {
|
|
|
279
279
|
interface Message {
|
|
280
280
|
id: string;
|
|
281
281
|
object: 'message';
|
|
282
|
+
ticketId: string;
|
|
283
|
+
/** True for a note visible only to the support team. */
|
|
284
|
+
isInternal: boolean;
|
|
282
285
|
sender: 'customer' | 'agent' | 'system';
|
|
283
286
|
content: string;
|
|
284
287
|
senderId: string | null;
|
|
@@ -293,7 +296,12 @@ interface MessageCreateParams {
|
|
|
293
296
|
sender?: 'customer' | 'agent' | 'system';
|
|
294
297
|
senderId?: string;
|
|
295
298
|
senderName?: string;
|
|
299
|
+
messageType?: 'public' | 'internal';
|
|
300
|
+
/** Boolean alias for messageType. If both are supplied, they must agree. */
|
|
301
|
+
isInternal?: boolean;
|
|
296
302
|
}
|
|
303
|
+
/** Pagination options for a ticket message history. */
|
|
304
|
+
type MessageListParams = PaginationParams;
|
|
297
305
|
|
|
298
306
|
/** A cStar support ticket. */
|
|
299
307
|
interface Ticket {
|
|
@@ -471,8 +479,8 @@ declare abstract class BaseResource<TEntity, TListParams extends PaginationParam
|
|
|
471
479
|
declare class TicketMessagesResource {
|
|
472
480
|
private readonly client;
|
|
473
481
|
constructor(client: HttpClient);
|
|
474
|
-
/** List
|
|
475
|
-
list(ticketId: string): Promise<ListResponse<Message>>;
|
|
482
|
+
/** List one page of a ticket history. Use pagination.hasMore to request the next page. */
|
|
483
|
+
list(ticketId: string, params?: MessageListParams): Promise<ListResponse<Message>>;
|
|
476
484
|
/** Add a message to a ticket. */
|
|
477
485
|
create(ticketId: string, params: MessageCreateParams, options?: RequestOptions): Promise<Message>;
|
|
478
486
|
}
|
|
@@ -3073,4 +3081,4 @@ declare class CStarClient {
|
|
|
3073
3081
|
get lastMeta(): LastMeta;
|
|
3074
3082
|
}
|
|
3075
3083
|
|
|
3076
|
-
export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
|
|
3084
|
+
export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type MessageListParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { W as WebhookEventType, a as WebhookEventDataMap } from './webhookEvents-1N2i2GcQ.js';
|
|
2
2
|
export { b as WEBHOOK_EVENT_CATALOG, c as WEBHOOK_EVENT_SAMPLES, d as WebhookEvent } from './webhookEvents-1N2i2GcQ.js';
|
|
3
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, h as CStarServerError, i as CStarValidationError, E as ErrorType } from './errors-
|
|
3
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, h as CStarServerError, i as CStarValidationError, E as ErrorType } from './errors-bW8CwTn4.js';
|
|
4
4
|
|
|
5
5
|
/** Metadata: string key-value pairs. Max 50 keys, 40-char keys, 500-char values. */
|
|
6
6
|
type Metadata = Record<string, string>;
|
|
@@ -279,6 +279,9 @@ declare class CStarRealtime {
|
|
|
279
279
|
interface Message {
|
|
280
280
|
id: string;
|
|
281
281
|
object: 'message';
|
|
282
|
+
ticketId: string;
|
|
283
|
+
/** True for a note visible only to the support team. */
|
|
284
|
+
isInternal: boolean;
|
|
282
285
|
sender: 'customer' | 'agent' | 'system';
|
|
283
286
|
content: string;
|
|
284
287
|
senderId: string | null;
|
|
@@ -293,7 +296,12 @@ interface MessageCreateParams {
|
|
|
293
296
|
sender?: 'customer' | 'agent' | 'system';
|
|
294
297
|
senderId?: string;
|
|
295
298
|
senderName?: string;
|
|
299
|
+
messageType?: 'public' | 'internal';
|
|
300
|
+
/** Boolean alias for messageType. If both are supplied, they must agree. */
|
|
301
|
+
isInternal?: boolean;
|
|
296
302
|
}
|
|
303
|
+
/** Pagination options for a ticket message history. */
|
|
304
|
+
type MessageListParams = PaginationParams;
|
|
297
305
|
|
|
298
306
|
/** A cStar support ticket. */
|
|
299
307
|
interface Ticket {
|
|
@@ -471,8 +479,8 @@ declare abstract class BaseResource<TEntity, TListParams extends PaginationParam
|
|
|
471
479
|
declare class TicketMessagesResource {
|
|
472
480
|
private readonly client;
|
|
473
481
|
constructor(client: HttpClient);
|
|
474
|
-
/** List
|
|
475
|
-
list(ticketId: string): Promise<ListResponse<Message>>;
|
|
482
|
+
/** List one page of a ticket history. Use pagination.hasMore to request the next page. */
|
|
483
|
+
list(ticketId: string, params?: MessageListParams): Promise<ListResponse<Message>>;
|
|
476
484
|
/** Add a message to a ticket. */
|
|
477
485
|
create(ticketId: string, params: MessageCreateParams, options?: RequestOptions): Promise<Message>;
|
|
478
486
|
}
|
|
@@ -3073,4 +3081,4 @@ declare class CStarClient {
|
|
|
3073
3081
|
get lastMeta(): LastMeta;
|
|
3074
3082
|
}
|
|
3075
3083
|
|
|
3076
|
-
export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
|
|
3084
|
+
export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type MessageListParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
|
package/dist/index.js
CHANGED
|
@@ -237,7 +237,7 @@ function parseError(statusCode, body, retryAfter) {
|
|
|
237
237
|
}
|
|
238
238
|
|
|
239
239
|
// src/client.ts
|
|
240
|
-
var SDK_VERSION = "0.17.
|
|
240
|
+
var SDK_VERSION = "0.17.5";
|
|
241
241
|
var DEFAULT_BASE_URL = "https://www.cstar.help";
|
|
242
242
|
var DEFAULT_API_VERSION = "2026-03-01";
|
|
243
243
|
var DEFAULT_MAX_RETRIES = 3;
|
|
@@ -1121,9 +1121,11 @@ var TicketMessagesResource = class {
|
|
|
1121
1121
|
constructor(client) {
|
|
1122
1122
|
this.client = client;
|
|
1123
1123
|
}
|
|
1124
|
-
/** List
|
|
1125
|
-
async list(ticketId) {
|
|
1126
|
-
return this.client.request("GET", `/tickets/${ticketId}/messages
|
|
1124
|
+
/** List one page of a ticket history. Use pagination.hasMore to request the next page. */
|
|
1125
|
+
async list(ticketId, params) {
|
|
1126
|
+
return this.client.request("GET", `/tickets/${ticketId}/messages`, {
|
|
1127
|
+
query: params ? { ...params } : void 0
|
|
1128
|
+
});
|
|
1127
1129
|
}
|
|
1128
1130
|
/** Add a message to a ticket. */
|
|
1129
1131
|
async create(ticketId, params, options) {
|
package/dist/library/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
1
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
|
|
2
2
|
|
|
3
3
|
/** Configuration for the LibraryClient. */
|
|
4
4
|
interface LibraryConfig {
|
package/dist/library/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
1
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
|
|
2
2
|
|
|
3
3
|
/** Configuration for the LibraryClient. */
|
|
4
4
|
interface LibraryConfig {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
1
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Options for the QuickHelpClient. No auth — Quick Help is anonymous by
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-
|
|
1
|
+
export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Options for the QuickHelpClient. No auth — Quick Help is anonymous by
|