@cstar.help/js 0.15.0 → 0.15.1

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/dist/index.d.cts CHANGED
@@ -3110,59 +3110,308 @@ interface ApiErrorBody {
3110
3110
  enable_url?: string;
3111
3111
  }
3112
3112
  /** Base error class for all cStar API errors. */
3113
- declare class CStarErrorImpl extends Error {
3114
- readonly type: string;
3115
- readonly code: string;
3116
- readonly param?: string;
3117
- readonly docUrl: string;
3118
- readonly requestId?: string;
3119
- readonly statusCode: number;
3120
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3121
- }
3122
- declare class CStarAuthenticationErrorImpl extends CStarErrorImpl {
3123
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3124
- }
3125
- declare class CStarRateLimitErrorImpl extends CStarErrorImpl {
3126
- readonly retryAfter: number;
3127
- constructor(messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number);
3128
- }
3129
- declare class CStarNotFoundErrorImpl extends CStarErrorImpl {
3130
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3131
- }
3132
- declare class CStarValidationErrorImpl extends CStarErrorImpl {
3133
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3134
- }
3135
- declare class CStarPermissionErrorImpl extends CStarErrorImpl {
3136
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3137
- }
3138
- declare class CStarConflictErrorImpl extends CStarErrorImpl {
3139
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3140
- }
3141
- declare class CStarServerErrorImpl extends CStarErrorImpl {
3142
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3143
- }
3144
- declare class CStarFeatureDisabledErrorImpl extends CStarErrorImpl {
3145
- readonly feature: string;
3146
- readonly enableUrl: string;
3147
- constructor(messageOrStatus: string | number, body?: ApiErrorBody);
3148
- }
3149
- declare const CStarError: typeof CStarErrorImpl;
3113
+ declare const CStarErrorImpl: {
3114
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3115
+ readonly type: string;
3116
+ readonly code: string;
3117
+ readonly param?: string;
3118
+ readonly docUrl: string;
3119
+ readonly requestId?: string;
3120
+ readonly statusCode: number;
3121
+ name: string;
3122
+ message: string;
3123
+ stack?: string;
3124
+ };
3125
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3126
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3127
+ stackTraceLimit: number;
3128
+ };
3129
+ declare const CStarAuthenticationErrorImpl: {
3130
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3131
+ readonly type: string;
3132
+ readonly code: string;
3133
+ readonly param?: string;
3134
+ readonly docUrl: string;
3135
+ readonly requestId?: string;
3136
+ readonly statusCode: number;
3137
+ name: string;
3138
+ message: string;
3139
+ stack?: string;
3140
+ };
3141
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3142
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3143
+ stackTraceLimit: number;
3144
+ };
3145
+ declare const CStarRateLimitErrorImpl: {
3146
+ new (messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number): {
3147
+ readonly retryAfter: number;
3148
+ readonly type: string;
3149
+ readonly code: string;
3150
+ readonly param?: string;
3151
+ readonly docUrl: string;
3152
+ readonly requestId?: string;
3153
+ readonly statusCode: number;
3154
+ name: string;
3155
+ message: string;
3156
+ stack?: string;
3157
+ };
3158
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3159
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3160
+ stackTraceLimit: number;
3161
+ };
3162
+ declare const CStarNotFoundErrorImpl: {
3163
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3164
+ readonly type: string;
3165
+ readonly code: string;
3166
+ readonly param?: string;
3167
+ readonly docUrl: string;
3168
+ readonly requestId?: string;
3169
+ readonly statusCode: number;
3170
+ name: string;
3171
+ message: string;
3172
+ stack?: string;
3173
+ };
3174
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3175
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3176
+ stackTraceLimit: number;
3177
+ };
3178
+ declare const CStarValidationErrorImpl: {
3179
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3180
+ readonly type: string;
3181
+ readonly code: string;
3182
+ readonly param?: string;
3183
+ readonly docUrl: string;
3184
+ readonly requestId?: string;
3185
+ readonly statusCode: number;
3186
+ name: string;
3187
+ message: string;
3188
+ stack?: string;
3189
+ };
3190
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3191
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3192
+ stackTraceLimit: number;
3193
+ };
3194
+ declare const CStarPermissionErrorImpl: {
3195
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3196
+ readonly type: string;
3197
+ readonly code: string;
3198
+ readonly param?: string;
3199
+ readonly docUrl: string;
3200
+ readonly requestId?: string;
3201
+ readonly statusCode: number;
3202
+ name: string;
3203
+ message: string;
3204
+ stack?: string;
3205
+ };
3206
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3207
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3208
+ stackTraceLimit: number;
3209
+ };
3210
+ declare const CStarConflictErrorImpl: {
3211
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3212
+ readonly type: string;
3213
+ readonly code: string;
3214
+ readonly param?: string;
3215
+ readonly docUrl: string;
3216
+ readonly requestId?: string;
3217
+ readonly statusCode: number;
3218
+ name: string;
3219
+ message: string;
3220
+ stack?: string;
3221
+ };
3222
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3223
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3224
+ stackTraceLimit: number;
3225
+ };
3226
+ declare const CStarServerErrorImpl: {
3227
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3228
+ readonly type: string;
3229
+ readonly code: string;
3230
+ readonly param?: string;
3231
+ readonly docUrl: string;
3232
+ readonly requestId?: string;
3233
+ readonly statusCode: number;
3234
+ name: string;
3235
+ message: string;
3236
+ stack?: string;
3237
+ };
3238
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3239
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3240
+ stackTraceLimit: number;
3241
+ };
3242
+ declare const CStarFeatureDisabledErrorImpl: {
3243
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3244
+ readonly feature: string;
3245
+ readonly enableUrl: string;
3246
+ readonly type: string;
3247
+ readonly code: string;
3248
+ readonly param?: string;
3249
+ readonly docUrl: string;
3250
+ readonly requestId?: string;
3251
+ readonly statusCode: number;
3252
+ name: string;
3253
+ message: string;
3254
+ stack?: string;
3255
+ };
3256
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3257
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3258
+ stackTraceLimit: number;
3259
+ };
3260
+ declare const CStarError: {
3261
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3262
+ readonly type: string;
3263
+ readonly code: string;
3264
+ readonly param?: string;
3265
+ readonly docUrl: string;
3266
+ readonly requestId?: string;
3267
+ readonly statusCode: number;
3268
+ name: string;
3269
+ message: string;
3270
+ stack?: string;
3271
+ };
3272
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3273
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3274
+ stackTraceLimit: number;
3275
+ };
3150
3276
  type CStarError = InstanceType<typeof CStarErrorImpl>;
