Skip to content

Commit 9e36aaa

Browse files
adefreitasadefreitas
authored
Merge pull request #25 from StackOneHQ/speakeasy-sdk-regen-1738749266
chore: 🐝 Update SDK - Generate 0.24.0
2 parents 312d67c + 3f8d741 commit 9e36aaa

1,153 files changed

Lines changed: 16991 additions & 862 deletions

File tree

Some content is hidden

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

‎.speakeasy/gen.lock‎

Lines changed: 206 additions & 25 deletions
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ generation:
1313
oAuth2ClientCredentialsEnabled: false
1414
oAuth2PasswordEnabled: false
1515
php:
16-
version: 0.23.3
16+
version: 0.24.0
1717
additionalDependencies:
1818
autoload: {}
1919
autoload-dev: {}

‎.speakeasy/workflow.lock‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
speakeasyVersion: 1.481.0
1+
speakeasyVersion: 1.484.1
22
sources:
33
hris:
44
sourceNamespace: hris
@@ -8,20 +8,20 @@ sources:
88
- latest
99
stackone-specs:
1010
sourceNamespace: stackone-specs
11-
sourceRevisionDigest: sha256:f29583d856781f640694721c439fc7e798a805b7337b8843930967332eb016d4
12-
sourceBlobDigest: sha256:7bd86ba6d66f41b0a7135b2724b465a25837eae5feb992d50af52b0027559dc6
11+
sourceRevisionDigest: sha256:492e45f819a1f2097121f8c7c01b72dc09c43af76f57f691d53f5b4eaf422012
12+
sourceBlobDigest: sha256:527e844918dc41155c80552f8b931e4fbbf064c32954b68a58ea3bd39f6ec906
1313
tags:
1414
- latest
15-
- speakeasy-sdk-regen-1738334978
15+
- speakeasy-sdk-regen-1738749266
1616
- 1.0.0
1717
targets:
1818
stack-one:
1919
source: stackone-specs
2020
sourceNamespace: stackone-specs
21-
sourceRevisionDigest: sha256:f29583d856781f640694721c439fc7e798a805b7337b8843930967332eb016d4
22-
sourceBlobDigest: sha256:7bd86ba6d66f41b0a7135b2724b465a25837eae5feb992d50af52b0027559dc6
21+
sourceRevisionDigest: sha256:492e45f819a1f2097121f8c7c01b72dc09c43af76f57f691d53f5b4eaf422012
22+
sourceBlobDigest: sha256:527e844918dc41155c80552f8b931e4fbbf064c32954b68a58ea3bd39f6ec906
2323
codeSamplesNamespace: stackone-specs-php-code-samples
24-
codeSamplesRevisionDigest: sha256:da4d9fb1126f70a41cace33680896fea9f08c58e539b976d19da39eb794b55fe
24+
codeSamplesRevisionDigest: sha256:4bb66ee299a7008555fe9c01d6a6d381eadd29a4aca13e4dd00e0e5a368aa6bf
2525
workflow:
2626
workflowVersion: 1.0.0
2727
speakeasyVersion: latest

‎README.md‎

