Skip to content

Commit fe601c6

Browse files
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.455.3 (#156)
Co-authored-by: speakeasybot <[email protected]>
1 parent 8553ec3 commit fe601c6

File tree

750 files changed

+4814
-1014
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

750 files changed

+4814
-1014
lines changed

.speakeasy/gen.lock

Lines changed: 39 additions & 16 deletions
Large diffs are not rendered by default.

.speakeasy/workflow.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.453.4
1+
speakeasyVersion: 1.455.3
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:45f21a236f8ce564e9f6f4feb7a67ce4dfd9472edd67669c8e1c83c65760a53c
6-
sourceBlobDigest: sha256:4538714e52eeabd47be0b5cca01b828f507365abdb0d921ff90c5cdbac410994
5+
sourceRevisionDigest: sha256:265a3ba335a1741026e908e94aab6049654e20dc808eb1e61f6ed39b72d50f0a
6+
sourceBlobDigest: sha256:2d63f84a77650c6df7f4b8419187de64835eba8eceecc7c91fd52a09a8dd2e7b
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1733735228
9+
- speakeasy-sdk-regen-1734340014
1010
- 1.0.0
1111
targets:
1212
StackOneTypeScriptClient:
1313
source: my-source
1414
sourceNamespace: my-source
15-
sourceRevisionDigest: sha256:45f21a236f8ce564e9f6f4feb7a67ce4dfd9472edd67669c8e1c83c65760a53c
16-
sourceBlobDigest: sha256:4538714e52eeabd47be0b5cca01b828f507365abdb0d921ff90c5cdbac410994
15+
sourceRevisionDigest: sha256:265a3ba335a1741026e908e94aab6049654e20dc808eb1e61f6ed39b72d50f0a
16+
sourceBlobDigest: sha256:2d63f84a77650c6df7f4b8419187de64835eba8eceecc7c91fd52a09a8dd2e7b
1717
codeSamplesNamespace: code-samples-typescript-stackonetypescriptclient
18-
codeSamplesRevisionDigest: sha256:d5b3d51f9f962d765c1cc584aa18bc77dc70cb899b9a97b3e7aaa6066a4ee6f3
18+
codeSamplesRevisionDigest: sha256:ca5df78d0bd2253ae4aad4259bd963eb3dd4871c8696b5a1ee985b92cc7986c7
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

FUNCTIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ const stackOne = new StackOneCore({
3434

3535
async function run() {
3636
const res = await hrisListEmployees(stackOne, {
37-
expand: "company,employments,work_location,home_location,custom_fields,groups",
37+
expand: "company,employments,work_location,home_location,groups",
3838
fields: "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number",
3939
filter: {
4040
updatedAfter: "2020-01-01T00:00:00.000Z",

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,7 @@ const stackOne = new StackOne({
7878

7979
async function run() {
8080
const result = await stackOne.hris.listEmployees({
81-
expand:
82-
"company,employments,work_location,home_location,custom_fields,groups",
81+
expand: "company,employments,work_location,home_location,groups",
8382
fields:
8483
"id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number",
8584
filter: {
@@ -268,6 +267,7 @@ run();
268267
* [batchUpsertContent](docs/sdks/lms/README.md#batchupsertcontent) - Batch Upsert Content
269268
* [batchUpsertCourse](docs/sdks/lms/README.md#batchupsertcourse) - Batch Upsert Course
270269
* [createCollection](docs/sdks/lms/README.md#createcollection) - Create Collection
270+
* [createUserAssignment](docs/sdks/lms/README.md#createuserassignment) - Create User Assignment
271271
* [createUserCompletion](docs/sdks/lms/README.md#createusercompletion) - Create User Completion
272272
* [getAssignment](docs/sdks/lms/README.md#getassignment) - Get Assignment
273273
* [getCategory](docs/sdks/lms/README.md#getcategory) - Get Category
@@ -356,8 +356,7 @@ const stackOne = new StackOne({
356356

357357
async function run() {
358358
const result = await stackOne.hris.listEmployees({
359-
expand:
360-
"company,employments,work_location,home_location,custom_fields,groups",
359+
expand: "company,employments,work_location,home_location,groups",
361360
fields:
362361
"id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number",
363362
filter: {
@@ -382,19 +381,7 @@ run();
382381
<!-- Start Error Handling [errors] -->
383382
## Error Handling
384383

385-
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
386-
387-
If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
388-
389-
| HTTP Client Error | Description |
390-
| ---------------------------------------------------- | ---------------------------------------------------- |
391-
| RequestAbortedError | HTTP request was aborted by the client |
392-
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
393-
| ConnectionError | HTTP client was unable to make a request to a server |
394-
| InvalidRequestError | Any input used to create a request is invalid |
395-
| UnexpectedClientError | Unrecognised or unexpected error |
396-
397-
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `deleteAccount` method may throw the following errors:
384+
If the request fails due to, for example 4XX or 5XX status codes, it will throw a `SDKError`.
398385

399386
| Error Type | Status Code | Content Type |
400387
| --------------- | ----------- | ------------ |
@@ -422,14 +409,24 @@ async function run() {
422409
console.log(result);
423410
} catch (err) {
424411
switch (true) {
425-
case (err instanceof SDKValidationError): {
426-
// Validation errors can be pretty-printed
427-
console.error(err.pretty());
428-
// Raw value may also be inspected
429-
console.error(err.rawValue);
412+
// The server response does not match the expected SDK schema
413+
case (err instanceof SDKValidationError):
414+
{
415+
// Pretty-print will provide a human-readable multi-line error message
416+
console.error(err.pretty());
417+
// Raw value may also be inspected
418+
console.error(err.rawValue);
419+
return;
420+
}
421+
sdkerror.js;
422+
// Server returned an error status code or an unknown content type
423+
case (err instanceof SDKError): {
424+
console.error(err.statusCode);
425+
console.error(err.rawResponse.body);
430426
return;
431427
}
432428
default: {
429+
// Other errors such as network errors, see HTTPClientErrors for more details
433430
throw err;
434431
}
435432
}
@@ -440,7 +437,17 @@ run();
440437

441438
```
442439

443-
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
440+
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
441+
442+
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `sdk/models/errors/httpclienterrors.ts` module:
443+
444+
| HTTP Client Error | Description |
445+
| ---------------------------------------------------- | ---------------------------------------------------- |
446+
| RequestAbortedError | HTTP request was aborted by the client |
447+
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
448+
| ConnectionError | HTTP client was unable to make a request to a server |
449+
| InvalidRequestError | Any input used to create a request is invalid |
450+
| UnexpectedClientError | Unrecognised or unexpected error |
444451
<!-- End Error Handling [errors] -->
445452

446453

@@ -768,6 +775,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
768775
- [`lmsBatchUpsertContent`](docs/sdks/lms/README.md#batchupsertcontent) - Batch Upsert Content
769776
- [`lmsBatchUpsertCourse`](docs/sdks/lms/README.md#batchupsertcourse) - Batch Upsert Course
770777
- [`lmsCreateCollection`](docs/sdks/lms/README.md#createcollection) - Create Collection
778+
- [`lmsCreateUserAssignment`](docs/sdks/lms/README.md#createuserassignment) - Create User Assignment
771779
- [`lmsCreateUserCompletion`](docs/sdks/lms/README.md#createusercompletion) - Create User Completion
772780
- [`lmsGetAssignment`](docs/sdks/lms/README.md#getassignment) - Get Assignment
773781
- [`lmsGetCategory`](docs/sdks/lms/README.md#getcategory) - Get Category

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1366,4 +1366,14 @@ Based on:
13661366
### Generated
13671367
- [typescript v4.17.4] .
13681368
### Releases
1369-
- [NPM v4.17.4] https://www.npmjs.com/package/@stackone/stackone-client-ts/v/4.17.4 - .
1369+
- [NPM v4.17.4] https://www.npmjs.com/package/@stackone/stackone-client-ts/v/4.17.4 - .
1370+
1371+
## 2024-12-16 09:06:48
1372+
### Changes
1373+
Based on:
1374+
- OpenAPI Doc
1375+
- Speakeasy CLI 1.455.3 (2.479.3) https://github.com/speakeasy-api/speakeasy
1376+
### Generated
1377+
- [typescript v4.17.5] .
1378+
### Releases
1379+
- [NPM v4.17.5] https://www.npmjs.com/package/@stackone/stackone-client-ts/v/4.17.5 - .

USAGE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ const stackOne = new StackOne({
1313

1414
async function run() {
1515
const result = await stackOne.hris.listEmployees({
16-
expand:
17-
"company,employments,work_location,home_location,custom_fields,groups",
16+
expand: "company,employments,work_location,home_location,groups",
1817
fields:
1918
"id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number",
2019
filter: {

0 commit comments

Comments
 (0)