3151
- declare const CStarAuthenticationError: typeof CStarAuthenticationErrorImpl;
3277
+ declare const CStarAuthenticationError: {
3278
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3279
+ readonly type: string;
3280
+ readonly code: string;
3281
+ readonly param?: string;
3282
+ readonly docUrl: string;
3283
+ readonly requestId?: string;
3284
+ readonly statusCode: number;
3285
+ name: string;
3286
+ message: string;
3287
+ stack?: string;
3288
+ };
3289
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3290
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3291
+ stackTraceLimit: number;
3292
+ };
3152
3293
  type CStarAuthenticationError = InstanceType<typeof CStarAuthenticationErrorImpl>;
3153
- declare const CStarRateLimitError: typeof CStarRateLimitErrorImpl;
3294
+ declare const CStarRateLimitError: {
3295
+ new (messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number): {
3296
+ readonly retryAfter: number;
3297
+ readonly type: string;
3298
+ readonly code: string;
3299
+ readonly param?: string;
3300
+ readonly docUrl: string;
3301
+ readonly requestId?: string;
3302
+ readonly statusCode: number;
3303
+ name: string;
3304
+ message: string;
3305
+ stack?: string;
3306
+ };
3307
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3308
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3309
+ stackTraceLimit: number;
3310
+ };
3154
3311
  type CStarRateLimitError = InstanceType<typeof CStarRateLimitErrorImpl>;
