Skip to content

Commit 371dc32

Browse files
ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.135.0 (#2)
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
1 parent 4338eef commit 371dc32

File tree

760 files changed

+237567
-0
lines changed

Some content is hidden

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

760 files changed

+237567
-0
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This allows generated code to be indexed correctly
2+
*.rb linguist-generated=false

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.gem
2+
Gemfile.lock
3+
.rbenv-gemsets
4+
.DS_Store

.rubocop.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
AllCops:
2+
Exclude:
3+
- Rakefile
4+
TargetRubyVersion: "3.0"
5+
Metrics:
6+
Enabled: false
7+
Style/IfInsideElse:
8+
Enabled: false
9+
Style/GuardClause:
10+
Enabled: false
11+
Style/ConditionalAssignment:
12+
Enabled: false
13+
Style/Documentation:
14+
Enabled: false
15+
Style/NegatedIf:
16+
Enabled: false
17+
Style/SoleNestedConditional:
18+
Enabled: false
19+
Style/AccessorGrouping:
20+
Enabled: false
21+
Layout/EndAlignment:
22+
EnforcedStyleAlignWith: start_of_line
23+
Enabled: false
24+
Layout/LineLength:
25+
Enabled: false
26+
Lint/EmptyConditionalBody:
27+
Enabled: false
28+
Lint/MissingSuper:
29+
Enabled: false
30+
Style/CaseLikeIf:
31+
Enabled: false
32+
#To eventually re-enable:
33+
Layout/EmptyLines:
34+
Enabled: false
35+
Layout/EmptyLinesAroundMethodBody:
36+
Enabled: false
37+
Layout/EmptyLineBetweenDefs:
38+
Enabled: false
39+
Layout/EmptyLineAfterGuardClause:
40+
Enabled: false
41+
Layout/EmptyLinesAroundModuleBody:
42+
Enabled: false
43+
Layout/MultilineBlockLayout:
44+
Enabled: false
45+
Lint/UnusedMethodArgument:
46+
Enabled: false
47+
Layout/TrailingWhitespace:
48+
Enabled: false
49+
Style/IfUnlessModifier:
50+
Enabled: false
51+
Naming/AccessorMethodName:
52+
Enabled: false
53+
Naming/MethodParameterName:
54+
Enabled: false
55+
Layout/SpaceInsideHashLiteralBraces:
56+
Enabled: false
57+
Layout/FirstHashElementIndentation:
58+
Enabled: false
59+
Style/TrailingCommaInHashLiteral:
60+
Enabled: false
61+
Style/TrailingCommaInArrayLiteral:
62+
Enabled: false
63+
Layout/EmptyLinesAroundClassBody:
64+
Enabled: false
65+
Style/WordArray:
66+
Enabled: false
67+
Style/RedundantReturn: # https://github.com/rubocop/rubocop/issues/12394
68+
Enabled: false
69+
Style/RedundantAssignment:
70+
Enabled: false
71+
Lint/LiteralAsCondition:
72+
Enabled: false
73+
Naming/VariableNumber:
74+
Enabled: false

.speakeasy/gen.lock

Lines changed: 780 additions & 0 deletions
Large diffs are not rendered by default.

Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
# Specify your gem's dependencies in openapi.gemspec
6+
gemspec

README.md

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
# stackone_client
2+
3+
<div align="left">
4+
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
5+
<a href="https://opensource.org/licenses/MIT">
6+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
7+
</a>
8+
</div>
9+
10+
11+
## 🏗 **Welcome to your new SDK!** 🏗
12+
13+
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
14+
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
15+
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
16+
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
17+
- [ ] ✨ When ready to productionize, delete this section from the README
18+
19+
<!-- Start SDK Installation [installation] -->
20+
## SDK Installation
21+
22+
```bash
23+
gem install stackone_client
24+
```
25+
<!-- End SDK Installation [installation] -->
26+
27+
<!-- Start SDK Example Usage [usage] -->
28+
## SDK Example Usage
29+
30+
### List Employees
31+
32+
```ruby
33+
require_relative stackone_client
34+
35+
36+
s = StackOne::StackOne.new
37+
s.config_security(
38+
security=Shared::Security.new(
39+
password="<YOUR_PASSWORD_HERE>",
40+
)
41+
)
42+
43+
44+
req = Operations::HrisListEmployeesRequest.new(
45+
proxy=Operations::HrisListEmployeesQueryParamProxy.new(),
46+
x_account_id="string",
47+
)
48+
49+
res = s.hris.list_employees(req)
50+
51+
if ! res.employees_paginated.nil?
52+
# handle response
53+
end
54+
55+
```
56+
<!-- End SDK Example Usage [usage] -->
57+
58+
<!-- Start Available Resources and Operations [operations] -->
59+
## Available Resources and Operations
60+
61+
### [Accounts](docs/sdks/accounts/README.md)
62+
63+
* [delete_account](docs/sdks/accounts/README.md#delete_account) - Delete Account
64+
* [get_account](docs/sdks/accounts/README.md#get_account) - Get Account
65+
* [get_account_meta_info](docs/sdks/accounts/README.md#get_account_meta_info) - Get meta information of the account
66+
* [list_linked_accounts](docs/sdks/accounts/README.md#list_linked_accounts) - List Accounts
67+
* [update_account](docs/sdks/accounts/README.md#update_account) - Update Account
68+
69+
### [ConnectSessions](docs/sdks/connectsessions/README.md)
70+
71+
* [authenticate_connect_session](docs/sdks/connectsessions/README.md#authenticate_connect_session) - Authenticate Connect Session
72+
* [create_connect_session](docs/sdks/connectsessions/README.md#create_connect_session) - Create Connect Session
73+
74+
### [Connectors](docs/sdks/connectors/README.md)
75+
76+
* [get_connector_meta](docs/sdks/connectors/README.md#get_connector_meta) - Get Connector Meta information for the given provider key
77+
* [list_connectors_meta](docs/sdks/connectors/README.md#list_connectors_meta) - List Connectors Meta Information for all providers
78+
79+
### [Ats](docs/sdks/ats/README.md)
80+
81+
* [create_application](docs/sdks/ats/README.md#create_application) - Create Application
82+
* [create_candidate](docs/sdks/ats/README.md#create_candidate) - Create Candidate (early access)
83+
* [create_candidate_note](docs/sdks/ats/README.md#create_candidate_note) - Create Candidate Note
84+
* [create_offer](docs/sdks/ats/README.md#create_offer) - Creates an offer
85+
* [get_application](docs/sdks/ats/README.md#get_application) - Get Application
86+
* [get_application_offer](docs/sdks/ats/README.md#get_application_offer) - Get Application Offer
87+
* [get_application_scorecard](docs/sdks/ats/README.md#get_application_scorecard) - Get Application Scorecard
88+
* [get_candidate](docs/sdks/ats/README.md#get_candidate) - Get Candidate
89+
* [get_candidate_note](docs/sdks/ats/README.md#get_candidate_note) - Get Candidate Note
90+
* [get_department](docs/sdks/ats/README.md#get_department) - Get Department
91+
* [get_interview](docs/sdks/ats/README.md#get_interview) - Get Interview
92+
* [get_interview_stage](docs/sdks/ats/README.md#get_interview_stage) - Get Interview Stage
93+
* [get_job](docs/sdks/ats/README.md#get_job) - Get Job
94+
* [get_job_posting](docs/sdks/ats/README.md#get_job_posting) - Get Job Posting
95+
* [get_location](docs/sdks/ats/README.md#get_location) - Get Location
96+
* [get_offer](docs/sdks/ats/README.md#get_offer) - Get Offer
97+
* [get_rejected_reason](docs/sdks/ats/README.md#get_rejected_reason) - Get Rejected Reason
98+
* [get_user](docs/sdks/ats/README.md#get_user) - Get User
99+
* [list_application_scorecards](docs/sdks/ats/README.md#list_application_scorecards) - List Application Scorecards
100+
* [list_applications](docs/sdks/ats/README.md#list_applications) - List Applications
101+
* [list_applications_offers](docs/sdks/ats/README.md#list_applications_offers) - List Application Offers
102+
* [list_candidate_notes](docs/sdks/ats/README.md#list_candidate_notes) - List Candidate Notes
103+
* [list_candidates](docs/sdks/ats/README.md#list_candidates) - List Candidates
104+
* [list_departments](docs/sdks/ats/README.md#list_departments) - List Departments
105+
* [list_interview_stages](docs/sdks/ats/README.md#list_interview_stages) - List Interview Stages
106+
* [list_interviews](docs/sdks/ats/README.md#list_interviews) - List Interviews
107+
* [list_job_postings](docs/sdks/ats/README.md#list_job_postings) - List Job Postings
108+
* [list_jobs](docs/sdks/ats/README.md#list_jobs) - List Jobs
109+
* [list_locations](docs/sdks/ats/README.md#list_locations) - List locations
110+
* [list_offers](docs/sdks/ats/README.md#list_offers) - List Offers
111+
* [list_rejected_reasons](docs/sdks/ats/README.md#list_rejected_reasons) - List Rejected Reasons
112+
* [list_users](docs/sdks/ats/README.md#list_users) - List Users
113+
* [update_application](docs/sdks/ats/README.md#update_application) - Update Application
114+
* [update_candidate](docs/sdks/ats/README.md#update_candidate) - Update Candidate (early access)
115+
116+
### [Crm](docs/sdks/crm/README.md)
117+
118+
* [create_contact](docs/sdks/crm/README.md#create_contact) - Creates a new Contact
119+
* [get_account](docs/sdks/crm/README.md#get_account) - Get Account
120+
* [get_contact](docs/sdks/crm/README.md#get_contact) - Get Contact
121+
* [get_list](docs/sdks/crm/README.md#get_list) - Get List
122+
* [list_accounts](docs/sdks/crm/README.md#list_accounts) - List Accounts
123+
* [list_contacts](docs/sdks/crm/README.md#list_contacts) - List Contacts
124+
* [list_lists](docs/sdks/crm/README.md#list_lists) - Get all Lists
125+
* [update_contact](docs/sdks/crm/README.md#update_contact) - Update Contact (early access)
126+
127+
### [Hris](docs/sdks/hris/README.md)
128+
129+
* [create_employee](docs/sdks/hris/README.md#create_employee) - Creates an employee
130+
* [create_employee_time_off_request](docs/sdks/hris/README.md#create_employee_time_off_request) - Create Employee Time Off Request
131+
* [create_time_off_request](docs/sdks/hris/README.md#create_time_off_request) - Creates a time off request
132+
* [get_company](docs/sdks/hris/README.md#get_company) - Get Company
133+
* [get_employee](docs/sdks/hris/README.md#get_employee) - Get Employee
134+
* [get_employees_time_off_request](docs/sdks/hris/README.md#get_employees_time_off_request) - Get Employees Time Off Request
135+
* [get_employment](docs/sdks/hris/README.md#get_employment) - Get Employment
136+
* [get_location](docs/sdks/hris/README.md#get_location) - Get Location
137+
* [get_time_off_request](docs/sdks/hris/README.md#get_time_off_request) - Get time off request
138+
* [list_companies](docs/sdks/hris/README.md#list_companies) - List Companies
139+
* [list_employee_time_off_requests](docs/sdks/hris/README.md#list_employee_time_off_requests) - List Employee Time Off Requests
140+
* [list_employees](docs/sdks/hris/README.md#list_employees) - List Employees
141+
* [list_employments](docs/sdks/hris/README.md#list_employments) - List Employments
142+
* [list_locations](docs/sdks/hris/README.md#list_locations) - List locations
143+
* [list_time_off_requests](docs/sdks/hris/README.md#list_time_off_requests) - List time off requests
144+
* [update_employee](docs/sdks/hris/README.md#update_employee) - Updates an employee
145+
* [update_time_off_request](docs/sdks/hris/README.md#update_time_off_request) - Update time off request
146+
147+
### [Marketing](docs/sdks/marketing/README.md)
148+
149+
* [create_email_template](docs/sdks/marketing/README.md#create_email_template) - Create email template
150+
* [create_omni_channel_template](docs/sdks/marketing/README.md#create_omni_channel_template) - Create omni-channel template
151+
* [create_push_template](docs/sdks/marketing/README.md#create_push_template) - Create push template
152+
* [get_campaign](docs/sdks/marketing/README.md#get_campaign) - Get campaign
153+
* [get_email_template](docs/sdks/marketing/README.md#get_email_template) - Get email template
154+
* [get_omni_channel_template](docs/sdks/marketing/README.md#get_omni_channel_template) - Get omni-channel template
155+
* [get_push_template](docs/sdks/marketing/README.md#get_push_template) - Get push template
156+
* [list_campaigns](docs/sdks/marketing/README.md#list_campaigns) - List campaigns
157+
* [list_email_templates](docs/sdks/marketing/README.md#list_email_templates) - List email templates
158+
* [list_omni_channel_templates](docs/sdks/marketing/README.md#list_omni_channel_templates) - List omni-channel templates
159+
* [list_push_templates](docs/sdks/marketing/README.md#list_push_templates) - List push templates
160+
* [update_email_template](docs/sdks/marketing/README.md#update_email_template) - Update email template
161+
* [update_omni_channel_template](docs/sdks/marketing/README.md#update_omni_channel_template) - Update omni-channel template
162+
* [update_push_template](docs/sdks/marketing/README.md#update_push_template) - Update push template
163+
164+
### [Proxy](docs/sdks/proxy/README.md)
165+
166+
* [proxy_request](docs/sdks/proxy/README.md#proxy_request) - Proxy Request
167+
<!-- End Available Resources and Operations [operations] -->
168+
169+
<!-- Start Server Selection [server] -->
170+
## Server Selection
171+
172+
## Server Selection
173+
174+
### Select Server by Index
175+
176+
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
177+
178+
| # | Server | Variables |
179+
| - | ------ | --------- |
180+
| 0 | `https://api.stackone.com` | None |
181+
182+
183+
184+
185+
### Override Server URL Per-Client
186+
187+
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
188+
<!-- End Server Selection [server] -->
189+
190+
<!-- Placeholder for Future Speakeasy SDK Sections -->
191+
192+
# Development
193+
194+
## Maturity
195+
196+
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
197+
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
198+
looking for the latest version.
199+
200+
## Contributions
201+
202+
While we value open-source contributions to this SDK, this library is generated programmatically.
203+
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
204+
205+
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

RELEASES.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
3+
## 2024-01-11 10:12:30
4+
### Changes
5+
Based on:
6+
- OpenAPI Doc 1.0.0
7+
- Speakeasy CLI 1.135.0 (2.231.0) https://github.com/speakeasy-api/speakeasy
8+
### Generated
9+
- [ruby v0.0.1] .
10+
### Releases
11+
- [Ruby Gems v0.0.1] https://rubygems.org/gems/stackone_client/versions/0.0.1 - .

Rakefile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# typed: true
2+
# frozen_string_literal: true
3+
4+
require 'bundler/gem_tasks'
5+
require 'minitest/test_task'
6+
require 'rubocop/rake_task'
7+
8+
RuboCop::RakeTask.new
9+
10+
Minitest::TestTask.create
11+
12+
# So far default is working - leaving this here for reference.
13+
14+
# Minitest::TestTask.create(:test) do |t|
15+
# t.libs << 'test'
16+
# t.libs << 'lib'
17+
# t.warning = false
18+
# t.test_globs = ['test/**/*_test.rb']
19+
# end
20+
21+
task :default => :test

USAGE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- Start SDK Example Usage [usage] -->
2+
### List Employees
3+
4+
```ruby
5+
require_relative stackone_client
6+
7+
8+
s = StackOne::StackOne.new
9+
s.config_security(
10+
security=Shared::Security.new(
11+
password="<YOUR_PASSWORD_HERE>",
12+
)
13+
)
14+
15+
16+
req = Operations::HrisListEmployeesRequest.new(
17+
proxy=Operations::HrisListEmployeesQueryParamProxy.new(),
18+
x_account_id="string",
19+
)
20+
21+
res = s.hris.list_employees(req)
22+
23+
if ! res.employees_paginated.nil?
24+
# handle response
25+
end
26+
27+
```
28+
<!-- End SDK Example Usage [usage] -->
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# AtsCreateApplicationRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
8+
| `ats_create_application_request_dto` | [Shared::AtsCreateApplicationRequestDto](../../models/shared/atscreateapplicationrequestdto.md) | :heavy_check_mark: | N/A |
9+
| `x_account_id` | *String* | :heavy_check_mark: | The account identifier |

0 commit comments

Comments
 (0)