@@ -257,6 +257,7 @@ run();
257257* [ listEmployeeEmployments] ( docs/sdks/hris/README.md#listemployeeemployments ) - List Employee Employments
258258* [ listEmployeeSkills] ( docs/sdks/hris/README.md#listemployeeskills ) - List Employee Skills
259259* [ listEmployeeTimeOffBalances] ( docs/sdks/hris/README.md#listemployeetimeoffbalances ) - List Employee Time Off Balances
260+ * [ listEmployeeTimeOffPolicies] ( docs/sdks/hris/README.md#listemployeetimeoffpolicies ) - List Assigned Time Off Policies
260261* [ listEmployeeTimeOffRequests] ( docs/sdks/hris/README.md#listemployeetimeoffrequests ) - List Employee Time Off Requests
261262* [ listEmployeeWorkEligibility] ( docs/sdks/hris/README.md#listemployeeworkeligibility ) - List Employee Work Eligibility
262263* [ listEmployees] ( docs/sdks/hris/README.md#listemployees ) - List Employees
@@ -352,6 +353,12 @@ run();
352353
353354* [ proxyRequest] ( docs/sdks/proxy/README.md#proxyrequest ) - Proxy Request
354355
356+ ### [ requestLogs] ( docs/sdks/requestlogs/README.md )
357+
358+ * [ getLog] ( docs/sdks/requestlogs/README.md#getlog ) - Get a Log
359+ * [ listLogs] ( docs/sdks/requestlogs/README.md#listlogs ) - List Logs
360+ * [ listStepLogs] ( docs/sdks/requestlogs/README.md#liststeplogs ) - List Step Logs
361+
355362
356363</details >
357364<!-- End Available Resources and Operations [operations] -->
@@ -404,15 +411,41 @@ run();
404411<!-- Start Error Handling [errors] -->
405412## Error Handling
406413
407- If the request fails due to, for example 4XX or 5XX status codes, it will throw a ` SDKError ` .
408-
409- | Error Type | Status Code | Content Type |
410- | --------------- | ----------- | ------------ |
411- | errors.SDKError | 4XX, 5XX | \* /\* |
414+ Some methods specify known errors which can be thrown. All the known errors are enumerated in the ` sdk/models/errors/errors.ts ` module. The known errors for a method are documented under the * Errors* tables in SDK docs. For example, the ` deleteAccount ` method may throw the following errors:
415+
416+ | Error Type | Status Code | Content Type |
417+ | ---------------------------------- | ----------- | ---------------- |
418+ | errors.BadRequestResponse | 400 | application/json |
419+ | errors.UnauthorizedResponse | 401 | application/json |
420+ | errors.ForbiddenResponse | 403 | application/json |
421+ | errors.NotFoundResponse | 404 | application/json |
422+ | errors.RequestTimedOutResponse | 408 | application/json |
423+ | errors.ConflictResponse | 409 | application/json |
424+ | errors.UnprocessableEntityResponse | 422 | application/json |
425+ | errors.TooManyRequestsResponse | 429 | application/json |
426+ | errors.InternalServerErrorResponse | 500 | application/json |
427+ | errors.NotImplementedResponse | 501 | application/json |
428+ | errors.BadGatewayResponse | 502 | application/json |
429+ | errors.SDKError | 4XX, 5XX | \* /\* |
430+
431+ If the method throws an error and it is not captured by the known errors, it will default to throwing a ` SDKError ` .
412432
413433``` typescript
414434import { StackOne } from " @stackone/stackone-client-ts" ;
415- import { SDKValidationError } from " @stackone/stackone-client-ts/sdk/models/errors" ;
435+ import {
436+ BadGatewayResponse ,
437+ BadRequestResponse ,
438+ ConflictResponse ,
439+ ForbiddenResponse ,
440+ InternalServerErrorResponse ,
441+ NotFoundResponse ,
442+ NotImplementedResponse ,
443+ RequestTimedOutResponse ,
444+ SDKValidationError ,
445+ TooManyRequestsResponse ,
446+ UnauthorizedResponse ,
447+ UnprocessableEntityResponse ,
448+ } from " @stackone/stackone-client-ts/sdk/models/errors" ;
416449
417450const stackOne = new StackOne ({
418451 security: {
@@ -433,19 +466,66 @@ async function run() {
433466 } catch (err ) {
434467 switch (true ) {
435468 // The server response does not match the expected SDK schema
436- case (err instanceof SDKValidationError ):
437- {
438- // Pretty-print will provide a human-readable multi-line error message
439- console .error (err .pretty ());
440- // Raw value may also be inspected
441- console .error (err .rawValue );
442- return ;
443- }
444- sdkerror .js ;
445- // Server returned an error status code or an unknown content type
446- case (err instanceof SDKError ): {
447- console .error (err .statusCode );
448- console .error (err .rawResponse .body );
469+ case (err instanceof SDKValidationError ): {
470+ // Pretty-print will provide a human-readable multi-line error message
471+ console .error (err .pretty ());
472+ // Raw value may also be inspected
473+ console .error (err .rawValue );
474+ return ;
475+ }
476+ case (err instanceof BadRequestResponse ): {
477+ // Handle err.data$: BadRequestResponseData
478+ console .error (err );
479+ return ;
480+ }
481+ case (err instanceof UnauthorizedResponse ): {
482+ // Handle err.data$: UnauthorizedResponseData
483+ console .error (err );
484+ return ;
485+ }
486+ case (err instanceof ForbiddenResponse ): {
487+ // Handle err.data$: ForbiddenResponseData
488+ console .error (err );
489+ return ;
490+ }
491+ case (err instanceof NotFoundResponse ): {
492+ // Handle err.data$: NotFoundResponseData
493+ console .error (err );
494+ return ;
495+ }
496+ case (err instanceof RequestTimedOutResponse ): {
497+ // Handle err.data$: RequestTimedOutResponseData
498+ console .error (err );
499+ return ;
500+ }
501+ case (err instanceof ConflictResponse ): {
502+ // Handle err.data$: ConflictResponseData
503+ console .error (err );
504+ return ;
505+ }
506+ case (err instanceof UnprocessableEntityResponse ): {
507+ // Handle err.data$: UnprocessableEntityResponseData
508+ console .error (err );
509+ return ;
510+ }
511+ case (err instanceof TooManyRequestsResponse ): {
512+ // Handle err.data$: TooManyRequestsResponseData
513+ console .error (err );
514+ return ;
515+ }
516+ case (err instanceof InternalServerErrorResponse ): {
517+ // Handle err.data$: InternalServerErrorResponseData
518+ console .error (err );
519+ return ;
520+ }
521+ case (err instanceof NotImplementedResponse ): {
522+ // Handle err.data$: NotImplementedResponseData
523+ console .error (err );
524+ return ;
525+ }
526+ case (err instanceof BadGatewayResponse ): {
527+ // Handle err.data$: BadGatewayResponseData
528+ console .error (err );
449529 return ;
450530 }
451531 default : {
@@ -791,6 +871,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
791871- [ ` hrisListEmployees ` ] ( docs/sdks/hris/README.md#listemployees ) - List Employees
792872- [ ` hrisListEmployeeSkills ` ] ( docs/sdks/hris/README.md#listemployeeskills ) - List Employee Skills
793873- [ ` hrisListEmployeeTimeOffBalances ` ] ( docs/sdks/hris/README.md#listemployeetimeoffbalances ) - List Employee Time Off Balances
874+ - [ ` hrisListEmployeeTimeOffPolicies ` ] ( docs/sdks/hris/README.md#listemployeetimeoffpolicies ) - List Assigned Time Off Policies
794875- [ ` hrisListEmployeeTimeOffRequests ` ] ( docs/sdks/hris/README.md#listemployeetimeoffrequests ) - List Employee Time Off Requests
795876- [ ` hrisListEmployeeWorkEligibility ` ] ( docs/sdks/hris/README.md#listemployeeworkeligibility ) - List Employee Work Eligibility
796877- [ ` hrisListEmployments ` ] ( docs/sdks/hris/README.md#listemployments ) - List Employments
@@ -866,6 +947,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
866947- [ ` marketingUpdatePushTemplate ` ] ( docs/sdks/marketing/README.md#updatepushtemplate ) - Update Push Template
867948- [ ` marketingUpdateSmsTemplate ` ] ( docs/sdks/marketing/README.md#updatesmstemplate ) - Update SMS Template
868949- [ ` proxyProxyRequest ` ] ( docs/sdks/proxy/README.md#proxyrequest ) - Proxy Request
950+ - [ ` requestLogsGetLog ` ] ( docs/sdks/requestlogs/README.md#getlog ) - Get a Log
951+ - [ ` requestLogsListLogs ` ] ( docs/sdks/requestlogs/README.md#listlogs ) - List Logs
952+ - [ ` requestLogsListStepLogs ` ] ( docs/sdks/requestlogs/README.md#liststeplogs ) - List Step Logs
869953- ~~ [ ` hrisCreateTimeOffRequest ` ] ( docs/sdks/hris/README.md#createtimeoffrequest ) ~~ - Creates a time off request :warning : ** Deprecated**
870954- ~~ [ ` hrisGetTimeOffType ` ] ( docs/sdks/hris/README.md#gettimeofftype ) ~~ - Get time off type :warning : ** Deprecated**
871955- ~~ [ ` hrisListTimeOffTypes ` ] ( docs/sdks/hris/README.md#listtimeofftypes ) ~~ - List time off types :warning : ** Deprecated**
0 commit comments