Lines changed: 97 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Marketing: The documentation for the StackOne Unified API - MARKETING
2222
* [Authentication](#authentication)
2323
* [Available Resources and Operations](#available-resources-and-operations)
2424
* [Pagination](#pagination)
25+
* [Retries](#retries)
2526
* [Error Handling](#error-handling)
2627
* [Server Selection](#server-selection)
2728
* [Development](#development)
@@ -211,6 +212,8 @@ if ($response->connectSession !== null) {
211212
* [rejectApplication](docs/sdks/ats/README.md#rejectapplication) - Reject Application
212213
* [updateApplication](docs/sdks/ats/README.md#updateapplication) - Update an Application
213214
* [updateApplicationNote](docs/sdks/ats/README.md#updateapplicationnote) - Update an Application Note
215+
* [updateAssessmentsResult](docs/sdks/ats/README.md#updateassessmentsresult) - Update Assessments Result
216+
* [updateBackgroundCheckResult](docs/sdks/ats/README.md#updatebackgroundcheckresult) - Update Background Check Result
214217
* [updateCandidate](docs/sdks/ats/README.md#updatecandidate) - Update Candidate
215218
* [updateJob](docs/sdks/ats/README.md#updatejob) - Update Job
216219
* [uploadApplicationDocument](docs/sdks/ats/README.md#uploadapplicationdocument) - Upload Application Document
@@ -262,6 +265,7 @@ if ($response->connectSession !== null) {
262265
* [getGroup](docs/sdks/hris/README.md#getgroup) - Get Group
263266
* [getJob](docs/sdks/hris/README.md#getjob) - Get Job
264267
* [getLocation](docs/sdks/hris/README.md#getlocation) - Get Location
268+
* [getTeamGroup](docs/sdks/hris/README.md#getteamgroup) - Get Team Group
265269
* [getTimeEntries](docs/sdks/hris/README.md#gettimeentries) - Get Time Entry
266270
* [getTimeOffRequest](docs/sdks/hris/README.md#gettimeoffrequest) - Get time off request
267271
* [getTimeOffType](docs/sdks/hris/README.md#gettimeofftype) - Get time off type
@@ -280,6 +284,7 @@ if ($response->connectSession !== null) {
280284
* [listGroups](docs/sdks/hris/README.md#listgroups) - List Groups
281285
* [listJobs](docs/sdks/hris/README.md#listjobs) - List Jobs
282286
* [listLocations](docs/sdks/hris/README.md#listlocations) - List locations
287+
* [listTeamGroups](docs/sdks/hris/README.md#listteamgroups) - List Team Groups
283288
* [listTimeEntries](docs/sdks/hris/README.md#listtimeentries) - List Time Entries
284289
* [listTimeOffRequests](docs/sdks/hris/README.md#listtimeoffrequests) - List time off requests
285290
* [listTimeOffTypes](docs/sdks/hris/README.md#listtimeofftypes) - List time off types
@@ -307,6 +312,7 @@ if ($response->connectSession !== null) {
307312
* [createCollection](docs/sdks/lms/README.md#createcollection) - Create Collection
308313
* [createUserAssignment](docs/sdks/lms/README.md#createuserassignment) - Create User Assignment
309314
* [createUserCompletion](docs/sdks/lms/README.md#createusercompletion) - Create User Completion
315+
* [deleteUserCompletion](docs/sdks/lms/README.md#deleteusercompletion) - Delete User Completion
310316
* [getAssignment](docs/sdks/lms/README.md#getassignment) - Get Assignment
311317
* [getCategory](docs/sdks/lms/README.md#getcategory) - Get Category
312318
* [getCompletion](docs/sdks/lms/README.md#getcompletion) - Get Completion
@@ -391,17 +397,15 @@ $sdk = client\StackOne::builder()
391397
)
392398
->build();
393399

394-
$request = new Operations\HrisListEmployeesRequest(
400+
$request = new Operations\HrisListBenefitsRequest(
395401
xAccountId: '<id>',
396-
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',
397-
filter: new Operations\HrisListEmployeesQueryParamFilter(
402+
fields: 'id,remote_id,name,benefit_type,provider,description,created_at,updated_at',
403+
filter: new Operations\HrisListBenefitsQueryParamFilter(
398404
updatedAfter: '2020-01-01T00:00:00.000Z',
399405
),
400-
expand: 'company,employments,work_location,home_location,groups',
401-
include: 'avatar_url,avatar,custom_fields,job_description,benefits',
402406
);
403407

404-
$responses = $sdk->hris->listEmployees(
408+
$responses = $sdk->hris->listBenefits(
405409
request: $request
406410
);
407411

@@ -414,6 +418,93 @@ foreach ($responses as $response) {
414418
```
415419
<!-- End Pagination [pagination] -->
416420

421+
<!-- Start Retries [retries] -->
422+
## Retries
423+
424+
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
425+
426+
To change the default retry strategy for a single API call, simply provide an `Options` object built with a `RetryConfig` object to the call:
427+
```php
428+
declare(strict_types=1);
429+
430+
require 'vendor/autoload.php';
431+
432+
use StackOne\client;
433+
use StackOne\client\Models\Components;
434+
use StackOne\client\Utils\Retry;
435+
436+
$sdk = client\StackOne::builder()
437+
->setSecurity(
438+
new Components\Security(
439+
username: '',
440+
password: '',
441+
)
442+
)
443+
->build();
444+
445+
$request = new Components\ConnectSessionAuthenticate(
446+
token: '<value>',
447+
);
448+
449+
$response = $sdk->connectSessions->authenticateConnectSession(
450+
request: $request,
451+
options: Utils\Options->builder()->setRetryConfig(
452+
new Retry\RetryConfigBackoff(
453+
initialInterval: 1,
454+
maxInterval: 50,
455+
exponent: 1.1,
456+
maxElapsedTime: 100,
457+
retryConnectionErrors: false,
458+
))->build()
459+
);
460+
461+
if ($response->connectSession !== null) {
462+
// handle response
463+
}
464+
```
465+
466+
If you'd like to override the default retry strategy for all operations that support retries, you can pass a `RetryConfig` object to the `SDKBuilder->setRetryConfig` function when initializing the SDK:
467+
```php
468+
declare(strict_types=1);
469+
470+
require 'vendor/autoload.php';
471+
472+
use StackOne\client;
473+
use StackOne\client\Models\Components;
474+
use StackOne\client\Utils\Retry;
475+
476+
$sdk = client\StackOne::builder()
477+
->setRetryConfig(
478+
new Retry\RetryConfigBackoff(
479+
initialInterval: 1,
480+
maxInterval: 50,
481+
exponent: 1.1,
482+
maxElapsedTime: 100,
483+
retryConnectionErrors: false,
484+
)
485+
)
486+
->setSecurity(
487+
new Components\Security(
488+
username: '',
489+
password: '',
490+
)
491+
)
492+
->build();
493+
494+
$request = new Components\ConnectSessionAuthenticate(
495+
token: '<value>',
496+
);
497+
498+
$response = $sdk->connectSessions->authenticateConnectSession(
499+
request: $request
500+
);
501+
502+
if ($response->connectSession !== null) {
503+
// handle response
504+
}
505+
```
506+
<!-- End Retries [retries] -->
507+
417508
<!-- Start Error Handling [errors] -->
418509
## Error Handling
419510

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,4 +168,14 @@ Based on:
168168
### Generated
169169
- [php v0.23.3] .
170170
### Releases
171-
- [Composer v0.23.3] https://packagist.org/packages/stackone/client-sdk#v0.23.3 - .
171+
- [Composer v0.23.3] https://packagist.org/packages/stackone/client-sdk#v0.23.3 - .
172+
173+
## 2025-02-05 09:54:12
174+
### Changes
175+
Based on:
176+
- OpenAPI Doc
177+
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
178+
### Generated
179+
- [php v0.24.0] .
180+
### Releases
181+
- [Composer v0.24.0] https://packagist.org/packages/stackone/client-sdk#v0.24.0 - .

‎docs/Models/Components/AdditionalData.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description | Example |
7-
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
8-
| `id` | *?string* | :heavy_minus_sign: | The type of the additional data | learning_outcomes |
9-
| `remoteId` | *?string* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 |
10-
| `value` | [?Components\AdditionalDataValue](../../Models/Components/AdditionalDataValue.md) | :heavy_minus_sign: | The value of the additional data | This is additional data |
6+
| Field | Type | Required | Description | Example |
7+
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
8+
| `id` | *?string* | :heavy_minus_sign: | The type of the additional data | learning_outcomes |
9+
| `remoteId` | *?string* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 |
10+
| `value` | [string\|array\|null](../../Models/Components/AdditionalDataValue.md) | :heavy_minus_sign: | The value of the additional data | This is additional data |

‎docs/Models/Components/AdditionalDataValue.md‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,23 @@
33
The value of the additional data
44

55

6-
## Fields
6+
## Supported Types
7+
8+
### `string`
9+
10+
```php
11+
/**
12+
* @var string
13+
*/
14+
string $value = /* values here */
15+
```
16+
17+
### `array`
18+
19+
```php
20+
/**
21+
* @var array<string>
22+
*/
23+
array $value = /* values here */
24+
```
725

8-
| Field | Type | Required | Description |
9-
| ----------- | ----------- | ----------- | ----------- |

‎docs/Models/Components/AssessmentResultValue.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The result of the test.
88
| Name | Value |
99
| ----------- | ----------- |
1010
| `Cancelled` | cancelled |
11+
| `Completed` | completed |
1112
| `Expired` | expired |
1213
| `Failed` | failed |
1314
| `Passed` | passed |

0 commit comments

Comments
 (0)