3155
- declare const CStarNotFoundError: typeof CStarNotFoundErrorImpl;
3312
+ declare const CStarNotFoundError: {
3313
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3314
+ readonly type: string;
3315
+ readonly code: string;
3316
+ readonly param?: string;
3317
+ readonly docUrl: string;
3318
+ readonly requestId?: string;
3319
+ readonly statusCode: number;
3320
+ name: string;
3321
+ message: string;
3322
+ stack?: string;
3323
+ };
3324
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3325
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3326
+ stackTraceLimit: number;
3327
+ };
3156
3328
  type CStarNotFoundError = InstanceType<typeof CStarNotFoundErrorImpl>;
3157
- declare const CStarValidationError: typeof CStarValidationErrorImpl;
3329
+ declare const CStarValidationError: {
3330
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3331
+ readonly type: string;
3332
+ readonly code: string;
3333
+ readonly param?: string;
3334
+ readonly docUrl: string;
3335
+ readonly requestId?: string;
3336
+ readonly statusCode: number;
3337
+ name: string;
3338
+ message: string;
3339
+ stack?: string;
3340
+ };
3341
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3342
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3343
+ stackTraceLimit: number;
3344
+ };
3158
3345
  type CStarValidationError = InstanceType<typeof CStarValidationErrorImpl>;
3159
- declare const CStarPermissionError: typeof CStarPermissionErrorImpl;
3346
+ declare const CStarPermissionError: {
3347
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3348
+ readonly type: string;
3349
+ readonly code: string;
3350
+ readonly param?: string;
3351
+ readonly docUrl: string;
3352
+ readonly requestId?: string;
3353
+ readonly statusCode: number;
3354
+ name: string;
3355
+ message: string;
3356
+ stack?: string;
3357
+ };
3358
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3359
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3360
+ stackTraceLimit: number;
3361
+ };
3160
3362
  type CStarPermissionError = InstanceType<typeof CStarPermissionErrorImpl>;
3161
- declare const CStarConflictError: typeof CStarConflictErrorImpl;
3363
+ declare const CStarConflictError: {
3364
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3365
+ readonly type: string;
3366
+ readonly code: string;
3367
+ readonly param?: string;
3368
+ readonly docUrl: string;
3369
+ readonly requestId?: string;
3370
+ readonly statusCode: number;
3371
+ name: string;
3372
+ message: string;
3373
+ stack?: string;
3374
+ };
3375
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3376
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3377
+ stackTraceLimit: number;
3378
+ };
3162
3379
  type CStarConflictError = InstanceType<typeof CStarConflictErrorImpl>;
3163
- declare const CStarServerError: typeof CStarServerErrorImpl;
3380
+ declare const CStarServerError: {
3381
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3382
+ readonly type: string;
3383
+ readonly code: string;
3384
+ readonly param?: string;
3385
+ readonly docUrl: string;
3386
+ readonly requestId?: string;
3387
+ readonly statusCode: number;
3388
+ name: string;
3389
+ message: string;
3390
+ stack?: string;
3391
+ };
3392
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3393
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3394
+ stackTraceLimit: number;
3395
+ };
3164
3396
  type CStarServerError = InstanceType<typeof CStarServerErrorImpl>;
3165
- declare const CStarFeatureDisabledError: typeof CStarFeatureDisabledErrorImpl;
3397
+ declare const CStarFeatureDisabledError: {
3398
+ new (messageOrStatus: string | number, body?: ApiErrorBody): {
3399
+ readonly feature: string;
3400
+ readonly enableUrl: string;
3401
+ readonly type: string;
3402
+ readonly code: string;
3403
+ readonly param?: string;
3404
+ readonly docUrl: string;
3405
+ readonly requestId?: string;
3406
+ readonly statusCode: number;
3407
+ name: string;
3408
+ message: string;
3409
+ stack?: string;
3410
+ };
3411
+ captureStackTrace(targetObject: object, constructorOpt?: Function): void;
3412
+ prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
3413
+ stackTraceLimit: number;
3414
+ };
3166
3415
  type CStarFeatureDisabledError = InstanceType<typeof CStarFeatureDisabledErrorImpl>;
3167
3416
 
3168
3417
  /** Configuration for the CStarClient. */