diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 1d211ac6..5c08fc01 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,19 +1,19 @@ lockVersion: 2.0.0 id: 482384cc-3b98-4ced-bd0b-14aa8b3e0053 management: - docChecksum: 7008ab8ac4c9d19a3813db55cfb133a4 + docChecksum: f723abfef6ced9ebac6cfe25af55fcfe docVersion: 1.0.0 - speakeasyVersion: 1.335.0 - generationVersion: 2.370.2 - releaseVersion: 0.2.32 - configChecksum: 1ba23aeb5a18c32bcb546833ef116b35 + speakeasyVersion: 1.344.1 + generationVersion: 2.376.2 + releaseVersion: 0.2.33 + configChecksum: 3fa7301aca41bfb7d61e594d336ff33e repoURL: https://github.com/StackOneHQ/stackone-client-ruby.git repoSubDirectory: . installationURL: https://github.com/StackOneHQ/stackone-client-ruby published: true features: ruby: - core: 3.2.15 + core: 3.2.16 deprecations: 2.81.1 examples: 2.81.3 flattening: 2.81.1 @@ -230,6 +230,8 @@ generatedFiles: - lib/stack_one/models/operations/hris_get_benefit_response.rb - lib/stack_one/models/operations/hris_get_company_request.rb - lib/stack_one/models/operations/hris_get_company_response.rb + - lib/stack_one/models/operations/hris_get_department_group_request.rb + - lib/stack_one/models/operations/hris_get_department_group_response.rb - lib/stack_one/models/operations/hris_get_employee_request.rb - lib/stack_one/models/operations/hris_get_employee_response.rb - lib/stack_one/models/operations/hris_get_employee_document_request.rb @@ -256,6 +258,9 @@ generatedFiles: - lib/stack_one/models/operations/hris_list_companies_queryparam_filter.rb - lib/stack_one/models/operations/hris_list_companies_request.rb - lib/stack_one/models/operations/hris_list_companies_response.rb + - lib/stack_one/models/operations/hris_list_department_groups_queryparam_filter.rb + - lib/stack_one/models/operations/hris_list_department_groups_request.rb + - lib/stack_one/models/operations/hris_list_department_groups_response.rb - lib/stack_one/models/operations/hris_list_employee_categories_queryparam_filter.rb - lib/stack_one/models/operations/hris_list_employee_categories_request.rb - lib/stack_one/models/operations/hris_list_employee_categories_response.rb @@ -294,6 +299,8 @@ generatedFiles: - lib/stack_one/models/operations/hris_update_time_off_request_response.rb - lib/stack_one/models/operations/hris_upload_employee_document_request.rb - lib/stack_one/models/operations/hris_upload_employee_document_response.rb + - lib/stack_one/models/operations/marketing_create_content_block_request.rb + - lib/stack_one/models/operations/marketing_create_content_block_response.rb - lib/stack_one/models/operations/marketing_create_email_template_request.rb - lib/stack_one/models/operations/marketing_create_email_template_response.rb - lib/stack_one/models/operations/marketing_create_omni_channel_template_request.rb @@ -302,6 +309,8 @@ generatedFiles: - lib/stack_one/models/operations/marketing_create_push_template_response.rb - lib/stack_one/models/operations/marketing_get_campaign_request.rb - lib/stack_one/models/operations/marketing_get_campaign_response.rb + - lib/stack_one/models/operations/marketing_get_content_block_request.rb + - lib/stack_one/models/operations/marketing_get_content_block_response.rb - lib/stack_one/models/operations/marketing_get_email_template_request.rb - lib/stack_one/models/operations/marketing_get_email_template_response.rb - lib/stack_one/models/operations/marketing_get_omni_channel_template_request.rb @@ -311,6 +320,9 @@ generatedFiles: - lib/stack_one/models/operations/marketing_list_campaigns_queryparam_filter.rb - lib/stack_one/models/operations/marketing_list_campaigns_request.rb - lib/stack_one/models/operations/marketing_list_campaigns_response.rb + - lib/stack_one/models/operations/marketing_list_content_blocks_queryparam_filter.rb + - lib/stack_one/models/operations/marketing_list_content_blocks_request.rb + - lib/stack_one/models/operations/marketing_list_content_blocks_response.rb - lib/stack_one/models/operations/marketing_list_email_templates_queryparam_filter.rb - lib/stack_one/models/operations/marketing_list_email_templates_request.rb - lib/stack_one/models/operations/marketing_list_email_templates_response.rb @@ -320,6 +332,8 @@ generatedFiles: - lib/stack_one/models/operations/marketing_list_push_templates_queryparam_filter.rb - lib/stack_one/models/operations/marketing_list_push_templates_request.rb - lib/stack_one/models/operations/marketing_list_push_templates_response.rb + - lib/stack_one/models/operations/marketing_update_content_block_request.rb + - lib/stack_one/models/operations/marketing_update_content_block_response.rb - lib/stack_one/models/operations/marketing_update_email_template_request.rb - lib/stack_one/models/operations/marketing_update_email_template_response.rb - lib/stack_one/models/operations/marketing_update_omni_channel_template_request.rb @@ -412,6 +426,9 @@ generatedFiles: - lib/stack_one/models/shared/assessmentspackages.rb - lib/stack_one/models/shared/candidateresult.rb - lib/stack_one/models/shared/candidate.rb + - lib/stack_one/models/shared/candidatecustomfields_value.rb + - lib/stack_one/models/shared/candidatecustomfields_type.rb + - lib/stack_one/models/shared/candidatecustomfields.rb - lib/stack_one/models/shared/noteresult.rb - lib/stack_one/models/shared/note_value.rb - lib/stack_one/models/shared/note_visibility.rb @@ -575,6 +592,10 @@ generatedFiles: - lib/stack_one/models/shared/hrisbenefitresult.rb - lib/stack_one/models/shared/companyresult.rb - lib/stack_one/models/shared/company.rb + - lib/stack_one/models/shared/hrisdepartmentsresult.rb + - lib/stack_one/models/shared/hrisdepartment_value.rb + - lib/stack_one/models/shared/hrisdepartment_type.rb + - lib/stack_one/models/shared/hrisdepartment.rb - lib/stack_one/models/shared/employeeresult.rb - lib/stack_one/models/shared/avatar.rb - lib/stack_one/models/shared/employee_company.rb @@ -588,9 +609,6 @@ generatedFiles: - lib/stack_one/models/shared/ethnicity.rb - lib/stack_one/models/shared/employee_schemas_gender_value.rb - lib/stack_one/models/shared/gender.rb - - lib/stack_one/models/shared/employee_schemas_groups_value.rb - - lib/stack_one/models/shared/employee_type.rb - - lib/stack_one/models/shared/groups.rb - lib/stack_one/models/shared/employee_schemas_home_location_value.rb - lib/stack_one/models/shared/employee_country.rb - lib/stack_one/models/shared/employee_schemas_home_location_location_type_value.rb @@ -600,7 +618,7 @@ generatedFiles: - lib/stack_one/models/shared/employee_schemas_marital_status_value.rb - lib/stack_one/models/shared/marital_status.rb - lib/stack_one/models/shared/employee_schemas_national_identity_number_value.rb - - lib/stack_one/models/shared/employee_schemas_type.rb + - lib/stack_one/models/shared/employee_type.rb - lib/stack_one/models/shared/national_identity_number.rb - lib/stack_one/models/shared/employee_schemas_preferred_language_value.rb - lib/stack_one/models/shared/preferred_language.rb @@ -610,6 +628,9 @@ generatedFiles: - lib/stack_one/models/shared/employee_schemas_location_type.rb - lib/stack_one/models/shared/work_location.rb - lib/stack_one/models/shared/employee.rb + - lib/stack_one/models/shared/hrisgroup_value.rb + - lib/stack_one/models/shared/hrisgroup_type.rb + - lib/stack_one/models/shared/hrisgroup.rb - lib/stack_one/models/shared/costcenters.rb - lib/stack_one/models/shared/hrisdocumentresult.rb - lib/stack_one/models/shared/hrisdocumentapimodel_value.rb @@ -639,9 +660,6 @@ generatedFiles: - lib/stack_one/models/shared/workeligibility.rb - lib/stack_one/models/shared/employmentresult.rb - lib/stack_one/models/shared/hrisgroupsresult.rb - - lib/stack_one/models/shared/hrisgroup_value.rb - - lib/stack_one/models/shared/hrisgroup_type.rb - - lib/stack_one/models/shared/hrisgroup.rb - lib/stack_one/models/shared/hrislocationresult.rb - lib/stack_one/models/shared/hrislocation_value.rb - lib/stack_one/models/shared/hrislocation_country.rb @@ -650,6 +668,7 @@ generatedFiles: - lib/stack_one/models/shared/hrislocation.rb - lib/stack_one/models/shared/hrisbenefitspaginated.rb - lib/stack_one/models/shared/companiespaginated.rb + - lib/stack_one/models/shared/hrisdepartmentspaginated.rb - lib/stack_one/models/shared/referencepaginated.rb - lib/stack_one/models/shared/hrisdocumentspaginated.rb - lib/stack_one/models/shared/timeoffpaginated.rb @@ -665,6 +684,7 @@ generatedFiles: - lib/stack_one/models/shared/hrisdocumentsuploadrequestdto_schemas_file_format_value.rb - lib/stack_one/models/shared/hrisdocumentsuploadrequestdto_file_format.rb - lib/stack_one/models/shared/hrisdocumentsuploadrequestdto.rb + - lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto.rb - lib/stack_one/models/shared/marketingcreateemailtemplaterequestdto.rb - lib/stack_one/models/shared/message_content.rb - lib/stack_one/models/shared/emailmessages_value.rb @@ -687,6 +707,12 @@ generatedFiles: - lib/stack_one/models/shared/campaign.rb - lib/stack_one/models/shared/value.rb - lib/stack_one/models/shared/channelsenum.rb + - lib/stack_one/models/shared/contentblockspaginated.rb + - lib/stack_one/models/shared/contentblock_value.rb + - lib/stack_one/models/shared/contentblock_status.rb + - lib/stack_one/models/shared/contentblock_schemas_value.rb + - lib/stack_one/models/shared/contentblock_type.rb + - lib/stack_one/models/shared/contentblock.rb - lib/stack_one/models/shared/templateresult.rb - lib/stack_one/models/shared/template.rb - lib/stack_one/models/shared/campaignspaginated.rb @@ -847,6 +873,8 @@ generatedFiles: - docs/models/operations/hrisgetbenefitresponse.md - docs/models/operations/hrisgetcompanyrequest.md - docs/models/operations/hrisgetcompanyresponse.md + - docs/models/operations/hrisgetdepartmentgrouprequest.md + - docs/models/operations/hrisgetdepartmentgroupresponse.md - docs/models/operations/hrisgetemployeerequest.md - docs/models/operations/hrisgetemployeeresponse.md - docs/models/operations/hrisgetemployeedocumentrequest.md @@ -873,6 +901,9 @@ generatedFiles: - docs/models/operations/hrislistcompaniesqueryparamfilter.md - docs/models/operations/hrislistcompaniesrequest.md - docs/models/operations/hrislistcompaniesresponse.md + - docs/models/operations/hrislistdepartmentgroupsqueryparamfilter.md + - docs/models/operations/hrislistdepartmentgroupsrequest.md + - docs/models/operations/hrislistdepartmentgroupsresponse.md - docs/models/operations/hrislistemployeecategoriesqueryparamfilter.md - docs/models/operations/hrislistemployeecategoriesrequest.md - docs/models/operations/hrislistemployeecategoriesresponse.md @@ -911,6 +942,8 @@ generatedFiles: - docs/models/operations/hrisupdatetimeoffrequestresponse.md - docs/models/operations/hrisuploademployeedocumentrequest.md - docs/models/operations/hrisuploademployeedocumentresponse.md + - docs/models/operations/marketingcreatecontentblockrequest.md + - docs/models/operations/marketingcreatecontentblockresponse.md - docs/models/operations/marketingcreateemailtemplaterequest.md - docs/models/operations/marketingcreateemailtemplateresponse.md - docs/models/operations/marketingcreateomnichanneltemplaterequest.md @@ -919,6 +952,8 @@ generatedFiles: - docs/models/operations/marketingcreatepushtemplateresponse.md - docs/models/operations/marketinggetcampaignrequest.md - docs/models/operations/marketinggetcampaignresponse.md + - docs/models/operations/marketinggetcontentblockrequest.md + - docs/models/operations/marketinggetcontentblockresponse.md - docs/models/operations/marketinggetemailtemplaterequest.md - docs/models/operations/marketinggetemailtemplateresponse.md - docs/models/operations/marketinggetomnichanneltemplaterequest.md @@ -928,6 +963,9 @@ generatedFiles: - docs/models/operations/marketinglistcampaignsqueryparamfilter.md - docs/models/operations/marketinglistcampaignsrequest.md - docs/models/operations/marketinglistcampaignsresponse.md + - docs/models/operations/marketinglistcontentblocksqueryparamfilter.md + - docs/models/operations/marketinglistcontentblocksrequest.md + - docs/models/operations/marketinglistcontentblocksresponse.md - docs/models/operations/marketinglistemailtemplatesqueryparamfilter.md - docs/models/operations/marketinglistemailtemplatesrequest.md - docs/models/operations/marketinglistemailtemplatesresponse.md @@ -937,6 +975,8 @@ generatedFiles: - docs/models/operations/marketinglistpushtemplatesqueryparamfilter.md - docs/models/operations/marketinglistpushtemplatesrequest.md - docs/models/operations/marketinglistpushtemplatesresponse.md + - docs/models/operations/marketingupdatecontentblockrequest.md + - docs/models/operations/marketingupdatecontentblockresponse.md - docs/models/operations/marketingupdateemailtemplaterequest.md - docs/models/operations/marketingupdateemailtemplateresponse.md - docs/models/operations/marketingupdateomnichanneltemplaterequest.md @@ -1029,6 +1069,9 @@ generatedFiles: - docs/models/shared/assessmentspackages.md - docs/models/shared/candidateresult.md - docs/models/shared/candidate.md + - docs/models/shared/candidatecustomfieldsvalue.md + - docs/models/shared/candidatecustomfieldstype.md + - docs/models/shared/candidatecustomfields.md - docs/models/shared/noteresult.md - docs/models/shared/notevalue.md - docs/models/shared/notevisibility.md @@ -1192,6 +1235,10 @@ generatedFiles: - docs/models/shared/hrisbenefitresult.md - docs/models/shared/companyresult.md - docs/models/shared/company.md + - docs/models/shared/hrisdepartmentsresult.md + - docs/models/shared/hrisdepartmentvalue.md + - docs/models/shared/hrisdepartmenttype.md + - docs/models/shared/hrisdepartment.md - docs/models/shared/employeeresult.md - docs/models/shared/avatar.md - docs/models/shared/employeecompany.md @@ -1205,9 +1252,6 @@ generatedFiles: - docs/models/shared/ethnicity.md - docs/models/shared/employeeschemasgendervalue.md - docs/models/shared/gender.md - - docs/models/shared/employeeschemasgroupsvalue.md - - docs/models/shared/employeetype.md - - docs/models/shared/groups.md - docs/models/shared/employeeschemashomelocationvalue.md - docs/models/shared/employeecountry.md - docs/models/shared/employeeschemashomelocationlocationtypevalue.md @@ -1217,7 +1261,7 @@ generatedFiles: - docs/models/shared/employeeschemasmaritalstatusvalue.md - docs/models/shared/maritalstatus.md - docs/models/shared/employeeschemasnationalidentitynumbervalue.md - - docs/models/shared/employeeschemastype.md + - docs/models/shared/employeetype.md - docs/models/shared/nationalidentitynumber.md - docs/models/shared/employeeschemaspreferredlanguagevalue.md - docs/models/shared/preferredlanguage.md @@ -1227,6 +1271,9 @@ generatedFiles: - docs/models/shared/employeeschemaslocationtype.md - docs/models/shared/worklocation.md - docs/models/shared/employee.md + - docs/models/shared/hrisgroupvalue.md + - docs/models/shared/hrisgrouptype.md + - docs/models/shared/hrisgroup.md - docs/models/shared/costcenters.md - docs/models/shared/hrisdocumentresult.md - docs/models/shared/hrisdocumentapimodelvalue.md @@ -1256,9 +1303,6 @@ generatedFiles: - docs/models/shared/workeligibility.md - docs/models/shared/employmentresult.md - docs/models/shared/hrisgroupsresult.md - - docs/models/shared/hrisgroupvalue.md - - docs/models/shared/hrisgrouptype.md - - docs/models/shared/hrisgroup.md - docs/models/shared/hrislocationresult.md - docs/models/shared/hrislocationvalue.md - docs/models/shared/hrislocationcountry.md @@ -1267,6 +1311,7 @@ generatedFiles: - docs/models/shared/hrislocation.md - docs/models/shared/hrisbenefitspaginated.md - docs/models/shared/companiespaginated.md + - docs/models/shared/hrisdepartmentspaginated.md - docs/models/shared/referencepaginated.md - docs/models/shared/hrisdocumentspaginated.md - docs/models/shared/timeoffpaginated.md @@ -1282,6 +1327,7 @@ generatedFiles: - docs/models/shared/hrisdocumentsuploadrequestdtoschemasfileformatvalue.md - docs/models/shared/hrisdocumentsuploadrequestdtofileformat.md - docs/models/shared/hrisdocumentsuploadrequestdto.md + - docs/models/shared/marketingcreatecontentblocksrequestdto.md - docs/models/shared/marketingcreateemailtemplaterequestdto.md - docs/models/shared/messagecontent.md - docs/models/shared/emailmessagesvalue.md @@ -1304,6 +1350,12 @@ generatedFiles: - docs/models/shared/campaign.md - docs/models/shared/value.md - docs/models/shared/channelsenum.md + - docs/models/shared/contentblockspaginated.md + - docs/models/shared/contentblockvalue.md + - docs/models/shared/contentblockstatus.md + - docs/models/shared/contentblockschemasvalue.md + - docs/models/shared/contentblocktype.md + - docs/models/shared/contentblock.md - docs/models/shared/templateresult.md - docs/models/shared/template.md - docs/models/shared/campaignspaginated.md @@ -1322,3 +1374,4 @@ generatedFiles: - docs/sdks/proxy/README.md - USAGE.md - .gitattributes + - CONTRIBUTING.md diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 80d52248..ede4ae41 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.335.0 +speakeasyVersion: 1.344.1 sources: my-source: sourceNamespace: my-source - sourceRevisionDigest: sha256:e4808268adb9bf952f6d477507acdd55587574700cbe2ef25b28ef8b8e9d6c52 - sourceBlobDigest: sha256:c06394806675c2d1d8ad3cecda0e9f88a2a90fd9f369fed57b44f606e9ba736e + sourceRevisionDigest: sha256:34526f577816df6ae5cf638faeb132c527d3a25584e40150ec79440443180c51 + sourceBlobDigest: sha256:21a1091da917c6569533db044f34d0af2279a0911d83aef484309744ee266d33 tags: - latest - main @@ -11,8 +11,8 @@ targets: StackOneRubyClient: source: my-source sourceNamespace: my-source - sourceRevisionDigest: sha256:e4808268adb9bf952f6d477507acdd55587574700cbe2ef25b28ef8b8e9d6c52 - sourceBlobDigest: sha256:c06394806675c2d1d8ad3cecda0e9f88a2a90fd9f369fed57b44f606e9ba736e + sourceRevisionDigest: sha256:34526f577816df6ae5cf638faeb132c527d3a25584e40150ec79440443180c51 + sourceBlobDigest: sha256:21a1091da917c6569533db044f34d0af2279a0911d83aef484309744ee266d33 outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d585717f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to This Repository + +Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements. + +## How to Report Issues + +If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes: + +- A clear and descriptive title +- Steps to reproduce the issue +- Expected and actual behavior +- Any relevant logs, screenshots, or error messages +- Information about your environment (e.g., operating system, software versions) + - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed + +## Issue Triage and Upstream Fixes + +We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code. + +## Contact + +If you have any questions or need further assistance, please feel free to reach out by opening an issue. + +Thank you for your understanding and cooperation! + +The Maintainers diff --git a/README.md b/README.md index 1b22e353..e5ad0fd8 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,7 @@ end * [download_employee_document](docs/sdks/hris/README.md#download_employee_document) - Download Employee Document * [get_benefit](docs/sdks/hris/README.md#get_benefit) - Get Benefit * [get_company](docs/sdks/hris/README.md#get_company) - Get Company +* [get_department_group](docs/sdks/hris/README.md#get_department_group) - Get Department Group * [get_employee](docs/sdks/hris/README.md#get_employee) - Get Employee * [get_employee_document](docs/sdks/hris/README.md#get_employee_document) - Get Employee Document * [get_employee_document_category](docs/sdks/hris/README.md#get_employee_document_category) - Get Employee Document Category @@ -149,6 +150,7 @@ end * [get_time_off_request](docs/sdks/hris/README.md#get_time_off_request) - Get time off request * [list_benefits](docs/sdks/hris/README.md#list_benefits) - List benefits * [list_companies](docs/sdks/hris/README.md#list_companies) - List Companies +* [list_department_groups](docs/sdks/hris/README.md#list_department_groups) - List Department Groups * [list_employee_categories](docs/sdks/hris/README.md#list_employee_categories) - List Employee Document Categories * [list_employee_documents](docs/sdks/hris/README.md#list_employee_documents) - List Employee Documents * [list_employee_time_off_requests](docs/sdks/hris/README.md#list_employee_time_off_requests) - List Employee Time Off Requests @@ -166,17 +168,21 @@ end ### [Marketing](docs/sdks/marketing/README.md) +* [create_content_block](docs/sdks/marketing/README.md#create_content_block) - Create Content Block * [create_email_template](docs/sdks/marketing/README.md#create_email_template) - Create email template * [create_omni_channel_template](docs/sdks/marketing/README.md#create_omni_channel_template) - Create omni-channel template * [create_push_template](docs/sdks/marketing/README.md#create_push_template) - Create push template * [get_campaign](docs/sdks/marketing/README.md#get_campaign) - Get campaign +* [get_content_block](docs/sdks/marketing/README.md#get_content_block) - Get Content Blocks * [get_email_template](docs/sdks/marketing/README.md#get_email_template) - Get email template * [get_omni_channel_template](docs/sdks/marketing/README.md#get_omni_channel_template) - Get omni-channel template * [get_push_template](docs/sdks/marketing/README.md#get_push_template) - Get push template * [list_campaigns](docs/sdks/marketing/README.md#list_campaigns) - List campaigns +* [list_content_blocks](docs/sdks/marketing/README.md#list_content_blocks) - List Content Blocks * [list_email_templates](docs/sdks/marketing/README.md#list_email_templates) - List email templates * [list_omni_channel_templates](docs/sdks/marketing/README.md#list_omni_channel_templates) - List omni-channel templates * [list_push_templates](docs/sdks/marketing/README.md#list_push_templates) - List push templates +* [update_content_block](docs/sdks/marketing/README.md#update_content_block) - Update email template * [update_email_template](docs/sdks/marketing/README.md#update_email_template) - Update email template * [update_omni_channel_template](docs/sdks/marketing/README.md#update_omni_channel_template) - Update omni-channel template * [update_push_template](docs/sdks/marketing/README.md#update_push_template) - Update push template diff --git a/RELEASES.md b/RELEASES.md index 9e8712b6..23fd3841 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -398,4 +398,14 @@ Based on: ### Generated - [ruby v0.2.32] . ### Releases -- [Ruby Gems v0.2.32] https://rubygems.org/gems/stackone_client/versions/0.2.32 - . \ No newline at end of file +- [Ruby Gems v0.2.32] https://rubygems.org/gems/stackone_client/versions/0.2.32 - . + +## 2024-07-22 09:01:15 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.344.1 (2.376.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v0.2.33] . +### Releases +- [Ruby Gems v0.2.33] https://rubygems.org/gems/stackone_client/versions/0.2.33 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index ba0810e1..98b63257 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -2,646 +2,4 @@ overlay: 1.0.0 info: title: CodeSamples overlay for ruby target version: 0.0.0 -actions: - - target: $["paths"]["/unified/ats/interview_stages/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_interview_stage - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetInterviewStageRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,order,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_interview_stage(req)\n\nif ! res.interview_stage_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/push"]["post"] - update: - x-codeSamples: - - lang: ruby - label: marketing_create_push_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.marketing.create_push_template(x_account_id=\"\", marketing_create_push_template_request_dto=::StackOne::Shared::MarketingCreatePushTemplateRequestDto.new(\n messages: [\n ::StackOne::Shared::PushMessages.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n message_type: ::StackOne::Shared::PushMessagesMessageType.new(\n source_value: \"Email\",\n ),\n ),\n ],\n passthrough: {\n \"turban\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: hris_update_employee - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.update_employee(id=\"\", x_account_id=\"\", hris_create_employee_request_dto=::StackOne::Shared::HrisCreateEmployeeRequestDto.new(\n first_name: \"Issac\",\n last_name: \"Newton\",\n name: \"Issac Newton\",\n display_name: \"Sir Issac Newton\",\n avatar_url: \"https://example.com/avatar.png\",\n personal_email: \"isaac.newton@example.com\",\n personal_phone_number: \"+1234567890\",\n work_email: \"newton@example.com\",\n work_phone_number: \"+1234567890\",\n job_title: \"Physicist\",\n department: \"Physics\",\n manager_id: \"67890\",\n gender: ::StackOne::Shared::HrisCreateEmployeeRequestDtoGender.new(),\n preferred_language: ::StackOne::Shared::HrisCreateEmployeeRequestDtoPreferredLanguage.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasValue::ENG,\n ),\n ethnicity: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEthnicity.new(),\n date_of_birth: DateTime.iso8601('1990-01-01T00:00.000Z'),\n birthday: DateTime.iso8601('2021-01-01T00:00:00Z'),\n marital_status: ::StackOne::Shared::HrisCreateEmployeeRequestDtoMaritalStatus.new(),\n avatar: ::StackOne::Shared::HrisCreateEmployeeRequestDtoAvatar.new(),\n hire_date: DateTime.iso8601('2021-01-01T00:00.000Z'),\n start_date: DateTime.iso8601('2021-01-01T00:00.000Z'),\n tenure: 2.0,\n work_anniversary: DateTime.iso8601('2021-01-01T00:00:00Z'),\n employment_type: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEmploymentType.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasEmploymentTypeValue::PERMANENT,\n source_value: \"Permanent\",\n ),\n employment_contract_type: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEmploymentContractType.new(),\n employment_status: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEmploymentStatus.new(),\n termination_date: DateTime.iso8601('2021-01-01T00:00:00Z'),\n company_name: \"Example Corp\",\n citizenships: [\n ::StackOne::Shared::CountryCodeEnum.new(\n value: ::StackOne::Shared::Value::US,\n ),\n ],\n employments: [\n ::StackOne::Shared::Employment.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n employee_id: \"1687-3\",\n remote_employee_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n job_title: \"Software Engineer\",\n pay_rate: \"40.00\",\n pay_period: ::StackOne::Shared::PayPeriod.new(\n value: ::StackOne::Shared::EmploymentValue::HOUR,\n source_value: \"Hour\",\n ),\n pay_frequency: ::StackOne::Shared::PayFrequency.new(\n value: ::StackOne::Shared::EmploymentSchemasValue::HOURLY,\n source_value: \"Hourly\",\n ),\n pay_currency: \"USD\",\n effective_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n employment_type: ::StackOne::Shared::EmploymentEmploymentType.new(\n value: ::StackOne::Shared::EmploymentSchemasEmploymentTypeValue::PERMANENT,\n source_value: \"Permanent\",\n ),\n employment_contract_type: ::StackOne::Shared::EmploymentEmploymentContractType.new(),\n created_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n updated_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n ),\n ],\n custom_fields: [\n ::StackOne::Shared::EmployeeCustomFields.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n description: \"The completion status of the employee's training.\",\n type: ::StackOne::Shared::Type.new(),\n value: \"Completed\",\n value_id: \"value_456\",\n remote_value_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n options: [\n \"\",\n ],\n ),\n ],\n benefits: [\n ::StackOne::Shared::HRISBenefit.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n description: \"Health insurance for employees\",\n created_at: DateTime.iso8601('2021-01-01T00:00:00Z'),\n updated_at: DateTime.iso8601('2021-01-01T00:00:00Z'),\n ),\n ],\n passthrough: {\n \"solid\": \"\",\n },\n job_id: \"R-6789\",\n home_location: ::StackOne::Shared::HrisCreateEmployeeRequestDtoHomeLocation.new(\n name: \"Woolsthorpe Manor\",\n phone_number: \"+44 1476 860 364\",\n street_1: \"Water Lane\",\n street_2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zip_code: \"NG33 5NR\",\n country: ::StackOne::Shared::HrisCreateEmployeeRequestDtoCountry.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasHomeLocationValue::US,\n ),\n passthrough: {\n \"Northeast\": \"\",\n },\n state: ::StackOne::Shared::State.new(),\n ),\n work_location: ::StackOne::Shared::HrisCreateEmployeeRequestDtoWorkLocation.new(\n name: \"Woolsthorpe Manor\",\n phone_number: \"+44 1476 860 364\",\n street_1: \"Water Lane\",\n street_2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zip_code: \"NG33 5NR\",\n country: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasCountry.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasWorkLocationValue::US,\n ),\n passthrough: {\n \"International\": \"\",\n },\n state: ::StackOne::Shared::HrisCreateEmployeeRequestDtoState.new(),\n ),\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/time_off/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: hris_update_time_off_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.update_time_off_request(id=\"\", x_account_id=\"\", hris_create_time_off_request_dto=::StackOne::Shared::HrisCreateTimeOffRequestDto.new(\n employee_id: \"1687-3\",\n approver_id: \"1687-4\",\n start_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n end_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n start_half_day: true,\n end_half_day: true,\n passthrough: {\n \"Sports\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_application - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetApplicationRequest.new(\n id: \"\",\n fields_: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,interview_stage,interview_stage_id,remote_interview_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,candidate\",\n expand: \"documents\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_application(req)\n\nif ! res.application_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/documents/upload"]["post"] - update: - x-codeSamples: - - lang: ruby - label: ats_upload_application_document - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.upload_application_document(id=\"\", x_account_id=\"\", unified_upload_request_dto=::StackOne::Shared::UnifiedUploadRequestDto.new(\n name: \"weather-forecast\",\n file_format: ::StackOne::Shared::UnifiedUploadRequestDtoFileFormat.new(\n value: ::StackOne::Shared::UnifiedUploadRequestDtoValue::PDF,\n source_value: \"abc\",\n ),\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n path: \"/path/to/file\",\n category: ::StackOne::Shared::UnifiedUploadRequestDtoCategory.new(\n value: \"reports, resumes\",\n source_value: \"550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME\",\n ),\n confidential: ::StackOne::Shared::UnifiedUploadRequestDtoConfidential.new(\n value: ::StackOne::Shared::UnifiedUploadRequestDtoSchemasValue::TRUE,\n source_value: \"public\",\n ),\n ))\n\nif ! res.write_result_api_model.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_employees - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListEmployeesRequest.new(\n 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_title,job_description,department,cost_centers,benefits,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\",\n filter: ::StackOne::Operations::QueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n expand: \"company,employments,work_location,home_location,custom_fields,groups\",\n include: \"avatar_url,avatar,custom_fields,job_description,benefits\",\n x_account_id: \"\",\n)\n \nres = s.hris.list_employees(req)\n\nif ! res.employees_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/time_off"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_employee_time_off_requests - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListEmployeeTimeOffRequestsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at\",\n filter: ::StackOne::Operations::HrisListEmployeeTimeOffRequestsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_employee_time_off_requests(req)\n\nif ! res.time_off_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/companies"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_companies - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListCompaniesRequest.new(\n fields_: \"id,remote_id,name,full_name,display_name,created_at,updated_at\",\n filter: ::StackOne::Operations::Filter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_companies(req)\n\nif ! res.companies_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/benefits/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_benefit - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetBenefitRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,benefit_type,provider,description,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_benefit(req)\n\nif ! res.hris_benefit_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/offers"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_applications_offers - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListApplicationsOffersRequest.new(\n id: \"\",\n fields_: \"id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history\",\n filter: ::StackOne::Operations::AtsListApplicationsOffersQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_applications_offers(req)\n\nif ! res.offers_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates"]["post"] - update: - x-codeSamples: - - lang: ruby - label: ats_create_candidate - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.create_candidate(x_account_id=\"\", ats_create_candidate_request_dto=::StackOne::Shared::AtsCreateCandidateRequestDto.new(\n name: \"Romain Sestier\",\n first_name: \"Romain\",\n last_name: \"Sestier\",\n email: \"sestier.romain123@gmail.com\",\n social_links: [\n ::StackOne::Shared::SocialLink.new(\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n ),\n ],\n company: \"Company Inc.\",\n title: \"Software Engineer\",\n hired_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n country: \"United States\",\n passthrough: {\n \"discrete\": \"\",\n },\n phone_number: \"+1234567890\",\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/assessments/packages/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_assessments_package - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetAssessmentsPackageRequest.new(\n id: \"\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_assessments_package(req)\n\nif ! res.assessments_packages_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/lists/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: crm_get_list - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::CrmGetListRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,created_at,updated_at,items,type\",\n x_account_id: \"\",\n)\n \nres = s.crm.get_list(req)\n\nif ! res.list_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/proxy"]["post"] - update: - x-codeSamples: - - lang: ruby - label: stackone_proxy_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.proxy.proxy_request(x_account_id=\"\", proxy_request_body=::StackOne::Shared::ProxyRequestBody.new(\n url: \"https://api.sample-integration.com/v1\",\n path: \"/employees/directory\",\n headers: {\n \"Car\": \"\",\n },\n ))\n\nif res.status_code == 200\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/documents/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_employee_document - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetEmployeeDocumentRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,name,path,type,category,contents,created_at,updated_at,remote_url,file_format\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_employee_document(req)\n\nif ! res.hris_document_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/scorecards"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_application_scorecards - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListApplicationScorecardsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at\",\n filter: ::StackOne::Operations::AtsListApplicationScorecardsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_application_scorecards(req)\n\nif ! res.scorecards_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/departments"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_departments - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListDepartmentsRequest.new(\n fields_: \"id,remote_id,name\",\n filter: ::StackOne::Operations::AtsListDepartmentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_departments(req)\n\nif ! res.departments_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/email"]["post"] - update: - x-codeSamples: - - lang: ruby - label: marketing_create_email_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.marketing.create_email_template(x_account_id=\"\", marketing_create_email_template_request_dto=::StackOne::Shared::MarketingCreateEmailTemplateRequestDto.new(\n messages: [\n ::StackOne::Shared::EmailMessages.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n message_type: ::StackOne::Shared::MessageType.new(\n source_value: \"Email\",\n ),\n ),\n ],\n passthrough: {\n \"Non\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates/{id}/notes/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_candidate_note - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetCandidateNoteRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_candidate_note(req)\n\nif ! res.note_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility/{subResourceId}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: hris_update_employee_work_eligibility_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.update_employee_work_eligibility_request(id=\"\", sub_resource_id=\"\", x_account_id=\"\", hris_create_work_eligibility_request_dto=::StackOne::Shared::HrisCreateWorkEligibilityRequestDto.new(\n type: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoType.new(),\n sub_type: \"H1B\",\n document: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoDocument.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"My Document\",\n path: \"/path/to/file\",\n category: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoCategory.new(),\n created_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n updated_at: DateTime.iso8601('2021-01-02T01:01:01.000Z'),\n remote_url: \"https://example.com/file.pdf\",\n file_format: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoFileFormat.new(\n value: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue::PDF,\n source_value: \"abc\",\n ),\n ),\n valid_from: DateTime.iso8601('2021-01-01T00:00.000Z'),\n valid_to: DateTime.iso8601('2021-01-01T00:00.000Z'),\n issued_by: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoIssuedBy.new(\n value: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoSchemasValue::US,\n ),\n number: \"1234567890\",\n passthrough: {\n \"evolve\": \"\",\n },\n ))\n\nif res.status_code == 200\n # handle response\nend" - - target: $["paths"]["/unified/hris/time_off"]["post"] - update: - x-codeSamples: - - lang: ruby - label: hris_create_time_off_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.create_time_off_request(x_account_id=\"\", hris_create_time_off_request_dto=::StackOne::Shared::HrisCreateTimeOffRequestDto.new(\n employee_id: \"1687-3\",\n approver_id: \"1687-4\",\n start_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n end_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n start_half_day: true,\n end_half_day: true,\n passthrough: {\n \"Bicycle\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/time_off/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_time_off_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetTimeOffRequestRequest.new(\n id: \"\",\n fields_: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_time_off_request(req)\n\nif ! res.time_off_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/rejected_reasons/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_rejected_reason - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetRejectedReasonRequest.new(\n id: \"\",\n fields_: \"id,remote_id,label,type,rejected_reason_type\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_rejected_reason(req)\n\nif ! res.rejected_reason_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/omni_channel/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: marketing_update_omni_channel_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.marketing.update_omni_channel_template(id=\"\", x_account_id=\"\", marketing_create_template_request_dto=::StackOne::Shared::MarketingCreateTemplateRequestDto.new(\n messages: [\n ::StackOne::Shared::Message.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n message_type: ::StackOne::Shared::MessageMessageType.new(\n source_value: \"Email\",\n ),\n ),\n ],\n passthrough: {\n \"Edina\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_employee - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetEmployeeRequest.new(\n id: \"\",\n 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_title,job_description,department,cost_centers,benefits,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\",\n expand: \"company,employments,work_location,home_location,custom_fields,groups\",\n include: \"avatar_url,avatar,custom_fields,job_description,benefits\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_employee(req)\n\nif ! res.employee_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/locations/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_location - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetLocationRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_location(req)\n\nif ! res.ats_location_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/contacts"]["post"] - update: - x-codeSamples: - - lang: ruby - label: crm_create_contact - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.crm.create_contact(x_account_id=\"\", crm_create_contact_request_dto=::StackOne::Shared::CrmCreateContactRequestDto.new(\n first_name: \"Steve\",\n last_name: \"Wozniak\",\n company_name: \"Apple Inc.\",\n emails: [\n \"\",\n ],\n phone_numbers: [\n \"\",\n ],\n deal_ids: [\n \"\",\n ],\n account_ids: [\n \"\",\n ],\n passthrough: {\n \"Electric\": \"\",\n },\n ))\n\nif ! res.contact_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/campaigns"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_list_campaigns - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingListCampaignsRequest.new(\n fields_: \"id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages\",\n filter: ::StackOne::Operations::MarketingListCampaignsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.marketing.list_campaigns(req)\n\nif ! res.campaigns_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/contacts/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: crm_update_contact - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.crm.update_contact(id=\"\", x_account_id=\"\", crm_create_contact_request_dto=::StackOne::Shared::CrmCreateContactRequestDto.new(\n first_name: \"Steve\",\n last_name: \"Wozniak\",\n company_name: \"Apple Inc.\",\n emails: [\n \"\",\n ],\n phone_numbers: [\n \"\",\n ],\n deal_ids: [\n \"\",\n ],\n account_ids: [\n \"\",\n ],\n passthrough: {\n \"West\": \"\",\n },\n ))\n\nif ! res.contact_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/companies/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_company - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetCompanyRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,full_name,display_name,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_company(req)\n\nif ! res.company_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/documents/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_application_document - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetApplicationDocumentRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,name,path,type,category,contents,created_at,updated_at,remote_url,file_format\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_application_document(req)\n\nif ! res.ats_document_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/push"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_list_push_templates - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingListPushTemplatesRequest.new(\n fields_: \"id,remote_id,name,messages,created_at,updated_at,tags\",\n filter: ::StackOne::Operations::MarketingListPushTemplatesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.marketing.list_push_templates(req)\n\nif ! res.templates_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/documents/employee_categories/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_employee_document_category - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetEmployeeDocumentCategoryRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,active\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_employee_document_category(req)\n\nif ! res.reference_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications"]["post"] - update: - x-codeSamples: - - lang: ruby - label: ats_create_application - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.create_application(x_account_id=\"\", ats_create_application_request_dto=::StackOne::Shared::AtsCreateApplicationRequestDto.new(\n job_id: \"4071538b-3cac-4fbf-ac76-f78ed250ffdd\",\n location_id: \"dd8d41d1-5eb8-4408-9c87-9ba44604eae4\",\n application_status: ::StackOne::Shared::AtsCreateApplicationRequestDtoApplicationStatus.new(\n value: ::StackOne::Shared::AtsCreateApplicationRequestDtoValue::HIRED,\n source_value: \"Hired\",\n ),\n questionnaires: [\n ::StackOne::Shared::Questionnaire.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n answers: [\n ::StackOne::Shared::Answer.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n type: ::StackOne::Shared::AnswerType.new(\n value: ::StackOne::Shared::AnswerValue::SHORT_TEXT,\n source_value: \"Short Text\",\n ),\n values: [\n \"\",\n ],\n ),\n ],\n ),\n ],\n source: ::StackOne::Shared::AtsCreateApplicationRequestDtoSource.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"LinkedIn\",\n ),\n candidate_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n candidate: ::StackOne::Shared::AtsCreateApplicationRequestDtoCandidate.new(\n name: \"Romain Sestier\",\n first_name: \"Romain\",\n last_name: \"Sestier\",\n email: \"sestier.romain123@gmail.com\",\n social_links: [\n ::StackOne::Shared::SocialLink.new(\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n ),\n ],\n company: \"Company Inc.\",\n title: \"Software Engineer\",\n hired_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n country: \"United States\",\n passthrough: {\n \"synthesize\": \"\",\n },\n phone_number: \"+1234567890\",\n ),\n passthrough: {\n \"Global\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/offers/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_offer - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetOfferRequest.new(\n id: \"\",\n fields_: \"id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_offer(req)\n\nif ! res.offers_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/assessments/packages"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_assessments_packages - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListAssessmentsPackagesRequest.new(\n filter: ::StackOne::Operations::AtsListAssessmentsPackagesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_assessments_packages(req)\n\nif ! res.assessments_packages_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/interviews"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_interviews - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListInterviewsRequest.new(\n fields_: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at\",\n filter: ::StackOne::Operations::AtsListInterviewsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_interviews(req)\n\nif ! res.interviews_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/accounts/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: crm_get_account - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::CrmGetAccountRequest.new(\n id: \"\",\n fields_: \"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.crm.get_account(req)\n\nif ! res.account_result.nil?\n # handle response\nend" - - target: $["paths"]["/accounts/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: stackone_update_account - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.accounts.update_account(id=\"\", patch_account_dto=::StackOne::Shared::PatchAccountDto.new())\n\nif ! res.linked_account.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/groups/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_group - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetGroupRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_group(req)\n\nif ! res.hris_groups_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/lists/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_list - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetListRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,created_at,updated_at,items,type\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_list(req)\n\nif ! res.list_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/omni_channel"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_list_omni_channel_templates - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingListOmniChannelTemplatesRequest.new(\n fields_: \"id,remote_id,name,messages,created_at,updated_at,tags\",\n filter: ::StackOne::Operations::MarketingListOmniChannelTemplatesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.marketing.list_omni_channel_templates(req)\n\nif ! res.templates_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_candidate - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetCandidateRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_candidate(req)\n\nif ! res.candidate_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/interview_stages"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_interview_stages - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListInterviewStagesRequest.new(\n fields_: \"id,remote_id,name,order,created_at,updated_at\",\n filter: ::StackOne::Operations::AtsListInterviewStagesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_interview_stages(req)\n\nif ! res.interview_stages_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/documents/{subResourceId}/download"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_download_application_document - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.download_application_document(id=\"\", sub_resource_id=\"\", x_account_id=\"\", format=\"base64\")\n\nif ! res.bytes.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/users/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_user - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetUserRequest.new(\n id: \"\",\n fields_: \"id,remote_id,first_name,last_name,name,email\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_user(req)\n\nif ! res.user_result.nil?\n # handle response\nend" - - target: $["paths"]["/connectors/meta/{provider}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: stackone_get_connector_meta - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.connectors.get_connector_meta(provider=\"\", include=\"field_path,unmapped_fields,resources,inactive\")\n\nif ! res.connectors_meta.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/jobs"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_jobs - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListJobsRequest.new(\n fields_: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids\",\n filter: ::StackOne::Operations::HrisListJobsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_jobs(req)\n\nif ! res.jobs_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/jobs/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_job - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetJobRequest.new(\n id: \"\",\n fields_: \"id,remote_id,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,created_at,updated_at\",\n expand: \"job_postings,interview_stages\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_job(req)\n\nif ! res.job_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/documents"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_employee_documents - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListEmployeeDocumentsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,path,type,category,contents,created_at,updated_at,remote_url,file_format\",\n filter: ::StackOne::Operations::HrisListEmployeeDocumentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_employee_documents(req)\n\nif ! res.hris_documents_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/jobs/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_job - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetJobRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_job(req)\n\nif ! res.job_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_applications - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListApplicationsRequest.new(\n fields_: \"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,interview_stage,interview_stage_id,remote_interview_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,candidate\",\n filter: ::StackOne::Operations::AtsListApplicationsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n expand: \"documents\",\n x_account_id: \"\",\n)\n \nres = s.ats.list_applications(req)\n\nif ! res.applications_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/locations"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_locations - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListLocationsRequest.new(\n fields_: \"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at\",\n filter: ::StackOne::Operations::HrisListLocationsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_locations(req)\n\nif ! res.hris_locations_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/job_postings"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_job_postings - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListJobPostingsRequest.new(\n fields_: \"id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,updated_at,created_at\",\n filter: ::StackOne::Operations::AtsListJobPostingsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n include: \"questionnaires\",\n x_account_id: \"\",\n)\n \nres = s.ats.list_job_postings(req)\n\nif ! res.job_postings_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/contacts/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: crm_get_contact - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::CrmGetContactRequest.new(\n id: \"\",\n fields_: \"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at\",\n include: \"custom_fields\",\n x_account_id: \"\",\n)\n \nres = s.crm.get_contact(req)\n\nif ! res.contact_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/omni_channel/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_get_omni_channel_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingGetOmniChannelTemplateRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,messages,created_at,updated_at,tags\",\n x_account_id: \"\",\n)\n \nres = s.marketing.get_omni_channel_template(req)\n\nif ! res.template_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/push/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: marketing_update_push_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.marketing.update_push_template(id=\"\", x_account_id=\"\", marketing_create_push_template_request_dto=::StackOne::Shared::MarketingCreatePushTemplateRequestDto.new(\n messages: [\n ::StackOne::Shared::PushMessages.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n message_type: ::StackOne::Shared::PushMessagesMessageType.new(\n source_value: \"Email\",\n ),\n ),\n ],\n passthrough: {\n \"tightly\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/offers/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_application_offer - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetApplicationOfferRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_application_offer(req)\n\nif ! res.offers_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/locations"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_locations - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListLocationsRequest.new(\n fields_: \"id,remote_id,name\",\n filter: ::StackOne::Operations::AtsListLocationsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_locations(req)\n\nif ! res.ats_locations_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/push/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_get_push_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingGetPushTemplateRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,messages,created_at,updated_at,tags\",\n x_account_id: \"\",\n)\n \nres = s.marketing.get_push_template(req)\n\nif ! res.template_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/time_off"]["post"] - update: - x-codeSamples: - - lang: ruby - label: hris_create_employee_time_off_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.create_employee_time_off_request(id=\"\", x_account_id=\"\", hris_create_time_off_request_dto=::StackOne::Shared::HrisCreateTimeOffRequestDto.new(\n employee_id: \"1687-3\",\n approver_id: \"1687-4\",\n start_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n end_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n start_half_day: true,\n end_half_day: true,\n passthrough: {\n \"Passenger\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/documents/employee_categories"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_employee_categories - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListEmployeeCategoriesRequest.new(\n fields_: \"id,remote_id,name,active\",\n filter: ::StackOne::Operations::HrisListEmployeeCategoriesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_employee_categories(req)\n\nif ! res.reference_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/groups"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_groups - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListGroupsRequest.new(\n fields_: \"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids\",\n filter: ::StackOne::Operations::HrisListGroupsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_groups(req)\n\nif ! res.hris_groups_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/accounts/{id}"]["delete"] - update: - x-codeSamples: - - lang: ruby - label: stackone_delete_account - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.accounts.delete_account(id=\"\")\n\nif ! res.linked_account.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employments/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_employment - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetEmploymentRequest.new(\n id: \"\",\n fields_: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type,employment_contract_type,created_at,updated_at\",\n expand: \"groups\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_employment(req)\n\nif ! res.employment_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/lists"]["get"] - update: - x-codeSamples: - - lang: ruby - label: crm_list_lists - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::CrmListListsRequest.new(\n fields_: \"id,remote_id,name,created_at,updated_at,items,type\",\n filter: ::StackOne::Operations::CrmListListsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.crm.list_lists(req)\n\nif ! res.lists_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/email/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_get_email_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingGetEmailTemplateRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,messages,created_at,updated_at,tags\",\n x_account_id: \"\",\n)\n \nres = s.marketing.get_email_template(req)\n\nif ! res.template_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/campaigns/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_get_campaign - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingGetCampaignRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages\",\n x_account_id: \"\",\n)\n \nres = s.marketing.get_campaign(req)\n\nif ! res.campaign_result.nil?\n # handle response\nend" - - target: $["paths"]["/accounts/{id}/meta"]["get"] - update: - x-codeSamples: - - lang: ruby - label: stackone_get_account_meta_info - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.accounts.get_account_meta_info(id=\"\")\n\nif ! res.linked_account_meta.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_employee_work_eligibility - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListEmployeeWorkEligibilityRequest.new(\n id: \"\",\n fields_: \"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number\",\n filter: ::StackOne::Operations::HrisListEmployeeWorkEligibilityQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_employee_work_eligibility(req)\n\nif ! res.work_eligibility_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/locations/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_location - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetLocationRequest.new(\n id: \"\",\n fields_: \"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_location(req)\n\nif ! res.hris_location_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/interviews/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_interview - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetInterviewRequest.new(\n id: \"\",\n fields_: \"id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_interview(req)\n\nif ! res.interviews_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/documents/upload"]["post"] - update: - x-codeSamples: - - lang: ruby - label: hris_upload_employee_document - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.upload_employee_document(id=\"\", x_account_id=\"\", hris_documents_upload_request_dto=::StackOne::Shared::HrisDocumentsUploadRequestDto.new(\n name: \"weather-forecast\",\n file_format: ::StackOne::Shared::FileFormat.new(\n value: ::StackOne::Shared::HrisDocumentsUploadRequestDtoValue::PDF,\n source_value: \"abc\",\n ),\n content: \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n path: \"/path/to/file\",\n category: ::StackOne::Shared::HrisDocumentsUploadRequestDtoCategory.new(\n value: ::StackOne::Shared::HrisDocumentsUploadRequestDtoSchemasValue::UNMAPPED_VALUE,\n source_value: \"550e8400-e29b-41d4-a716-446655440000\",\n ),\n confidential: ::StackOne::Shared::Confidential.new(\n value: ::StackOne::Shared::HrisDocumentsUploadRequestDtoSchemasConfidentialValue::TRUE,\n source_value: \"public\",\n ),\n ))\n\nif ! res.write_result_api_model.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_employees_work_eligibility - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetEmployeesWorkEligibilityRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_employees_work_eligibility(req)\n\nif ! res.work_eligibility_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/scorecards/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_application_scorecard - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetApplicationScorecardRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_application_scorecard(req)\n\nif ! res.scorecards_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/departments/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_department - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetDepartmentRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_department(req)\n\nif ! res.department_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/rejected_reasons"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_rejected_reasons - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListRejectedReasonsRequest.new(\n fields_: \"id,remote_id,label,type,rejected_reason_type\",\n filter: ::StackOne::Operations::AtsListRejectedReasonsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_rejected_reasons(req)\n\nif ! res.rejected_reasons_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/documents/{subResourceId}/download"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_download_employee_document - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.download_employee_document(id=\"\", sub_resource_id=\"\", x_account_id=\"\", format=\"base64\")\n\nif ! res.bytes.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/work_eligibility"]["post"] - update: - x-codeSamples: - - lang: ruby - label: hris_create_employee_work_eligibility_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.create_employee_work_eligibility_request(id=\"\", x_account_id=\"\", hris_create_work_eligibility_request_dto=::StackOne::Shared::HrisCreateWorkEligibilityRequestDto.new(\n type: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoType.new(),\n sub_type: \"H1B\",\n document: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoDocument.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"My Document\",\n path: \"/path/to/file\",\n category: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoCategory.new(),\n created_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n updated_at: DateTime.iso8601('2021-01-02T01:01:01.000Z'),\n remote_url: \"https://example.com/file.pdf\",\n file_format: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoFileFormat.new(\n value: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoSchemasDocumentValue::PDF,\n source_value: \"abc\",\n ),\n ),\n valid_from: DateTime.iso8601('2021-01-01T00:00.000Z'),\n valid_to: DateTime.iso8601('2021-01-01T00:00.000Z'),\n issued_by: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoIssuedBy.new(\n value: ::StackOne::Shared::HrisCreateWorkEligibilityRequestDtoSchemasValue::US,\n ),\n number: \"1234567890\",\n passthrough: {\n \"green\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_candidates - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListCandidatesRequest.new(\n fields_: \"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,created_at,updated_at\",\n filter: ::StackOne::Operations::AtsListCandidatesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_candidates(req)\n\nif ! res.candidates_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates/{id}/notes"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_candidate_notes - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListCandidateNotesRequest.new(\n id: \"\",\n fields_: \"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at\",\n filter: ::StackOne::Operations::AtsListCandidateNotesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_candidate_notes(req)\n\nif ! res.notes_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/offers"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_offers - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListOffersRequest.new(\n fields_: \"id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history\",\n filter: ::StackOne::Operations::AtsListOffersQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_offers(req)\n\nif ! res.offers_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/contacts"]["get"] - update: - x-codeSamples: - - lang: ruby - label: crm_list_contacts - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::CrmListContactsRequest.new(\n fields_: \"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at\",\n filter: ::StackOne::Operations::CrmListContactsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n include: \"custom_fields\",\n x_account_id: \"\",\n)\n \nres = s.crm.list_contacts(req)\n\nif ! res.contacts_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/crm/accounts"]["get"] - update: - x-codeSamples: - - lang: ruby - label: crm_list_accounts - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::CrmListAccountsRequest.new(\n fields_: \"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at\",\n filter: ::StackOne::Operations::CrmListAccountsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.crm.list_accounts(req)\n\nif ! res.accounts_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/connectors/meta"]["get"] - update: - x-codeSamples: - - lang: ruby - label: stackone_list_connectors_meta - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.connectors.list_connectors_meta(include=\"field_path,unmapped_fields,resources,inactive\")\n\nif ! res.connectors_metas.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/time_off"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_time_off_requests - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListTimeOffRequestsRequest.new(\n fields_: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at\",\n filter: ::StackOne::Operations::HrisListTimeOffRequestsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_time_off_requests(req)\n\nif ! res.time_off_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/job_postings/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_get_job_posting - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsGetJobPostingRequest.new(\n id: \"\",\n fields_: \"id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,updated_at,created_at\",\n include: \"questionnaires\",\n x_account_id: \"\",\n)\n \nres = s.ats.get_job_posting(req)\n\nif ! res.job_posting_result.nil?\n # handle response\nend" - - target: $["paths"]["/connect_sessions"]["post"] - update: - x-codeSamples: - - lang: ruby - label: stackone_create_connect_session - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Shared::ConnectSessionCreate.new(\n categories: [\n ::StackOne::Shared::Categories::HRIS_LEGACY,\n ],\n origin_owner_id: \"\",\n origin_owner_name: \"\",\n)\n \nres = s.connect_sessions.create_connect_session(req)\n\nif ! res.connect_session_token.nil?\n # handle response\nend" - - target: $["paths"]["/connect_sessions/authenticate"]["post"] - update: - x-codeSamples: - - lang: ruby - label: stackone_authenticate_connect_session - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Shared::ConnectSessionAuthenticate.new(\n token: \"\",\n)\n \nres = s.connect_sessions.authenticate_connect_session(req)\n\nif ! res.connect_session.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: ats_update_application - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.update_application(id=\"\", x_account_id=\"\", ats_update_application_request_dto=::StackOne::Shared::AtsUpdateApplicationRequestDto.new(\n interview_stage_id: \"18bcbb1b-3cbc-4198-a999-460861d19480\",\n application_status: ::StackOne::Shared::AtsUpdateApplicationRequestDtoApplicationStatus.new(\n value: ::StackOne::Shared::AtsUpdateApplicationRequestDtoValue::HIRED,\n source_value: \"Hired\",\n ),\n source: ::StackOne::Shared::AtsUpdateApplicationRequestDtoSource.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"LinkedIn\",\n ),\n passthrough: {\n \"Licensed\": \"\",\n },\n rejected_reason_id: \"f223d7f6-908b-48f0-9237-b201c307f609\",\n ))\n\nif ! res.update_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/email/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: marketing_update_email_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.marketing.update_email_template(id=\"\", x_account_id=\"\", marketing_create_email_template_request_dto=::StackOne::Shared::MarketingCreateEmailTemplateRequestDto.new(\n messages: [\n ::StackOne::Shared::EmailMessages.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n message_type: ::StackOne::Shared::MessageType.new(\n source_value: \"Email\",\n ),\n ),\n ],\n passthrough: {\n \"strategize\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/users"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_users - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListUsersRequest.new(\n fields_: \"id,remote_id,first_name,last_name,name,email\",\n filter: ::StackOne::Operations::AtsListUsersQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_users(req)\n\nif ! res.users_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees"]["post"] - update: - x-codeSamples: - - lang: ruby - label: hris_create_employee - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.hris.create_employee(x_account_id=\"\", hris_create_employee_request_dto=::StackOne::Shared::HrisCreateEmployeeRequestDto.new(\n first_name: \"Issac\",\n last_name: \"Newton\",\n name: \"Issac Newton\",\n display_name: \"Sir Issac Newton\",\n avatar_url: \"https://example.com/avatar.png\",\n personal_email: \"isaac.newton@example.com\",\n personal_phone_number: \"+1234567890\",\n work_email: \"newton@example.com\",\n work_phone_number: \"+1234567890\",\n job_title: \"Physicist\",\n department: \"Physics\",\n manager_id: \"67890\",\n gender: ::StackOne::Shared::HrisCreateEmployeeRequestDtoGender.new(),\n preferred_language: ::StackOne::Shared::HrisCreateEmployeeRequestDtoPreferredLanguage.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasValue::ENG,\n ),\n ethnicity: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEthnicity.new(),\n date_of_birth: DateTime.iso8601('1990-01-01T00:00.000Z'),\n birthday: DateTime.iso8601('2021-01-01T00:00:00Z'),\n marital_status: ::StackOne::Shared::HrisCreateEmployeeRequestDtoMaritalStatus.new(),\n avatar: ::StackOne::Shared::HrisCreateEmployeeRequestDtoAvatar.new(),\n hire_date: DateTime.iso8601('2021-01-01T00:00.000Z'),\n start_date: DateTime.iso8601('2021-01-01T00:00.000Z'),\n tenure: 2.0,\n work_anniversary: DateTime.iso8601('2021-01-01T00:00:00Z'),\n employment_type: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEmploymentType.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasEmploymentTypeValue::PERMANENT,\n source_value: \"Permanent\",\n ),\n employment_contract_type: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEmploymentContractType.new(),\n employment_status: ::StackOne::Shared::HrisCreateEmployeeRequestDtoEmploymentStatus.new(),\n termination_date: DateTime.iso8601('2021-01-01T00:00:00Z'),\n company_name: \"Example Corp\",\n citizenships: [\n ::StackOne::Shared::CountryCodeEnum.new(\n value: ::StackOne::Shared::Value::US,\n ),\n ],\n employments: [\n ::StackOne::Shared::Employment.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n employee_id: \"1687-3\",\n remote_employee_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n job_title: \"Software Engineer\",\n pay_rate: \"40.00\",\n pay_period: ::StackOne::Shared::PayPeriod.new(\n value: ::StackOne::Shared::EmploymentValue::HOUR,\n source_value: \"Hour\",\n ),\n pay_frequency: ::StackOne::Shared::PayFrequency.new(\n value: ::StackOne::Shared::EmploymentSchemasValue::HOURLY,\n source_value: \"Hourly\",\n ),\n pay_currency: \"USD\",\n effective_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n employment_type: ::StackOne::Shared::EmploymentEmploymentType.new(\n value: ::StackOne::Shared::EmploymentSchemasEmploymentTypeValue::PERMANENT,\n source_value: \"Permanent\",\n ),\n employment_contract_type: ::StackOne::Shared::EmploymentEmploymentContractType.new(),\n created_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n updated_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n ),\n ],\n custom_fields: [\n ::StackOne::Shared::EmployeeCustomFields.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Training Completion Status\",\n description: \"The completion status of the employee's training.\",\n type: ::StackOne::Shared::Type.new(),\n value: \"Completed\",\n value_id: \"value_456\",\n remote_value_id: \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n options: [\n \"\",\n ],\n ),\n ],\n benefits: [\n ::StackOne::Shared::HRISBenefit.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n name: \"Health Insurance\",\n provider: \"Aetna\",\n description: \"Health insurance for employees\",\n created_at: DateTime.iso8601('2021-01-01T00:00:00Z'),\n updated_at: DateTime.iso8601('2021-01-01T00:00:00Z'),\n ),\n ],\n passthrough: {\n \"Cheese\": \"\",\n },\n job_id: \"R-6789\",\n home_location: ::StackOne::Shared::HrisCreateEmployeeRequestDtoHomeLocation.new(\n name: \"Woolsthorpe Manor\",\n phone_number: \"+44 1476 860 364\",\n street_1: \"Water Lane\",\n street_2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zip_code: \"NG33 5NR\",\n country: ::StackOne::Shared::HrisCreateEmployeeRequestDtoCountry.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasHomeLocationValue::US,\n ),\n passthrough: {\n \"Bugatti\": \"\",\n },\n state: ::StackOne::Shared::State.new(),\n ),\n work_location: ::StackOne::Shared::HrisCreateEmployeeRequestDtoWorkLocation.new(\n name: \"Woolsthorpe Manor\",\n phone_number: \"+44 1476 860 364\",\n street_1: \"Water Lane\",\n street_2: \"Woolsthorpe by Colsterworth\",\n city: \"Grantham\",\n zip_code: \"NG33 5NR\",\n country: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasCountry.new(\n value: ::StackOne::Shared::HrisCreateEmployeeRequestDtoSchemasWorkLocationValue::US,\n ),\n passthrough: {\n \"underneath\": \"\",\n },\n state: ::StackOne::Shared::HrisCreateEmployeeRequestDtoState.new(),\n ),\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employments"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_employments - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListEmploymentsRequest.new(\n fields_: \"id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type,employment_contract_type,created_at,updated_at\",\n filter: ::StackOne::Operations::HrisListEmploymentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n expand: \"groups\",\n x_account_id: \"\",\n)\n \nres = s.hris.list_employments(req)\n\nif ! res.employments_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/benefits"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_list_benefits - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisListBenefitsRequest.new(\n fields_: \"id,remote_id,name,benefit_type,provider,description,created_at,updated_at\",\n filter: ::StackOne::Operations::HrisListBenefitsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.hris.list_benefits(req)\n\nif ! res.hris_benefits_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/email"]["get"] - update: - x-codeSamples: - - lang: ruby - label: marketing_list_email_templates - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::MarketingListEmailTemplatesRequest.new(\n fields_: \"id,remote_id,name,messages,created_at,updated_at,tags\",\n filter: ::StackOne::Operations::MarketingListEmailTemplatesQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.marketing.list_email_templates(req)\n\nif ! res.templates_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/marketing/templates/omni_channel"]["post"] - update: - x-codeSamples: - - lang: ruby - label: marketing_create_omni_channel_template - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.marketing.create_omni_channel_template(x_account_id=\"\", marketing_create_template_request_dto=::StackOne::Shared::MarketingCreateTemplateRequestDto.new(\n messages: [\n ::StackOne::Shared::Message.new(\n id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n remote_id: \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n message_type: ::StackOne::Shared::MessageMessageType.new(\n source_value: \"Email\",\n ),\n ),\n ],\n passthrough: {\n \"Cargo\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/accounts"]["get"] - update: - x-codeSamples: - - lang: ruby - label: stackone_list_linked_accounts - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::StackoneListLinkedAccountsRequest.new()\n \nres = s.accounts.list_linked_accounts(req)\n\nif ! res.linked_accounts.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/jobs"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_jobs - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListJobsRequest.new(\n fields_: \"id,remote_id,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,created_at,updated_at\",\n filter: ::StackOne::Operations::AtsListJobsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n expand: \"job_postings,interview_stages\",\n x_account_id: \"\",\n)\n \nres = s.ats.list_jobs(req)\n\nif ! res.jobs_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/lists"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_lists - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListListsRequest.new(\n fields_: \"id,remote_id,name,created_at,updated_at,items,type\",\n filter: ::StackOne::Operations::AtsListListsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_lists(req)\n\nif ! res.lists_paginated.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/offers"]["post"] - update: - x-codeSamples: - - lang: ruby - label: ats_create_offer - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.create_offer(x_account_id=\"\", ats_create_offer_request_dto=::StackOne::Shared::AtsCreateOfferRequestDto.new(\n start_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n offer_status: ::StackOne::Shared::AtsCreateOfferRequestDtoOfferStatus.new(\n value: ::StackOne::Shared::AtsCreateOfferRequestDtoValue::PENDING,\n source_value: \"Pending\",\n ),\n offer_history: [\n ::StackOne::Shared::OfferHistory.new(\n start_date: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n created_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n updated_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n ),\n ],\n passthrough: {\n \"quas\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates/{id}"]["patch"] - update: - x-codeSamples: - - lang: ruby - label: ats_update_candidate - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.update_candidate(id=\"\", x_account_id=\"\", ats_update_candidate_request_dto=::StackOne::Shared::AtsUpdateCandidateRequestDto.new(\n name: \"Romain Sestier\",\n first_name: \"Romain\",\n last_name: \"Sestier\",\n email: \"sestier.romain123@gmail.com\",\n emails: [\n ::StackOne::Shared::CandidateEmail.new(\n type: \"personal\",\n value: \"sestier.romain123@gmail.com\",\n ),\n ],\n social_links: [\n ::StackOne::Shared::SocialLink.new(\n type: \"linkedin\",\n url: \"https://www.linkedin.com/in/romainsestier/\",\n ),\n ],\n phone_numbers: [\n ::StackOne::Shared::PhoneNumber.new(\n phone: \"+447700112233\",\n ),\n ],\n company: \"Company Inc.\",\n title: \"Software Engineer\",\n application_ids: [\n \"\",\n ],\n hired_at: DateTime.iso8601('2021-01-01T01:01:01.000Z'),\n country: \"United States\",\n passthrough: {\n \"Extended\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/candidates/{id}/notes"]["post"] - update: - x-codeSamples: - - lang: ruby - label: ats_create_candidate_note - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.ats.create_candidate_note(id=\"\", x_account_id=\"\", ats_create_notes_request_dto=::StackOne::Shared::AtsCreateNotesRequestDto.new(\n content: [\n ::StackOne::Shared::NoteContentApiModel.new(\n body: \"This candidate seems like a good fit for the role\",\n ),\n ],\n author_id: \"1234567890\",\n visibility: ::StackOne::Shared::AtsCreateNotesRequestDtoVisibility.new(\n value: ::StackOne::Shared::AtsCreateNotesRequestDtoValue::PUBLIC,\n source_value: \"Public\",\n ),\n passthrough: {\n \"Freeway\": \"\",\n },\n ))\n\nif ! res.create_result.nil?\n # handle response\nend" - - target: $["paths"]["/accounts/{id}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: stackone_get_account - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n \nres = s.accounts.get_account(id=\"\")\n\nif ! res.linked_account.nil?\n # handle response\nend" - - target: $["paths"]["/unified/hris/employees/{id}/time_off/{subResourceId}"]["get"] - update: - x-codeSamples: - - lang: ruby - label: hris_get_employees_time_off_request - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::HrisGetEmployeesTimeOffRequestRequest.new(\n id: \"\",\n sub_resource_id: \"\",\n fields_: \"id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at\",\n x_account_id: \"\",\n)\n \nres = s.hris.get_employees_time_off_request(req)\n\nif ! res.time_off_result.nil?\n # handle response\nend" - - target: $["paths"]["/unified/ats/applications/{id}/documents"]["get"] - update: - x-codeSamples: - - lang: ruby - label: ats_list_application_documents - source: "require 'stackone_client'\n\n\ns = ::StackOne::StackOne.new\ns.config_security(\n ::StackOne::Shared::Security.new(\n username: \"\",\n )\n)\n\n\nreq = ::StackOne::Operations::AtsListApplicationDocumentsRequest.new(\n id: \"\",\n fields_: \"id,remote_id,name,path,type,category,contents,created_at,updated_at,remote_url,file_format\",\n filter: ::StackOne::Operations::AtsListApplicationDocumentsQueryParamFilter.new(\n updated_after: \"2020-01-01T00:00:00.000Z\",\n ),\n x_account_id: \"\",\n)\n \nres = s.ats.list_application_documents(req)\n\nif ! res.ats_documents_paginated.nil?\n # handle response\nend" +actions: [] diff --git a/docs/models/operations/atsgetcandidaterequest.md b/docs/models/operations/atsgetcandidaterequest.md index 9e4ab2ad..dde93452 100644 --- a/docs/models/operations/atsgetcandidaterequest.md +++ b/docs/models/operations/atsgetcandidaterequest.md @@ -3,10 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,created_at,updated_at | -| `id` | *::String* | :heavy_check_mark: | N/A | | -| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at | +| `id` | *::String* | :heavy_check_mark: | N/A | | +| `include` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be included in the response | custom_fields | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/atslistcandidatesrequest.md b/docs/models/operations/atslistcandidatesrequest.md index d88efb9f..d98c7898 100644 --- a/docs/models/operations/atslistcandidatesrequest.md +++ b/docs/models/operations/atslistcandidatesrequest.md @@ -5,8 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,created_at,updated_at | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at | | `filter` | [T.nilable(::StackOne::Operations::AtsListCandidatesQueryParamFilter)](../../models/operations/atslistcandidatesqueryparamfilter.md) | :heavy_minus_sign: | ATS Candidate Filter | | +| `include` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be included in the response | custom_fields | | `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | | ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | | `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | diff --git a/docs/models/operations/hrisgetdepartmentgrouprequest.md b/docs/models/operations/hrisgetdepartmentgrouprequest.md new file mode 100644 index 00000000..ebcf24bf --- /dev/null +++ b/docs/models/operations/hrisgetdepartmentgrouprequest.md @@ -0,0 +1,12 @@ +# HrisGetDepartmentGroupRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name | +| `id` | *::String* | :heavy_check_mark: | N/A | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/hrisgetdepartmentgroupresponse.md b/docs/models/operations/hrisgetdepartmentgroupresponse.md new file mode 100644 index 00000000..440b15bb --- /dev/null +++ b/docs/models/operations/hrisgetdepartmentgroupresponse.md @@ -0,0 +1,11 @@ +# HrisGetDepartmentGroupResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `hris_departments_result` | [T.nilable(::StackOne::Shared::HRISDepartmentsResult)](../../models/shared/hrisdepartmentsresult.md) | :heavy_minus_sign: | The department group with the given identifier was retrieved. | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/hrislistdepartmentgroupsqueryparamfilter.md b/docs/models/operations/hrislistdepartmentgroupsqueryparamfilter.md new file mode 100644 index 00000000..e158267a --- /dev/null +++ b/docs/models/operations/hrislistdepartmentgroupsqueryparamfilter.md @@ -0,0 +1,10 @@ +# HrisListDepartmentGroupsQueryParamFilter + +Filter parameters that allow greater customisation of the list response + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `updated_after` | *T.nilable(::String)* | :heavy_minus_sign: | Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | \ No newline at end of file diff --git a/docs/models/operations/hrislistdepartmentgroupsrequest.md b/docs/models/operations/hrislistdepartmentgroupsrequest.md new file mode 100644 index 00000000..03e76853 --- /dev/null +++ b/docs/models/operations/hrislistdepartmentgroupsrequest.md @@ -0,0 +1,16 @@ +# HrisListDepartmentGroupsRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name | +| `filter` | [T.nilable(::StackOne::Operations::HrisListDepartmentGroupsQueryParamFilter)](../../models/operations/hrislistdepartmentgroupsqueryparamfilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | +| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | +| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/hrislistdepartmentgroupsresponse.md b/docs/models/operations/hrislistdepartmentgroupsresponse.md new file mode 100644 index 00000000..1dd3cad4 --- /dev/null +++ b/docs/models/operations/hrislistdepartmentgroupsresponse.md @@ -0,0 +1,11 @@ +# HrisListDepartmentGroupsResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `hris_departments_paginated` | [T.nilable(::StackOne::Shared::HRISDepartmentsPaginated)](../../models/shared/hrisdepartmentspaginated.md) | :heavy_minus_sign: | The list of department groups was retrieved. | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/marketingcreatecontentblockrequest.md b/docs/models/operations/marketingcreatecontentblockrequest.md new file mode 100644 index 00000000..d336727c --- /dev/null +++ b/docs/models/operations/marketingcreatecontentblockrequest.md @@ -0,0 +1,9 @@ +# MarketingCreateContentBlockRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `marketing_create_content_blocks_request_dto` | [::StackOne::Shared::MarketingCreateContentBlocksRequestDto](../../models/shared/marketingcreatecontentblocksrequestdto.md) | :heavy_check_mark: | N/A | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | \ No newline at end of file diff --git a/docs/models/operations/marketingcreatecontentblockresponse.md b/docs/models/operations/marketingcreatecontentblockresponse.md new file mode 100644 index 00000000..323b6138 --- /dev/null +++ b/docs/models/operations/marketingcreatecontentblockresponse.md @@ -0,0 +1,11 @@ +# MarketingCreateContentBlockResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `create_result` | [T.nilable(::StackOne::Shared::CreateResult)](../../models/shared/createresult.md) | :heavy_minus_sign: | Record created successfully. | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/marketinggetcontentblockrequest.md b/docs/models/operations/marketinggetcontentblockrequest.md new file mode 100644 index 00000000..cdd53774 --- /dev/null +++ b/docs/models/operations/marketinggetcontentblockrequest.md @@ -0,0 +1,12 @@ +# MarketingGetContentBlockRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name,type,content,status,tags,created_at,updated_at | +| `id` | *::String* | :heavy_check_mark: | N/A | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/marketinggetcontentblockresponse.md b/docs/models/operations/marketinggetcontentblockresponse.md new file mode 100644 index 00000000..7b6877bc --- /dev/null +++ b/docs/models/operations/marketinggetcontentblockresponse.md @@ -0,0 +1,11 @@ +# MarketingGetContentBlockResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `content_blocks_paginated` | [T.nilable(::StackOne::Shared::ContentBlocksPaginated)](../../models/shared/contentblockspaginated.md) | :heavy_minus_sign: | The Content Block with the given identifier was retrieved | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/marketinglistcontentblocksqueryparamfilter.md b/docs/models/operations/marketinglistcontentblocksqueryparamfilter.md new file mode 100644 index 00000000..6eed5df1 --- /dev/null +++ b/docs/models/operations/marketinglistcontentblocksqueryparamfilter.md @@ -0,0 +1,10 @@ +# MarketingListContentBlocksQueryParamFilter + +Filter parameters that allow greater customisation of the list response + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `updated_after` | *T.nilable(::String)* | :heavy_minus_sign: | Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | \ No newline at end of file diff --git a/docs/models/operations/marketinglistcontentblocksrequest.md b/docs/models/operations/marketinglistcontentblocksrequest.md new file mode 100644 index 00000000..28c71931 --- /dev/null +++ b/docs/models/operations/marketinglistcontentblocksrequest.md @@ -0,0 +1,16 @@ +# MarketingListContentBlocksRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `fields_` | *T.nilable(::String)* | :heavy_minus_sign: | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,name,type,content,status,tags,created_at,updated_at | +| `filter` | [T.nilable(::StackOne::Operations::MarketingListContentBlocksQueryParamFilter)](../../models/operations/marketinglistcontentblocksqueryparamfilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | The unified cursor | | +| ~~`page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The page number of the results to fetch | | +| `page_size` | *T.nilable(::String)* | :heavy_minus_sign: | The number of results per page | | +| `proxy` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `raw` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| ~~`updated_after`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Use a string with a date to only select results updated after that given date | 2020-01-01T00:00:00.000Z | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | | \ No newline at end of file diff --git a/docs/models/operations/marketinglistcontentblocksresponse.md b/docs/models/operations/marketinglistcontentblocksresponse.md new file mode 100644 index 00000000..f7393e04 --- /dev/null +++ b/docs/models/operations/marketinglistcontentblocksresponse.md @@ -0,0 +1,11 @@ +# MarketingListContentBlocksResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `content_blocks_paginated` | [T.nilable(::StackOne::Shared::ContentBlocksPaginated)](../../models/shared/contentblockspaginated.md) | :heavy_minus_sign: | The list of Content Blocks was retrieved. | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/marketingupdatecontentblockrequest.md b/docs/models/operations/marketingupdatecontentblockrequest.md new file mode 100644 index 00000000..9b35f464 --- /dev/null +++ b/docs/models/operations/marketingupdatecontentblockrequest.md @@ -0,0 +1,10 @@ +# MarketingUpdateContentBlockRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `marketing_create_content_blocks_request_dto` | [::StackOne::Shared::MarketingCreateContentBlocksRequestDto](../../models/shared/marketingcreatecontentblocksrequestdto.md) | :heavy_check_mark: | N/A | +| `id` | *::String* | :heavy_check_mark: | N/A | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | \ No newline at end of file diff --git a/docs/models/operations/marketingupdatecontentblockresponse.md b/docs/models/operations/marketingupdatecontentblockresponse.md new file mode 100644 index 00000000..2c2a0b6f --- /dev/null +++ b/docs/models/operations/marketingupdatecontentblockresponse.md @@ -0,0 +1,11 @@ +# MarketingUpdateContentBlockResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `create_result` | [T.nilable(::StackOne::Shared::CreateResult)](../../models/shared/createresult.md) | :heavy_minus_sign: | Record updated successfully | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/shared/candidate.md b/docs/models/shared/candidate.md index 02e5eb55..e2e631e2 100644 --- a/docs/models/shared/candidate.md +++ b/docs/models/shared/candidate.md @@ -9,6 +9,7 @@ | `company` | *T.nilable(::String)* | :heavy_minus_sign: | Candidate company | Company Inc. | | `country` | *T.nilable(::String)* | :heavy_minus_sign: | Candidate country | United States | | `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Candidate created date | 2021-01-01T01:01:01.000Z | +| `custom_fields` | T::Array<[::StackOne::Shared::CandidateCustomFields](../../models/shared/candidatecustomfields.md)> | :heavy_minus_sign: | The candidate custom fields | | | `email` | *T.nilable(::String)* | :heavy_minus_sign: | Candidate email | sestier.romain123@gmail.com | | `emails` | T::Array<[::StackOne::Shared::CandidateEmail](../../models/shared/candidateemail.md)> | :heavy_minus_sign: | List of candidate emails | | | `first_name` | *T.nilable(::String)* | :heavy_minus_sign: | Candidate first name | Romain | diff --git a/docs/models/shared/candidatecustomfields.md b/docs/models/shared/candidatecustomfields.md new file mode 100644 index 00000000..02090749 --- /dev/null +++ b/docs/models/shared/candidatecustomfields.md @@ -0,0 +1,16 @@ +# CandidateCustomFields + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | The description of the custom field. | Industry in which the candidate prefers to work. | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the custom field. | Preferred Industry | +| `options` | T::Array<*::Object*> | :heavy_minus_sign: | An array of possible options for the custom field. | [
"Technology",
"Finance",
"Healthcare",
"Education",
"Manufacturing"
] | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `remote_value_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier for the value of the custom field. | e3cb75bf-aa84-466e-a6c1-b8322b257a48 | +| `type` | [T.nilable(::StackOne::Shared::CandidateCustomFieldsType)](../../models/shared/candidatecustomfieldstype.md) | :heavy_minus_sign: | The type of the custom field. | Dropdown | +| `value` | *T.nilable(::Object)* | :heavy_minus_sign: | The value associated with the custom field. | Technology | +| `value_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique identifier for the value of the custom field. | value_456 | \ No newline at end of file diff --git a/docs/models/shared/candidatecustomfieldstype.md b/docs/models/shared/candidatecustomfieldstype.md new file mode 100644 index 00000000..2552d623 --- /dev/null +++ b/docs/models/shared/candidatecustomfieldstype.md @@ -0,0 +1,11 @@ +# CandidateCustomFieldsType + +The type of the custom field. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | +| `value` | [T.nilable(::StackOne::Shared::CandidateCustomFieldsValue)](../../models/shared/candidatecustomfieldsvalue.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/candidatecustomfieldsvalue.md b/docs/models/shared/candidatecustomfieldsvalue.md new file mode 100644 index 00000000..ffce130a --- /dev/null +++ b/docs/models/shared/candidatecustomfieldsvalue.md @@ -0,0 +1,13 @@ +# CandidateCustomFieldsValue + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `DATE` | date | +| `FLOAT` | float | +| `INTEGER` | integer | +| `LIST` | list | +| `TEXT` | text | +| `UNMAPPED_VALUE` | unmapped_value | \ No newline at end of file diff --git a/docs/models/shared/contentblock.md b/docs/models/shared/contentblock.md new file mode 100644 index 00000000..8771c306 --- /dev/null +++ b/docs/models/shared/contentblock.md @@ -0,0 +1,16 @@ +# ContentBlock + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `content` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | | +| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Date of creation | 2021-01-01T00:00:00.000Z | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `status` | [T.nilable(::StackOne::Shared::ContentBlockStatus)](../../models/shared/contentblockstatus.md) | :heavy_minus_sign: | Stackone enum identifying the status of content block. | | +| `tags` | T::Array<*::String*> | :heavy_minus_sign: | N/A | | +| `type` | [T.nilable(::StackOne::Shared::ContentBlockType)](../../models/shared/contentblocktype.md) | :heavy_minus_sign: | Stackone enum identifying the type of content block. | | +| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Date of last update | 2021-01-01T00:00:00.000Z | \ No newline at end of file diff --git a/docs/models/shared/contentblockschemasvalue.md b/docs/models/shared/contentblockschemasvalue.md new file mode 100644 index 00000000..79edc2f2 --- /dev/null +++ b/docs/models/shared/contentblockschemasvalue.md @@ -0,0 +1,10 @@ +# ContentBlockSchemasValue + +The type of the content blocks. + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/shared/contentblockspaginated.md b/docs/models/shared/contentblockspaginated.md new file mode 100644 index 00000000..3bd6b2be --- /dev/null +++ b/docs/models/shared/contentblockspaginated.md @@ -0,0 +1,11 @@ +# ContentBlocksPaginated + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `data` | T::Array<[::StackOne::Shared::ContentBlock](../../models/shared/contentblock.md)> | :heavy_check_mark: | N/A | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| ~~`next_page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | +| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/contentblockstatus.md b/docs/models/shared/contentblockstatus.md new file mode 100644 index 00000000..fcba7323 --- /dev/null +++ b/docs/models/shared/contentblockstatus.md @@ -0,0 +1,11 @@ +# ContentBlockStatus + +Stackone enum identifying the status of content block. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the status. | draft | +| `value` | [T.nilable(::StackOne::Shared::ContentBlockValue)](../../models/shared/contentblockvalue.md) | :heavy_minus_sign: | The Status of the content blocks. | email | \ No newline at end of file diff --git a/docs/models/shared/contentblocktype.md b/docs/models/shared/contentblocktype.md new file mode 100644 index 00000000..09b296f4 --- /dev/null +++ b/docs/models/shared/contentblocktype.md @@ -0,0 +1,11 @@ +# ContentBlockType + +Stackone enum identifying the type of content block. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | The source value of the type. | text | +| `value` | [T.nilable(::StackOne::Shared::ContentBlockSchemasValue)](../../models/shared/contentblockschemasvalue.md) | :heavy_minus_sign: | The type of the content blocks. | email | \ No newline at end of file diff --git a/docs/models/shared/contentblockvalue.md b/docs/models/shared/contentblockvalue.md new file mode 100644 index 00000000..c306de73 --- /dev/null +++ b/docs/models/shared/contentblockvalue.md @@ -0,0 +1,10 @@ +# ContentBlockValue + +The Status of the content blocks. + + +## Values + +| Name | Value | +| ------ | ------ | +| `TEXT` | text | \ No newline at end of file diff --git a/docs/models/shared/createresult.md b/docs/models/shared/createresult.md index de094ac0..51a3b0f4 100644 --- a/docs/models/shared/createresult.md +++ b/docs/models/shared/createresult.md @@ -7,5 +7,5 @@ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `data` | [::StackOne::Shared::CreateResultDataApiModel](../../models/shared/createresultdataapimodel.md) | :heavy_check_mark: | N/A | | | `message` | *::String* | :heavy_check_mark: | N/A | Record created successfully. | -| `status_code` | *::Float* | :heavy_check_mark: | N/A | 200 | +| `status_code` | *::Float* | :heavy_check_mark: | N/A | 201 | | `timestamp` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2021-01-01T01:01:01.000Z | \ No newline at end of file diff --git a/docs/models/shared/employee.md b/docs/models/shared/employee.md index 076d4e70..52e83a75 100644 --- a/docs/models/shared/employee.md +++ b/docs/models/shared/employee.md @@ -26,7 +26,7 @@ | `ethnicity` | [T.nilable(::StackOne::Shared::Ethnicity)](../../models/shared/ethnicity.md) | :heavy_minus_sign: | The employee ethnicity | white | | `first_name` | *T.nilable(::String)* | :heavy_minus_sign: | The employee first name | Issac | | `gender` | [T.nilable(::StackOne::Shared::Gender)](../../models/shared/gender.md) | :heavy_minus_sign: | The employee gender | male | -| `groups` | [T.nilable(::StackOne::Shared::Groups)](../../models/shared/groups.md) | :heavy_minus_sign: | The employee groups | | +| `groups` | T::Array<[::StackOne::Shared::HRISGroup](../../models/shared/hrisgroup.md)> | :heavy_minus_sign: | The employee groups | | | `hire_date` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | The employee hire date | 2021-01-01T00:00.000Z | | `home_location` | [T.nilable(::StackOne::Shared::HomeLocation)](../../models/shared/homelocation.md) | :heavy_minus_sign: | The employee home location | | | `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | diff --git a/docs/models/shared/employeeschemasgroupsvalue.md b/docs/models/shared/employeeschemasgroupsvalue.md deleted file mode 100644 index 85915785..00000000 --- a/docs/models/shared/employeeschemasgroupsvalue.md +++ /dev/null @@ -1,13 +0,0 @@ -# EmployeeSchemasGroupsValue - - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `WORKSPACE` | workspace | -| `TEAM` | team | -| `DEPARTMENT` | department | -| `GROUP` | group | -| `ORGANIZATION` | organization | -| `UNMAPPED_VALUE` | unmapped_value | \ No newline at end of file diff --git a/docs/models/shared/employeeschemastype.md b/docs/models/shared/employeeschemastype.md deleted file mode 100644 index 646113aa..00000000 --- a/docs/models/shared/employeeschemastype.md +++ /dev/null @@ -1,9 +0,0 @@ -# EmployeeSchemasType - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | -| `value` | [T.nilable(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue)](../../models/shared/employeeschemasnationalidentitynumbervalue.md) | :heavy_minus_sign: | The type of the national identity number | ssn | \ No newline at end of file diff --git a/docs/models/shared/employeetype.md b/docs/models/shared/employeetype.md index 5e183a13..ec075b4d 100644 --- a/docs/models/shared/employeetype.md +++ b/docs/models/shared/employeetype.md @@ -1,11 +1,9 @@ # EmployeeType -The type of the group - ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | -| `value` | [T.nilable(::StackOne::Shared::EmployeeSchemasGroupsValue)](../../models/shared/employeeschemasgroupsvalue.md) | :heavy_minus_sign: | N/A | team | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | +| `value` | [T.nilable(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue)](../../models/shared/employeeschemasnationalidentitynumbervalue.md) | :heavy_minus_sign: | The type of the national identity number | ssn | \ No newline at end of file diff --git a/docs/models/shared/groups.md b/docs/models/shared/groups.md deleted file mode 100644 index 01924087..00000000 --- a/docs/models/shared/groups.md +++ /dev/null @@ -1,16 +0,0 @@ -# Groups - -The employee groups - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the group | | -| `owner_ids` | T::Array<*::String*> | :heavy_minus_sign: | The list of group owner ids of the given group | | -| `parent_ids` | T::Array<*::String*> | :heavy_minus_sign: | The list of parent group ids of the given group | | -| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | -| `remote_parent_ids` | T::Array<*::String*> | :heavy_minus_sign: | Provider's list of parent group ids of the given group | | -| `type` | [T.nilable(::StackOne::Shared::EmployeeType)](../../models/shared/employeetype.md) | :heavy_minus_sign: | The type of the group | | \ No newline at end of file diff --git a/docs/models/shared/hrisdepartment.md b/docs/models/shared/hrisdepartment.md new file mode 100644 index 00000000..013c523a --- /dev/null +++ b/docs/models/shared/hrisdepartment.md @@ -0,0 +1,14 @@ +# HRISDepartment + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the group | | +| `owner_ids` | T::Array<*::String*> | :heavy_minus_sign: | The list of group owner ids of the given group | | +| `parent_ids` | T::Array<*::String*> | :heavy_minus_sign: | The list of parent group ids of the given group | | +| `remote_id` | *T.nilable(::String)* | :heavy_minus_sign: | Provider's unique identifier | 8187e5da-dc77-475e-9949-af0f1fa4e4e3 | +| `remote_parent_ids` | T::Array<*::String*> | :heavy_minus_sign: | Provider's list of parent group ids of the given group | | +| `type` | [T.nilable(::StackOne::Shared::HRISDepartmentType)](../../models/shared/hrisdepartmenttype.md) | :heavy_minus_sign: | The type of the department group | department | \ No newline at end of file diff --git a/docs/models/shared/hrisdepartmentspaginated.md b/docs/models/shared/hrisdepartmentspaginated.md new file mode 100644 index 00000000..d6a5a2d6 --- /dev/null +++ b/docs/models/shared/hrisdepartmentspaginated.md @@ -0,0 +1,11 @@ +# HRISDepartmentsPaginated + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `data` | T::Array<[::StackOne::Shared::HRISDepartment](../../models/shared/hrisdepartment.md)> | :heavy_check_mark: | N/A | +| `next_` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| ~~`next_page`~~ | *T.nilable(::String)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | +| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/hrisdepartmentsresult.md b/docs/models/shared/hrisdepartmentsresult.md new file mode 100644 index 00000000..18b3904c --- /dev/null +++ b/docs/models/shared/hrisdepartmentsresult.md @@ -0,0 +1,9 @@ +# HRISDepartmentsResult + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `data` | [::StackOne::Shared::HRISDepartment](../../models/shared/hrisdepartment.md) | :heavy_check_mark: | N/A | +| `raw` | T::Array<[::StackOne::Shared::RawResponse](../../models/shared/rawresponse.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/hrisdepartmenttype.md b/docs/models/shared/hrisdepartmenttype.md new file mode 100644 index 00000000..7406c6a2 --- /dev/null +++ b/docs/models/shared/hrisdepartmenttype.md @@ -0,0 +1,11 @@ +# HRISDepartmentType + +The type of the department group + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `source_value` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | +| `value` | [T.nilable(::StackOne::Shared::HRISDepartmentValue)](../../models/shared/hrisdepartmentvalue.md) | :heavy_minus_sign: | N/A | department | \ No newline at end of file diff --git a/docs/models/shared/hrisdepartmentvalue.md b/docs/models/shared/hrisdepartmentvalue.md new file mode 100644 index 00000000..383a822e --- /dev/null +++ b/docs/models/shared/hrisdepartmentvalue.md @@ -0,0 +1,8 @@ +# HRISDepartmentValue + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `DEPARTMENT` | department | \ No newline at end of file diff --git a/docs/models/shared/marketingcreatecontentblocksrequestdto.md b/docs/models/shared/marketingcreatecontentblocksrequestdto.md new file mode 100644 index 00000000..86eac63f --- /dev/null +++ b/docs/models/shared/marketingcreatecontentblocksrequestdto.md @@ -0,0 +1,11 @@ +# MarketingCreateContentBlocksRequestDto + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `content` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | | +| `name` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | | +| `passthrough` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Value to pass through to the provider | {"other_known_names": "John Doe"} | +| `tags` | T::Array<*::String*> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/nationalidentitynumber.md b/docs/models/shared/nationalidentitynumber.md index d82bb5e8..82c7fc87 100644 --- a/docs/models/shared/nationalidentitynumber.md +++ b/docs/models/shared/nationalidentitynumber.md @@ -5,7 +5,7 @@ The national identity number ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [T.nilable(::StackOne::Shared::EmployeeSchemasType)](../../models/shared/employeeschemastype.md) | :heavy_minus_sign: | N/A | | -| `value` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 123456789 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `type` | [T.nilable(::StackOne::Shared::EmployeeType)](../../models/shared/employeetype.md) | :heavy_minus_sign: | N/A | | +| `value` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 123456789 | \ No newline at end of file diff --git a/docs/sdks/ats/README.md b/docs/sdks/ats/README.md index 30efd9d2..4e58bbfb 100644 --- a/docs/sdks/ats/README.md +++ b/docs/sdks/ats/README.md @@ -590,8 +590,9 @@ s.config_security( req = ::StackOne::Operations::AtsGetCandidateRequest.new( - fields_: "id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,created_at,updated_at", + fields_: "id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at", id: "", + include: "custom_fields", x_account_id: "", ) @@ -1401,10 +1402,11 @@ s.config_security( req = ::StackOne::Operations::AtsListCandidatesRequest.new( - fields_: "id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,created_at,updated_at", + fields_: "id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at", filter: ::StackOne::Operations::AtsListCandidatesQueryParamFilter.new( updated_after: "2020-01-01T00:00:00.000Z", ), + include: "custom_fields", x_account_id: "", ) diff --git a/docs/sdks/hris/README.md b/docs/sdks/hris/README.md index 48a7c91a..22c2717f 100644 --- a/docs/sdks/hris/README.md +++ b/docs/sdks/hris/README.md @@ -10,6 +10,7 @@ * [download_employee_document](#download_employee_document) - Download Employee Document * [get_benefit](#get_benefit) - Get Benefit * [get_company](#get_company) - Get Company +* [get_department_group](#get_department_group) - Get Department Group * [get_employee](#get_employee) - Get Employee * [get_employee_document](#get_employee_document) - Get Employee Document * [get_employee_document_category](#get_employee_document_category) - Get Employee Document Category @@ -22,6 +23,7 @@ * [get_time_off_request](#get_time_off_request) - Get time off request * [list_benefits](#list_benefits) - List benefits * [list_companies](#list_companies) - List Companies +* [list_department_groups](#list_department_groups) - List Department Groups * [list_employee_categories](#list_employee_categories) - List Employee Document Categories * [list_employee_documents](#list_employee_documents) - List Employee Documents * [list_employee_time_off_requests](#list_employee_time_off_requests) - List Employee Time Off Requests @@ -496,6 +498,50 @@ end **[T.nilable(::StackOne::Operations::HrisGetCompanyResponse)](../../models/operations/hrisgetcompanyresponse.md)** +## get_department_group + +Get Department Group + +### Example Usage + +```ruby +require 'stackone_client' + + +s = ::StackOne::StackOne.new +s.config_security( + ::StackOne::Shared::Security.new( + password: "", + ) +) + + +req = ::StackOne::Operations::HrisGetDepartmentGroupRequest.new( + fields_: "id,remote_id,name", + id: "", + x_account_id: "", +) + +res = s.hris.get_department_group(req) + +if ! res.hris_departments_result.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `request` | [::StackOne::Operations::HrisGetDepartmentGroupRequest](../../models/operations/hrisgetdepartmentgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[T.nilable(::StackOne::Operations::HrisGetDepartmentGroupResponse)](../../models/operations/hrisgetdepartmentgroupresponse.md)** + + ## get_employee Get Employee @@ -1034,6 +1080,52 @@ end **[T.nilable(::StackOne::Operations::HrisListCompaniesResponse)](../../models/operations/hrislistcompaniesresponse.md)** +## list_department_groups + +List Department Groups + +### Example Usage + +```ruby +require 'stackone_client' + + +s = ::StackOne::StackOne.new +s.config_security( + ::StackOne::Shared::Security.new( + password: "", + ) +) + + +req = ::StackOne::Operations::HrisListDepartmentGroupsRequest.new( + fields_: "id,remote_id,name", + filter: ::StackOne::Operations::HrisListDepartmentGroupsQueryParamFilter.new( + updated_after: "2020-01-01T00:00:00.000Z", + ), + x_account_id: "", +) + +res = s.hris.list_department_groups(req) + +if ! res.hris_departments_paginated.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `request` | [::StackOne::Operations::HrisListDepartmentGroupsRequest](../../models/operations/hrislistdepartmentgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[T.nilable(::StackOne::Operations::HrisListDepartmentGroupsResponse)](../../models/operations/hrislistdepartmentgroupsresponse.md)** + + ## list_employee_categories List Employee Document Categories diff --git a/docs/sdks/marketing/README.md b/docs/sdks/marketing/README.md index 93990a5e..18d60ae3 100644 --- a/docs/sdks/marketing/README.md +++ b/docs/sdks/marketing/README.md @@ -3,21 +3,68 @@ ### Available Operations +* [create_content_block](#create_content_block) - Create Content Block * [create_email_template](#create_email_template) - Create email template * [create_omni_channel_template](#create_omni_channel_template) - Create omni-channel template * [create_push_template](#create_push_template) - Create push template * [get_campaign](#get_campaign) - Get campaign +* [get_content_block](#get_content_block) - Get Content Blocks * [get_email_template](#get_email_template) - Get email template * [get_omni_channel_template](#get_omni_channel_template) - Get omni-channel template * [get_push_template](#get_push_template) - Get push template * [list_campaigns](#list_campaigns) - List campaigns +* [list_content_blocks](#list_content_blocks) - List Content Blocks * [list_email_templates](#list_email_templates) - List email templates * [list_omni_channel_templates](#list_omni_channel_templates) - List omni-channel templates * [list_push_templates](#list_push_templates) - List push templates +* [update_content_block](#update_content_block) - Update email template * [update_email_template](#update_email_template) - Update email template * [update_omni_channel_template](#update_omni_channel_template) - Update omni-channel template * [update_push_template](#update_push_template) - Update push template +## create_content_block + +Create Content Block + +### Example Usage + +```ruby +require 'stackone_client' + + +s = ::StackOne::StackOne.new +s.config_security( + ::StackOne::Shared::Security.new( + password: "", + ) +) + + +res = s.marketing.create_content_block(marketing_create_content_blocks_request_dto=::StackOne::Shared::MarketingCreateContentBlocksRequestDto.new( + passthrough: { + "Bike": "", + }, + ), x_account_id="") + +if ! res.create_result.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `marketing_create_content_blocks_request_dto` | [::StackOne::Shared::MarketingCreateContentBlocksRequestDto](../../models/shared/marketingcreatecontentblocksrequestdto.md) | :heavy_check_mark: | N/A | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | + + +### Response + +**[T.nilable(::StackOne::Operations::MarketingCreateContentBlockResponse)](../../models/operations/marketingcreatecontentblockresponse.md)** + + ## create_email_template Create email template @@ -218,6 +265,50 @@ end **[T.nilable(::StackOne::Operations::MarketingGetCampaignResponse)](../../models/operations/marketinggetcampaignresponse.md)** +## get_content_block + +Get Content Blocks + +### Example Usage + +```ruby +require 'stackone_client' + + +s = ::StackOne::StackOne.new +s.config_security( + ::StackOne::Shared::Security.new( + password: "", + ) +) + + +req = ::StackOne::Operations::MarketingGetContentBlockRequest.new( + fields_: "id,remote_id,name,type,content,status,tags,created_at,updated_at", + id: "", + x_account_id: "", +) + +res = s.marketing.get_content_block(req) + +if ! res.content_blocks_paginated.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `request` | [::StackOne::Operations::MarketingGetContentBlockRequest](../../models/operations/marketinggetcontentblockrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[T.nilable(::StackOne::Operations::MarketingGetContentBlockResponse)](../../models/operations/marketinggetcontentblockresponse.md)** + + ## get_email_template Get email template @@ -396,6 +487,52 @@ end **[T.nilable(::StackOne::Operations::MarketingListCampaignsResponse)](../../models/operations/marketinglistcampaignsresponse.md)** +## list_content_blocks + +List Content Blocks + +### Example Usage + +```ruby +require 'stackone_client' + + +s = ::StackOne::StackOne.new +s.config_security( + ::StackOne::Shared::Security.new( + password: "", + ) +) + + +req = ::StackOne::Operations::MarketingListContentBlocksRequest.new( + fields_: "id,remote_id,name,type,content,status,tags,created_at,updated_at", + filter: ::StackOne::Operations::MarketingListContentBlocksQueryParamFilter.new( + updated_after: "2020-01-01T00:00:00.000Z", + ), + x_account_id: "", +) + +res = s.marketing.list_content_blocks(req) + +if ! res.content_blocks_paginated.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `request` | [::StackOne::Operations::MarketingListContentBlocksRequest](../../models/operations/marketinglistcontentblocksrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[T.nilable(::StackOne::Operations::MarketingListContentBlocksResponse)](../../models/operations/marketinglistcontentblocksresponse.md)** + + ## list_email_templates List email templates @@ -534,6 +671,50 @@ end **[T.nilable(::StackOne::Operations::MarketingListPushTemplatesResponse)](../../models/operations/marketinglistpushtemplatesresponse.md)** +## update_content_block + +Update email template + +### Example Usage + +```ruby +require 'stackone_client' + + +s = ::StackOne::StackOne.new +s.config_security( + ::StackOne::Shared::Security.new( + password: "", + ) +) + + +res = s.marketing.update_content_block(marketing_create_content_blocks_request_dto=::StackOne::Shared::MarketingCreateContentBlocksRequestDto.new( + passthrough: { + "Pickup": "", + }, + ), id="", x_account_id="") + +if ! res.create_result.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `marketing_create_content_blocks_request_dto` | [::StackOne::Shared::MarketingCreateContentBlocksRequestDto](../../models/shared/marketingcreatecontentblocksrequestdto.md) | :heavy_check_mark: | N/A | +| `id` | *::String* | :heavy_check_mark: | N/A | +| `x_account_id` | *::String* | :heavy_check_mark: | The account identifier | + + +### Response + +**[T.nilable(::StackOne::Operations::MarketingUpdateContentBlockResponse)](../../models/operations/marketingupdatecontentblockresponse.md)** + + ## update_email_template Update email template diff --git a/gen.yaml b/gen.yaml index e10c24a6..593213eb 100644 --- a/gen.yaml +++ b/gen.yaml @@ -11,7 +11,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false ruby: - version: 0.2.32 + version: 0.2.33 author: StackOne description: Ruby Client SDK Generated by Speakeasy imports: diff --git a/lib/stack_one/hris.rb b/lib/stack_one/hris.rb index a627fb8c..365a85ba 100644 --- a/lib/stack_one/hris.rb +++ b/lib/stack_one/hris.rb @@ -334,6 +334,44 @@ def get_company(request) end + sig { params(request: T.nilable(::StackOne::Operations::HrisGetDepartmentGroupRequest)).returns(::StackOne::Operations::HrisGetDepartmentGroupResponse) } + def get_department_group(request) + # get_department_group - Get Department Group + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + ::StackOne::Operations::HrisGetDepartmentGroupRequest, + base_url, + '/unified/hris/groups/departments/{id}', + request + ) + headers = Utils.get_headers(request) + query_params = Utils.get_query_params(::StackOne::Operations::HrisGetDepartmentGroupRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::StackOne::Operations::HrisGetDepartmentGroupResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::HRISDepartmentsResult) + res.hris_departments_result = out + end + elsif [400, 403, 412, 429, 500, 501].include?(r.status) + end + res + end + + sig { params(request: T.nilable(::StackOne::Operations::HrisGetEmployeeRequest)).returns(::StackOne::Operations::HrisGetEmployeeResponse) } def get_employee(request) # get_employee - Get Employee @@ -780,6 +818,39 @@ def list_companies(request) end + sig { params(request: T.nilable(::StackOne::Operations::HrisListDepartmentGroupsRequest)).returns(::StackOne::Operations::HrisListDepartmentGroupsResponse) } + def list_department_groups(request) + # list_department_groups - List Department Groups + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/unified/hris/groups/departments" + headers = Utils.get_headers(request) + query_params = Utils.get_query_params(::StackOne::Operations::HrisListDepartmentGroupsRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::StackOne::Operations::HrisListDepartmentGroupsResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::HRISDepartmentsPaginated) + res.hris_departments_paginated = out + end + elsif [400, 403, 412, 429, 500, 501].include?(r.status) + end + res + end + + sig { params(request: T.nilable(::StackOne::Operations::HrisListEmployeeCategoriesRequest)).returns(::StackOne::Operations::HrisListEmployeeCategoriesResponse) } def list_employee_categories(request) # list_employee_categories - List Employee Document Categories diff --git a/lib/stack_one/marketing.rb b/lib/stack_one/marketing.rb index ebcb86e3..af11b607 100644 --- a/lib/stack_one/marketing.rb +++ b/lib/stack_one/marketing.rb @@ -19,6 +19,52 @@ def initialize(sdk_config) end + sig { params(marketing_create_content_blocks_request_dto: ::StackOne::Shared::MarketingCreateContentBlocksRequestDto, x_account_id: ::String).returns(::StackOne::Operations::MarketingCreateContentBlockResponse) } + def create_content_block(marketing_create_content_blocks_request_dto, x_account_id) + # create_content_block - Create Content Block + request = ::StackOne::Operations::MarketingCreateContentBlockRequest.new( + + marketing_create_content_blocks_request_dto: marketing_create_content_blocks_request_dto, + x_account_id: x_account_id + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/unified/marketing/content_blocks" + headers = Utils.get_headers(request) + req_content_type, data, form = Utils.serialize_request_body(request, :marketing_create_content_blocks_request_dto, :json) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::StackOne::Operations::MarketingCreateContentBlockResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 201 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::CreateResult) + res.create_result = out + end + elsif [400, 403, 412, 429, 500, 501].include?(r.status) + end + res + end + + sig { params(marketing_create_email_template_request_dto: ::StackOne::Shared::MarketingCreateEmailTemplateRequestDto, x_account_id: ::String).returns(::StackOne::Operations::MarketingCreateEmailTemplateResponse) } def create_email_template(marketing_create_email_template_request_dto, x_account_id) # create_email_template - Create email template @@ -195,6 +241,44 @@ def get_campaign(request) end + sig { params(request: T.nilable(::StackOne::Operations::MarketingGetContentBlockRequest)).returns(::StackOne::Operations::MarketingGetContentBlockResponse) } + def get_content_block(request) + # get_content_block - Get Content Blocks + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + ::StackOne::Operations::MarketingGetContentBlockRequest, + base_url, + '/unified/marketing/content_blocks/{id}', + request + ) + headers = Utils.get_headers(request) + query_params = Utils.get_query_params(::StackOne::Operations::MarketingGetContentBlockRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::StackOne::Operations::MarketingGetContentBlockResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::ContentBlocksPaginated) + res.content_blocks_paginated = out + end + elsif [400, 403, 412, 429, 500, 501].include?(r.status) + end + res + end + + sig { params(request: T.nilable(::StackOne::Operations::MarketingGetEmailTemplateRequest)).returns(::StackOne::Operations::MarketingGetEmailTemplateResponse) } def get_email_template(request) # get_email_template - Get email template @@ -342,6 +426,39 @@ def list_campaigns(request) end + sig { params(request: T.nilable(::StackOne::Operations::MarketingListContentBlocksRequest)).returns(::StackOne::Operations::MarketingListContentBlocksResponse) } + def list_content_blocks(request) + # list_content_blocks - List Content Blocks + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/unified/marketing/content_blocks" + headers = Utils.get_headers(request) + query_params = Utils.get_query_params(::StackOne::Operations::MarketingListContentBlocksRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::StackOne::Operations::MarketingListContentBlocksResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::ContentBlocksPaginated) + res.content_blocks_paginated = out + end + elsif [400, 403, 412, 429, 500, 501].include?(r.status) + end + res + end + + sig { params(request: T.nilable(::StackOne::Operations::MarketingListEmailTemplatesRequest)).returns(::StackOne::Operations::MarketingListEmailTemplatesResponse) } def list_email_templates(request) # list_email_templates - List email templates @@ -441,6 +558,58 @@ def list_push_templates(request) end + sig { params(marketing_create_content_blocks_request_dto: ::StackOne::Shared::MarketingCreateContentBlocksRequestDto, id: ::String, x_account_id: ::String).returns(::StackOne::Operations::MarketingUpdateContentBlockResponse) } + def update_content_block(marketing_create_content_blocks_request_dto, id, x_account_id) + # update_content_block - Update email template + request = ::StackOne::Operations::MarketingUpdateContentBlockRequest.new( + + marketing_create_content_blocks_request_dto: marketing_create_content_blocks_request_dto, + id: id, + x_account_id: x_account_id + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + ::StackOne::Operations::MarketingUpdateContentBlockRequest, + base_url, + '/unified/marketing/content_blocks/{id}', + request + ) + headers = Utils.get_headers(request) + req_content_type, data, form = Utils.serialize_request_body(request, :marketing_create_content_blocks_request_dto, :json) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.patch(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::StackOne::Operations::MarketingUpdateContentBlockResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::CreateResult) + res.create_result = out + end + elsif [400, 403, 412, 429, 500, 501].include?(r.status) + end + res + end + + sig { params(marketing_create_email_template_request_dto: ::StackOne::Shared::MarketingCreateEmailTemplateRequestDto, id: ::String, x_account_id: ::String).returns(::StackOne::Operations::MarketingUpdateEmailTemplateResponse) } def update_email_template(marketing_create_email_template_request_dto, id, x_account_id) # update_email_template - Update email template diff --git a/lib/stack_one/models/operations.rb b/lib/stack_one/models/operations.rb index e4b07a92..8805710a 100644 --- a/lib/stack_one/models/operations.rb +++ b/lib/stack_one/models/operations.rb @@ -155,6 +155,8 @@ module Operations autoload :HrisGetBenefitResponse, 'stack_one/models/operations/hris_get_benefit_response.rb' autoload :HrisGetCompanyRequest, 'stack_one/models/operations/hris_get_company_request.rb' autoload :HrisGetCompanyResponse, 'stack_one/models/operations/hris_get_company_response.rb' + autoload :HrisGetDepartmentGroupRequest, 'stack_one/models/operations/hris_get_department_group_request.rb' + autoload :HrisGetDepartmentGroupResponse, 'stack_one/models/operations/hris_get_department_group_response.rb' autoload :HrisGetEmployeeRequest, 'stack_one/models/operations/hris_get_employee_request.rb' autoload :HrisGetEmployeeResponse, 'stack_one/models/operations/hris_get_employee_response.rb' autoload :HrisGetEmployeeDocumentRequest, 'stack_one/models/operations/hris_get_employee_document_request.rb' @@ -181,6 +183,9 @@ module Operations autoload :HrisListCompaniesQueryParamFilter, 'stack_one/models/operations/hris_list_companies_queryparam_filter.rb' autoload :HrisListCompaniesRequest, 'stack_one/models/operations/hris_list_companies_request.rb' autoload :HrisListCompaniesResponse, 'stack_one/models/operations/hris_list_companies_response.rb' + autoload :HrisListDepartmentGroupsQueryParamFilter, 'stack_one/models/operations/hris_list_department_groups_queryparam_filter.rb' + autoload :HrisListDepartmentGroupsRequest, 'stack_one/models/operations/hris_list_department_groups_request.rb' + autoload :HrisListDepartmentGroupsResponse, 'stack_one/models/operations/hris_list_department_groups_response.rb' autoload :HrisListEmployeeCategoriesQueryParamFilter, 'stack_one/models/operations/hris_list_employee_categories_queryparam_filter.rb' autoload :HrisListEmployeeCategoriesRequest, 'stack_one/models/operations/hris_list_employee_categories_request.rb' autoload :HrisListEmployeeCategoriesResponse, 'stack_one/models/operations/hris_list_employee_categories_response.rb' @@ -219,6 +224,8 @@ module Operations autoload :HrisUpdateTimeOffRequestResponse, 'stack_one/models/operations/hris_update_time_off_request_response.rb' autoload :HrisUploadEmployeeDocumentRequest, 'stack_one/models/operations/hris_upload_employee_document_request.rb' autoload :HrisUploadEmployeeDocumentResponse, 'stack_one/models/operations/hris_upload_employee_document_response.rb' + autoload :MarketingCreateContentBlockRequest, 'stack_one/models/operations/marketing_create_content_block_request.rb' + autoload :MarketingCreateContentBlockResponse, 'stack_one/models/operations/marketing_create_content_block_response.rb' autoload :MarketingCreateEmailTemplateRequest, 'stack_one/models/operations/marketing_create_email_template_request.rb' autoload :MarketingCreateEmailTemplateResponse, 'stack_one/models/operations/marketing_create_email_template_response.rb' autoload :MarketingCreateOmniChannelTemplateRequest, 'stack_one/models/operations/marketing_create_omni_channel_template_request.rb' @@ -227,6 +234,8 @@ module Operations autoload :MarketingCreatePushTemplateResponse, 'stack_one/models/operations/marketing_create_push_template_response.rb' autoload :MarketingGetCampaignRequest, 'stack_one/models/operations/marketing_get_campaign_request.rb' autoload :MarketingGetCampaignResponse, 'stack_one/models/operations/marketing_get_campaign_response.rb' + autoload :MarketingGetContentBlockRequest, 'stack_one/models/operations/marketing_get_content_block_request.rb' + autoload :MarketingGetContentBlockResponse, 'stack_one/models/operations/marketing_get_content_block_response.rb' autoload :MarketingGetEmailTemplateRequest, 'stack_one/models/operations/marketing_get_email_template_request.rb' autoload :MarketingGetEmailTemplateResponse, 'stack_one/models/operations/marketing_get_email_template_response.rb' autoload :MarketingGetOmniChannelTemplateRequest, 'stack_one/models/operations/marketing_get_omni_channel_template_request.rb' @@ -236,6 +245,9 @@ module Operations autoload :MarketingListCampaignsQueryParamFilter, 'stack_one/models/operations/marketing_list_campaigns_queryparam_filter.rb' autoload :MarketingListCampaignsRequest, 'stack_one/models/operations/marketing_list_campaigns_request.rb' autoload :MarketingListCampaignsResponse, 'stack_one/models/operations/marketing_list_campaigns_response.rb' + autoload :MarketingListContentBlocksQueryParamFilter, 'stack_one/models/operations/marketing_list_content_blocks_queryparam_filter.rb' + autoload :MarketingListContentBlocksRequest, 'stack_one/models/operations/marketing_list_content_blocks_request.rb' + autoload :MarketingListContentBlocksResponse, 'stack_one/models/operations/marketing_list_content_blocks_response.rb' autoload :MarketingListEmailTemplatesQueryParamFilter, 'stack_one/models/operations/marketing_list_email_templates_queryparam_filter.rb' autoload :MarketingListEmailTemplatesRequest, 'stack_one/models/operations/marketing_list_email_templates_request.rb' autoload :MarketingListEmailTemplatesResponse, 'stack_one/models/operations/marketing_list_email_templates_response.rb' @@ -245,6 +257,8 @@ module Operations autoload :MarketingListPushTemplatesQueryParamFilter, 'stack_one/models/operations/marketing_list_push_templates_queryparam_filter.rb' autoload :MarketingListPushTemplatesRequest, 'stack_one/models/operations/marketing_list_push_templates_request.rb' autoload :MarketingListPushTemplatesResponse, 'stack_one/models/operations/marketing_list_push_templates_response.rb' + autoload :MarketingUpdateContentBlockRequest, 'stack_one/models/operations/marketing_update_content_block_request.rb' + autoload :MarketingUpdateContentBlockResponse, 'stack_one/models/operations/marketing_update_content_block_response.rb' autoload :MarketingUpdateEmailTemplateRequest, 'stack_one/models/operations/marketing_update_email_template_request.rb' autoload :MarketingUpdateEmailTemplateResponse, 'stack_one/models/operations/marketing_update_email_template_response.rb' autoload :MarketingUpdateOmniChannelTemplateRequest, 'stack_one/models/operations/marketing_update_omni_channel_template_request.rb' diff --git a/lib/stack_one/models/operations/ats_get_candidate_request.rb b/lib/stack_one/models/operations/ats_get_candidate_request.rb index 5151f75f..b039bf43 100644 --- a/lib/stack_one/models/operations/ats_get_candidate_request.rb +++ b/lib/stack_one/models/operations/ats_get_candidate_request.rb @@ -17,17 +17,20 @@ class AtsGetCandidateRequest < ::StackOne::Utils::FieldAugmented field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } # The comma separated list of fields that will be returned in the response (if empty, all fields are returned) field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } } + # The comma separated list of fields that will be included in the response + field :include, T.nilable(::String), { 'query_param': { 'field_name': 'include', 'style': 'form', 'explode': true } } # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } } # Indicates that the raw request result is returned field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } } - sig { params(id: ::String, x_account_id: ::String, fields_: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean)).void } - def initialize(id: nil, x_account_id: nil, fields_: nil, proxy: nil, raw: nil) + sig { params(id: ::String, x_account_id: ::String, fields_: T.nilable(::String), include: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean)).void } + def initialize(id: nil, x_account_id: nil, fields_: nil, include: nil, proxy: nil, raw: nil) @id = id @x_account_id = x_account_id @fields_ = fields_ + @include = include @proxy = proxy @raw = raw end diff --git a/lib/stack_one/models/operations/ats_list_candidates_request.rb b/lib/stack_one/models/operations/ats_list_candidates_request.rb index 98f817f2..a4998c31 100644 --- a/lib/stack_one/models/operations/ats_list_candidates_request.rb +++ b/lib/stack_one/models/operations/ats_list_candidates_request.rb @@ -17,6 +17,8 @@ class AtsListCandidatesRequest < ::StackOne::Utils::FieldAugmented field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } } # ATS Candidate Filter field :filter, T.nilable(::StackOne::Operations::AtsListCandidatesQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'deepObject', 'explode': true } } + # The comma separated list of fields that will be included in the response + field :include, T.nilable(::String), { 'query_param': { 'field_name': 'include', 'style': 'form', 'explode': true } } # The unified cursor field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } } # The page number of the results to fetch @@ -39,11 +41,12 @@ class AtsListCandidatesRequest < ::StackOne::Utils::FieldAugmented field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } - sig { params(x_account_id: ::String, fields_: T.nilable(::String), filter: T.nilable(::StackOne::Operations::AtsListCandidatesQueryParamFilter), next_: T.nilable(::String), page: T.nilable(::String), page_size: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean), sync_token: T.nilable(::String), updated_after: T.nilable(::String)).void } - def initialize(x_account_id: nil, fields_: nil, filter: nil, next_: nil, page: nil, page_size: nil, proxy: nil, raw: nil, sync_token: nil, updated_after: nil) + sig { params(x_account_id: ::String, fields_: T.nilable(::String), filter: T.nilable(::StackOne::Operations::AtsListCandidatesQueryParamFilter), include: T.nilable(::String), next_: T.nilable(::String), page: T.nilable(::String), page_size: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean), sync_token: T.nilable(::String), updated_after: T.nilable(::String)).void } + def initialize(x_account_id: nil, fields_: nil, filter: nil, include: nil, next_: nil, page: nil, page_size: nil, proxy: nil, raw: nil, sync_token: nil, updated_after: nil) @x_account_id = x_account_id @fields_ = fields_ @filter = filter + @include = include @next_ = next_ @page = page @page_size = page_size diff --git a/lib/stack_one/models/operations/hris_get_department_group_request.rb b/lib/stack_one/models/operations/hris_get_department_group_request.rb new file mode 100644 index 00000000..6b7ceb9d --- /dev/null +++ b/lib/stack_one/models/operations/hris_get_department_group_request.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class HrisGetDepartmentGroupRequest < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } } + # The account identifier + field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } + # The comma separated list of fields that will be returned in the response (if empty, all fields are returned) + field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } } + # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key + field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } } + # Indicates that the raw request result is returned + field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } } + + + sig { params(id: ::String, x_account_id: ::String, fields_: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean)).void } + def initialize(id: nil, x_account_id: nil, fields_: nil, proxy: nil, raw: nil) + @id = id + @x_account_id = x_account_id + @fields_ = fields_ + @proxy = proxy + @raw = raw + end + end + end +end diff --git a/lib/stack_one/models/operations/hris_get_department_group_response.rb b/lib/stack_one/models/operations/hris_get_department_group_response.rb new file mode 100644 index 00000000..52725324 --- /dev/null +++ b/lib/stack_one/models/operations/hris_get_department_group_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class HrisGetDepartmentGroupResponse < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # The department group with the given identifier was retrieved. + field :hris_departments_result, T.nilable(::StackOne::Shared::HRISDepartmentsResult) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, hris_departments_result: T.nilable(::StackOne::Shared::HRISDepartmentsResult)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, hris_departments_result: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @hris_departments_result = hris_departments_result + end + end + end +end diff --git a/lib/stack_one/models/operations/hris_list_department_groups_queryparam_filter.rb b/lib/stack_one/models/operations/hris_list_department_groups_queryparam_filter.rb new file mode 100644 index 00000000..b08e93b7 --- /dev/null +++ b/lib/stack_one/models/operations/hris_list_department_groups_queryparam_filter.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + # Filter parameters that allow greater customisation of the list response + class HrisListDepartmentGroupsQueryParamFilter < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # Use a string with a date to only select results updated after that given date + field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } } + + + sig { params(updated_after: T.nilable(::String)).void } + def initialize(updated_after: nil) + @updated_after = updated_after + end + end + end +end diff --git a/lib/stack_one/models/operations/hris_list_department_groups_request.rb b/lib/stack_one/models/operations/hris_list_department_groups_request.rb new file mode 100644 index 00000000..28ec5aa8 --- /dev/null +++ b/lib/stack_one/models/operations/hris_list_department_groups_request.rb @@ -0,0 +1,52 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class HrisListDepartmentGroupsRequest < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # The account identifier + field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } + # The comma separated list of fields that will be returned in the response (if empty, all fields are returned) + field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } } + # Filter parameters that allow greater customisation of the list response + field :filter, T.nilable(::StackOne::Operations::HrisListDepartmentGroupsQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'deepObject', 'explode': true } } + # The unified cursor + field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } } + # The page number of the results to fetch + # + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :page, T.nilable(::String), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } } + # The number of results per page + field :page_size, T.nilable(::String), { 'query_param': { 'field_name': 'page_size', 'style': 'form', 'explode': true } } + # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key + field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } } + # Indicates that the raw request result is returned + field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } } + # Use a string with a date to only select results updated after that given date + # + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } + + + sig { params(x_account_id: ::String, fields_: T.nilable(::String), filter: T.nilable(::StackOne::Operations::HrisListDepartmentGroupsQueryParamFilter), next_: T.nilable(::String), page: T.nilable(::String), page_size: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean), updated_after: T.nilable(::String)).void } + def initialize(x_account_id: nil, fields_: nil, filter: nil, next_: nil, page: nil, page_size: nil, proxy: nil, raw: nil, updated_after: nil) + @x_account_id = x_account_id + @fields_ = fields_ + @filter = filter + @next_ = next_ + @page = page + @page_size = page_size + @proxy = proxy + @raw = raw + @updated_after = updated_after + end + end + end +end diff --git a/lib/stack_one/models/operations/hris_list_department_groups_response.rb b/lib/stack_one/models/operations/hris_list_department_groups_response.rb new file mode 100644 index 00000000..f00cae30 --- /dev/null +++ b/lib/stack_one/models/operations/hris_list_department_groups_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class HrisListDepartmentGroupsResponse < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # The list of department groups was retrieved. + field :hris_departments_paginated, T.nilable(::StackOne::Shared::HRISDepartmentsPaginated) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, hris_departments_paginated: T.nilable(::StackOne::Shared::HRISDepartmentsPaginated)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, hris_departments_paginated: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @hris_departments_paginated = hris_departments_paginated + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_create_content_block_request.rb b/lib/stack_one/models/operations/marketing_create_content_block_request.rb new file mode 100644 index 00000000..f4c84745 --- /dev/null +++ b/lib/stack_one/models/operations/marketing_create_content_block_request.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingCreateContentBlockRequest < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :marketing_create_content_blocks_request_dto, ::StackOne::Shared::MarketingCreateContentBlocksRequestDto, { 'request': { 'media_type': 'application/json' } } + # The account identifier + field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } + + + sig { params(marketing_create_content_blocks_request_dto: ::StackOne::Shared::MarketingCreateContentBlocksRequestDto, x_account_id: ::String).void } + def initialize(marketing_create_content_blocks_request_dto: nil, x_account_id: nil) + @marketing_create_content_blocks_request_dto = marketing_create_content_blocks_request_dto + @x_account_id = x_account_id + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_create_content_block_response.rb b/lib/stack_one/models/operations/marketing_create_content_block_response.rb new file mode 100644 index 00000000..7b5715b4 --- /dev/null +++ b/lib/stack_one/models/operations/marketing_create_content_block_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingCreateContentBlockResponse < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Record created successfully. + field :create_result, T.nilable(::StackOne::Shared::CreateResult) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, create_result: T.nilable(::StackOne::Shared::CreateResult)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, create_result: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @create_result = create_result + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_get_content_block_request.rb b/lib/stack_one/models/operations/marketing_get_content_block_request.rb new file mode 100644 index 00000000..c7c7ea79 --- /dev/null +++ b/lib/stack_one/models/operations/marketing_get_content_block_request.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingGetContentBlockRequest < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } } + # The account identifier + field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } + # The comma separated list of fields that will be returned in the response (if empty, all fields are returned) + field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } } + # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key + field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } } + # Indicates that the raw request result is returned + field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } } + + + sig { params(id: ::String, x_account_id: ::String, fields_: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean)).void } + def initialize(id: nil, x_account_id: nil, fields_: nil, proxy: nil, raw: nil) + @id = id + @x_account_id = x_account_id + @fields_ = fields_ + @proxy = proxy + @raw = raw + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_get_content_block_response.rb b/lib/stack_one/models/operations/marketing_get_content_block_response.rb new file mode 100644 index 00000000..09e67347 --- /dev/null +++ b/lib/stack_one/models/operations/marketing_get_content_block_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingGetContentBlockResponse < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # The Content Block with the given identifier was retrieved + field :content_blocks_paginated, T.nilable(::StackOne::Shared::ContentBlocksPaginated) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, content_blocks_paginated: T.nilable(::StackOne::Shared::ContentBlocksPaginated)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, content_blocks_paginated: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @content_blocks_paginated = content_blocks_paginated + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_list_content_blocks_queryparam_filter.rb b/lib/stack_one/models/operations/marketing_list_content_blocks_queryparam_filter.rb new file mode 100644 index 00000000..faf8cd41 --- /dev/null +++ b/lib/stack_one/models/operations/marketing_list_content_blocks_queryparam_filter.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + # Filter parameters that allow greater customisation of the list response + class MarketingListContentBlocksQueryParamFilter < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # Use a string with a date to only select results updated after that given date + field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } } + + + sig { params(updated_after: T.nilable(::String)).void } + def initialize(updated_after: nil) + @updated_after = updated_after + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_list_content_blocks_request.rb b/lib/stack_one/models/operations/marketing_list_content_blocks_request.rb new file mode 100644 index 00000000..6564e5ff --- /dev/null +++ b/lib/stack_one/models/operations/marketing_list_content_blocks_request.rb @@ -0,0 +1,52 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingListContentBlocksRequest < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # The account identifier + field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } + # The comma separated list of fields that will be returned in the response (if empty, all fields are returned) + field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } } + # Filter parameters that allow greater customisation of the list response + field :filter, T.nilable(::StackOne::Operations::MarketingListContentBlocksQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'deepObject', 'explode': true } } + # The unified cursor + field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } } + # The page number of the results to fetch + # + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :page, T.nilable(::String), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } } + # The number of results per page + field :page_size, T.nilable(::String), { 'query_param': { 'field_name': 'page_size', 'style': 'form', 'explode': true } } + # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key + field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } } + # Indicates that the raw request result is returned + field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } } + # Use a string with a date to only select results updated after that given date + # + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } } + + + sig { params(x_account_id: ::String, fields_: T.nilable(::String), filter: T.nilable(::StackOne::Operations::MarketingListContentBlocksQueryParamFilter), next_: T.nilable(::String), page: T.nilable(::String), page_size: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean), updated_after: T.nilable(::String)).void } + def initialize(x_account_id: nil, fields_: nil, filter: nil, next_: nil, page: nil, page_size: nil, proxy: nil, raw: nil, updated_after: nil) + @x_account_id = x_account_id + @fields_ = fields_ + @filter = filter + @next_ = next_ + @page = page + @page_size = page_size + @proxy = proxy + @raw = raw + @updated_after = updated_after + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_list_content_blocks_response.rb b/lib/stack_one/models/operations/marketing_list_content_blocks_response.rb new file mode 100644 index 00000000..2f11a30d --- /dev/null +++ b/lib/stack_one/models/operations/marketing_list_content_blocks_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingListContentBlocksResponse < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # The list of Content Blocks was retrieved. + field :content_blocks_paginated, T.nilable(::StackOne::Shared::ContentBlocksPaginated) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, content_blocks_paginated: T.nilable(::StackOne::Shared::ContentBlocksPaginated)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, content_blocks_paginated: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @content_blocks_paginated = content_blocks_paginated + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_update_content_block_request.rb b/lib/stack_one/models/operations/marketing_update_content_block_request.rb new file mode 100644 index 00000000..b05bd24e --- /dev/null +++ b/lib/stack_one/models/operations/marketing_update_content_block_request.rb @@ -0,0 +1,30 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingUpdateContentBlockRequest < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } } + + field :marketing_create_content_blocks_request_dto, ::StackOne::Shared::MarketingCreateContentBlocksRequestDto, { 'request': { 'media_type': 'application/json' } } + # The account identifier + field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } } + + + sig { params(id: ::String, marketing_create_content_blocks_request_dto: ::StackOne::Shared::MarketingCreateContentBlocksRequestDto, x_account_id: ::String).void } + def initialize(id: nil, marketing_create_content_blocks_request_dto: nil, x_account_id: nil) + @id = id + @marketing_create_content_blocks_request_dto = marketing_create_content_blocks_request_dto + @x_account_id = x_account_id + end + end + end +end diff --git a/lib/stack_one/models/operations/marketing_update_content_block_response.rb b/lib/stack_one/models/operations/marketing_update_content_block_response.rb new file mode 100644 index 00000000..4e954792 --- /dev/null +++ b/lib/stack_one/models/operations/marketing_update_content_block_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Operations + + + class MarketingUpdateContentBlockResponse < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Record updated successfully + field :create_result, T.nilable(::StackOne::Shared::CreateResult) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, create_result: T.nilable(::StackOne::Shared::CreateResult)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, create_result: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @create_result = create_result + end + end + end +end diff --git a/lib/stack_one/models/shared.rb b/lib/stack_one/models/shared.rb index 025dda3c..80eda421 100644 --- a/lib/stack_one/models/shared.rb +++ b/lib/stack_one/models/shared.rb @@ -89,6 +89,9 @@ module Shared autoload :AssessmentsPackages, 'stack_one/models/shared/assessmentspackages.rb' autoload :CandidateResult, 'stack_one/models/shared/candidateresult.rb' autoload :Candidate, 'stack_one/models/shared/candidate.rb' + autoload :CandidateCustomFieldsValue, 'stack_one/models/shared/candidatecustomfields_value.rb' + autoload :CandidateCustomFieldsType, 'stack_one/models/shared/candidatecustomfields_type.rb' + autoload :CandidateCustomFields, 'stack_one/models/shared/candidatecustomfields.rb' autoload :NoteResult, 'stack_one/models/shared/noteresult.rb' autoload :NoteValue, 'stack_one/models/shared/note_value.rb' autoload :NoteVisibility, 'stack_one/models/shared/note_visibility.rb' @@ -252,6 +255,10 @@ module Shared autoload :HRISBenefitResult, 'stack_one/models/shared/hrisbenefitresult.rb' autoload :CompanyResult, 'stack_one/models/shared/companyresult.rb' autoload :Company, 'stack_one/models/shared/company.rb' + autoload :HRISDepartmentsResult, 'stack_one/models/shared/hrisdepartmentsresult.rb' + autoload :HRISDepartmentValue, 'stack_one/models/shared/hrisdepartment_value.rb' + autoload :HRISDepartmentType, 'stack_one/models/shared/hrisdepartment_type.rb' + autoload :HRISDepartment, 'stack_one/models/shared/hrisdepartment.rb' autoload :EmployeeResult, 'stack_one/models/shared/employeeresult.rb' autoload :Avatar, 'stack_one/models/shared/avatar.rb' autoload :EmployeeCompany, 'stack_one/models/shared/employee_company.rb' @@ -265,9 +272,6 @@ module Shared autoload :Ethnicity, 'stack_one/models/shared/ethnicity.rb' autoload :EmployeeSchemasGenderValue, 'stack_one/models/shared/employee_schemas_gender_value.rb' autoload :Gender, 'stack_one/models/shared/gender.rb' - autoload :EmployeeSchemasGroupsValue, 'stack_one/models/shared/employee_schemas_groups_value.rb' - autoload :EmployeeType, 'stack_one/models/shared/employee_type.rb' - autoload :Groups, 'stack_one/models/shared/groups.rb' autoload :EmployeeSchemasHomeLocationValue, 'stack_one/models/shared/employee_schemas_home_location_value.rb' autoload :EmployeeCountry, 'stack_one/models/shared/employee_country.rb' autoload :EmployeeSchemasHomeLocationLocationTypeValue, 'stack_one/models/shared/employee_schemas_home_location_location_type_value.rb' @@ -277,7 +281,7 @@ module Shared autoload :EmployeeSchemasMaritalStatusValue, 'stack_one/models/shared/employee_schemas_marital_status_value.rb' autoload :MaritalStatus, 'stack_one/models/shared/marital_status.rb' autoload :EmployeeSchemasNationalIdentityNumberValue, 'stack_one/models/shared/employee_schemas_national_identity_number_value.rb' - autoload :EmployeeSchemasType, 'stack_one/models/shared/employee_schemas_type.rb' + autoload :EmployeeType, 'stack_one/models/shared/employee_type.rb' autoload :NationalIdentityNumber, 'stack_one/models/shared/national_identity_number.rb' autoload :EmployeeSchemasPreferredLanguageValue, 'stack_one/models/shared/employee_schemas_preferred_language_value.rb' autoload :PreferredLanguage, 'stack_one/models/shared/preferred_language.rb' @@ -287,6 +291,9 @@ module Shared autoload :EmployeeSchemasLocationType, 'stack_one/models/shared/employee_schemas_location_type.rb' autoload :WorkLocation, 'stack_one/models/shared/work_location.rb' autoload :Employee, 'stack_one/models/shared/employee.rb' + autoload :HRISGroupValue, 'stack_one/models/shared/hrisgroup_value.rb' + autoload :HRISGroupType, 'stack_one/models/shared/hrisgroup_type.rb' + autoload :HRISGroup, 'stack_one/models/shared/hrisgroup.rb' autoload :CostCenters, 'stack_one/models/shared/costcenters.rb' autoload :HrisDocumentResult, 'stack_one/models/shared/hrisdocumentresult.rb' autoload :HrisDocumentApiModelValue, 'stack_one/models/shared/hrisdocumentapimodel_value.rb' @@ -316,9 +323,6 @@ module Shared autoload :WorkEligibility, 'stack_one/models/shared/workeligibility.rb' autoload :EmploymentResult, 'stack_one/models/shared/employmentresult.rb' autoload :HRISGroupsResult, 'stack_one/models/shared/hrisgroupsresult.rb' - autoload :HRISGroupValue, 'stack_one/models/shared/hrisgroup_value.rb' - autoload :HRISGroupType, 'stack_one/models/shared/hrisgroup_type.rb' - autoload :HRISGroup, 'stack_one/models/shared/hrisgroup.rb' autoload :HRISLocationResult, 'stack_one/models/shared/hrislocationresult.rb' autoload :HRISLocationValue, 'stack_one/models/shared/hrislocation_value.rb' autoload :HRISLocationCountry, 'stack_one/models/shared/hrislocation_country.rb' @@ -327,6 +331,7 @@ module Shared autoload :HRISLocation, 'stack_one/models/shared/hrislocation.rb' autoload :HRISBenefitsPaginated, 'stack_one/models/shared/hrisbenefitspaginated.rb' autoload :CompaniesPaginated, 'stack_one/models/shared/companiespaginated.rb' + autoload :HRISDepartmentsPaginated, 'stack_one/models/shared/hrisdepartmentspaginated.rb' autoload :ReferencePaginated, 'stack_one/models/shared/referencepaginated.rb' autoload :HrisDocumentsPaginated, 'stack_one/models/shared/hrisdocumentspaginated.rb' autoload :TimeOffPaginated, 'stack_one/models/shared/timeoffpaginated.rb' @@ -342,6 +347,7 @@ module Shared autoload :HrisDocumentsUploadRequestDtoSchemasFileFormatValue, 'stack_one/models/shared/hrisdocumentsuploadrequestdto_schemas_file_format_value.rb' autoload :HrisDocumentsUploadRequestDtoFileFormat, 'stack_one/models/shared/hrisdocumentsuploadrequestdto_file_format.rb' autoload :HrisDocumentsUploadRequestDto, 'stack_one/models/shared/hrisdocumentsuploadrequestdto.rb' + autoload :MarketingCreateContentBlocksRequestDto, 'stack_one/models/shared/marketingcreatecontentblocksrequestdto.rb' autoload :MarketingCreateEmailTemplateRequestDto, 'stack_one/models/shared/marketingcreateemailtemplaterequestdto.rb' autoload :MessageContent, 'stack_one/models/shared/message_content.rb' autoload :EmailMessagesValue, 'stack_one/models/shared/emailmessages_value.rb' @@ -364,6 +370,12 @@ module Shared autoload :Campaign, 'stack_one/models/shared/campaign.rb' autoload :Value, 'stack_one/models/shared/value.rb' autoload :ChannelsEnum, 'stack_one/models/shared/channelsenum.rb' + autoload :ContentBlocksPaginated, 'stack_one/models/shared/contentblockspaginated.rb' + autoload :ContentBlockValue, 'stack_one/models/shared/contentblock_value.rb' + autoload :ContentBlockStatus, 'stack_one/models/shared/contentblock_status.rb' + autoload :ContentBlockSchemasValue, 'stack_one/models/shared/contentblock_schemas_value.rb' + autoload :ContentBlockType, 'stack_one/models/shared/contentblock_type.rb' + autoload :ContentBlock, 'stack_one/models/shared/contentblock.rb' autoload :TemplateResult, 'stack_one/models/shared/templateresult.rb' autoload :Template, 'stack_one/models/shared/template.rb' autoload :CampaignsPaginated, 'stack_one/models/shared/campaignspaginated.rb' diff --git a/lib/stack_one/models/shared/candidate.rb b/lib/stack_one/models/shared/candidate.rb index f8415c5a..f963ec76 100644 --- a/lib/stack_one/models/shared/candidate.rb +++ b/lib/stack_one/models/shared/candidate.rb @@ -19,6 +19,8 @@ class Candidate < ::StackOne::Utils::FieldAugmented field :country, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('country') } } # Candidate created date field :created_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(true) } } + # The candidate custom fields + field :custom_fields, T.nilable(T::Array[::StackOne::Shared::CandidateCustomFields]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('custom_fields') } } # Candidate email field :email, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('email') } } # List of candidate emails @@ -51,12 +53,13 @@ class Candidate < ::StackOne::Utils::FieldAugmented field :updated_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(true) } } - sig { params(application_ids: T.nilable(T::Array[::String]), company: T.nilable(::String), country: T.nilable(::String), created_at: T.nilable(::DateTime), email: T.nilable(::String), emails: T.nilable(T::Array[::StackOne::Shared::CandidateEmail]), first_name: T.nilable(::String), hired_at: T.nilable(::DateTime), id: T.nilable(::String), last_name: T.nilable(::String), name: T.nilable(::String), phone: T.nilable(::String), phone_numbers: T.nilable(T::Array[::StackOne::Shared::PhoneNumber]), remote_application_ids: T.nilable(T::Array[::String]), remote_id: T.nilable(::String), social_links: T.nilable(T::Array[::StackOne::Shared::SocialLink]), title: T.nilable(::String), updated_at: T.nilable(::DateTime)).void } - def initialize(application_ids: nil, company: nil, country: nil, created_at: nil, email: nil, emails: nil, first_name: nil, hired_at: nil, id: nil, last_name: nil, name: nil, phone: nil, phone_numbers: nil, remote_application_ids: nil, remote_id: nil, social_links: nil, title: nil, updated_at: nil) + sig { params(application_ids: T.nilable(T::Array[::String]), company: T.nilable(::String), country: T.nilable(::String), created_at: T.nilable(::DateTime), custom_fields: T.nilable(T::Array[::StackOne::Shared::CandidateCustomFields]), email: T.nilable(::String), emails: T.nilable(T::Array[::StackOne::Shared::CandidateEmail]), first_name: T.nilable(::String), hired_at: T.nilable(::DateTime), id: T.nilable(::String), last_name: T.nilable(::String), name: T.nilable(::String), phone: T.nilable(::String), phone_numbers: T.nilable(T::Array[::StackOne::Shared::PhoneNumber]), remote_application_ids: T.nilable(T::Array[::String]), remote_id: T.nilable(::String), social_links: T.nilable(T::Array[::StackOne::Shared::SocialLink]), title: T.nilable(::String), updated_at: T.nilable(::DateTime)).void } + def initialize(application_ids: nil, company: nil, country: nil, created_at: nil, custom_fields: nil, email: nil, emails: nil, first_name: nil, hired_at: nil, id: nil, last_name: nil, name: nil, phone: nil, phone_numbers: nil, remote_application_ids: nil, remote_id: nil, social_links: nil, title: nil, updated_at: nil) @application_ids = application_ids @company = company @country = country @created_at = created_at + @custom_fields = custom_fields @email = email @emails = emails @first_name = first_name diff --git a/lib/stack_one/models/shared/candidatecustomfields.rb b/lib/stack_one/models/shared/candidatecustomfields.rb new file mode 100644 index 00000000..e8b426da --- /dev/null +++ b/lib/stack_one/models/shared/candidatecustomfields.rb @@ -0,0 +1,48 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class CandidateCustomFields < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # The description of the custom field. + field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('description') } } + # Unique identifier + field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } + # The name of the custom field. + field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } } + # An array of possible options for the custom field. + field :options, T.nilable(T::Array[::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('options') } } + # Provider's unique identifier + field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } + # Provider's unique identifier for the value of the custom field. + field :remote_value_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_value_id') } } + # The type of the custom field. + field :type, T.nilable(::StackOne::Shared::CandidateCustomFieldsType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } } + # The value associated with the custom field. + field :value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value') } } + # The unique identifier for the value of the custom field. + field :value_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value_id') } } + + + sig { params(description: T.nilable(::String), id: T.nilable(::String), name: T.nilable(::String), options: T.nilable(T::Array[::Object]), remote_id: T.nilable(::String), remote_value_id: T.nilable(::String), type: T.nilable(::StackOne::Shared::CandidateCustomFieldsType), value: T.nilable(::Object), value_id: T.nilable(::String)).void } + def initialize(description: nil, id: nil, name: nil, options: nil, remote_id: nil, remote_value_id: nil, type: nil, value: nil, value_id: nil) + @description = description + @id = id + @name = name + @options = options + @remote_id = remote_id + @remote_value_id = remote_value_id + @type = type + @value = value + @value_id = value_id + end + end + end +end diff --git a/lib/stack_one/models/shared/employee_schemas_type.rb b/lib/stack_one/models/shared/candidatecustomfields_type.rb similarity index 52% rename from lib/stack_one/models/shared/employee_schemas_type.rb rename to lib/stack_one/models/shared/candidatecustomfields_type.rb index 455c563f..15d3b1ff 100644 --- a/lib/stack_one/models/shared/employee_schemas_type.rb +++ b/lib/stack_one/models/shared/candidatecustomfields_type.rb @@ -7,17 +7,17 @@ module StackOne module Shared - - class EmployeeSchemasType < ::StackOne::Utils::FieldAugmented + # The type of the custom field. + class CandidateCustomFieldsType < ::StackOne::Utils::FieldAugmented extend T::Sig field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } - # The type of the national identity number - field :value, T.nilable(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue, true) } } + + field :value, T.nilable(::StackOne::Shared::CandidateCustomFieldsValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::CandidateCustomFieldsValue, true) } } - sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue)).void } + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::CandidateCustomFieldsValue)).void } def initialize(source_value: nil, value: nil) @source_value = source_value @value = value diff --git a/lib/stack_one/models/shared/employee_schemas_groups_value.rb b/lib/stack_one/models/shared/candidatecustomfields_value.rb similarity index 52% rename from lib/stack_one/models/shared/employee_schemas_groups_value.rb rename to lib/stack_one/models/shared/candidatecustomfields_value.rb index 0e1f902a..9c87c333 100644 --- a/lib/stack_one/models/shared/employee_schemas_groups_value.rb +++ b/lib/stack_one/models/shared/candidatecustomfields_value.rb @@ -8,13 +8,13 @@ module StackOne module Shared - class EmployeeSchemasGroupsValue < T::Enum + class CandidateCustomFieldsValue < T::Enum enums do - WORKSPACE = new('workspace') - TEAM = new('team') - DEPARTMENT = new('department') - GROUP = new('group') - ORGANIZATION = new('organization') + DATE = new('date') + FLOAT = new('float') + INTEGER = new('integer') + LIST = new('list') + TEXT = new('text') UNMAPPED_VALUE = new('unmapped_value') end end diff --git a/lib/stack_one/models/shared/contentblock.rb b/lib/stack_one/models/shared/contentblock.rb new file mode 100644 index 00000000..7edf17c5 --- /dev/null +++ b/lib/stack_one/models/shared/contentblock.rb @@ -0,0 +1,48 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class ContentBlock < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :content, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content') } } + # Date of creation + field :created_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(true) } } + # Unique identifier + field :id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('id') } } + + field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } } + # Provider's unique identifier + field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } + # Stackone enum identifying the status of content block. + field :status, T.nilable(::StackOne::Shared::ContentBlockStatus), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('status') } } + + field :tags, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tags') } } + # Stackone enum identifying the type of content block. + field :type, T.nilable(::StackOne::Shared::ContentBlockType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } } + # Date of last update + field :updated_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(true) } } + + + sig { params(content: T.nilable(::String), created_at: T.nilable(::DateTime), id: T.nilable(::String), name: T.nilable(::String), remote_id: T.nilable(::String), status: T.nilable(::StackOne::Shared::ContentBlockStatus), tags: T.nilable(T::Array[::String]), type: T.nilable(::StackOne::Shared::ContentBlockType), updated_at: T.nilable(::DateTime)).void } + def initialize(content: nil, created_at: nil, id: nil, name: nil, remote_id: nil, status: nil, tags: nil, type: nil, updated_at: nil) + @content = content + @created_at = created_at + @id = id + @name = name + @remote_id = remote_id + @status = status + @tags = tags + @type = type + @updated_at = updated_at + end + end + end +end diff --git a/lib/stack_one/models/shared/contentblock_schemas_value.rb b/lib/stack_one/models/shared/contentblock_schemas_value.rb new file mode 100644 index 00000000..a06cbbd8 --- /dev/null +++ b/lib/stack_one/models/shared/contentblock_schemas_value.rb @@ -0,0 +1,18 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + # ContentBlockSchemasValue - The type of the content blocks. + class ContentBlockSchemasValue < T::Enum + enums do + TEXT = new('text') + end + end + + end +end diff --git a/lib/stack_one/models/shared/contentblock_status.rb b/lib/stack_one/models/shared/contentblock_status.rb new file mode 100644 index 00000000..508f9357 --- /dev/null +++ b/lib/stack_one/models/shared/contentblock_status.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + # Stackone enum identifying the status of content block. + class ContentBlockStatus < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # The source value of the status. + field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } + # The Status of the content blocks. + field :value, T.nilable(::StackOne::Shared::ContentBlockValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::ContentBlockValue, true) } } + + + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::ContentBlockValue)).void } + def initialize(source_value: nil, value: nil) + @source_value = source_value + @value = value + end + end + end +end diff --git a/lib/stack_one/models/shared/contentblock_type.rb b/lib/stack_one/models/shared/contentblock_type.rb new file mode 100644 index 00000000..de426e7b --- /dev/null +++ b/lib/stack_one/models/shared/contentblock_type.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + # Stackone enum identifying the type of content block. + class ContentBlockType < ::StackOne::Utils::FieldAugmented + extend T::Sig + + # The source value of the type. + field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } + # The type of the content blocks. + field :value, T.nilable(::StackOne::Shared::ContentBlockSchemasValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::ContentBlockSchemasValue, true) } } + + + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::ContentBlockSchemasValue)).void } + def initialize(source_value: nil, value: nil) + @source_value = source_value + @value = value + end + end + end +end diff --git a/lib/stack_one/models/shared/contentblock_value.rb b/lib/stack_one/models/shared/contentblock_value.rb new file mode 100644 index 00000000..9f1515cc --- /dev/null +++ b/lib/stack_one/models/shared/contentblock_value.rb @@ -0,0 +1,18 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + # ContentBlockValue - The Status of the content blocks. + class ContentBlockValue < T::Enum + enums do + TEXT = new('text') + end + end + + end +end diff --git a/lib/stack_one/models/shared/contentblockspaginated.rb b/lib/stack_one/models/shared/contentblockspaginated.rb new file mode 100644 index 00000000..1f0d63d2 --- /dev/null +++ b/lib/stack_one/models/shared/contentblockspaginated.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class ContentBlocksPaginated < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :data, T::Array[::StackOne::Shared::ContentBlock], { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + + field :next_, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next') } } + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :next_page, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next_page') } } + + field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } } + + + sig { params(data: T::Array[::StackOne::Shared::ContentBlock], next_: T.nilable(::String), next_page: T.nilable(::String), raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + def initialize(data: nil, next_: nil, next_page: nil, raw: nil) + @data = data + @next_ = next_ + @next_page = next_page + @raw = raw + end + end + end +end diff --git a/lib/stack_one/models/shared/employee.rb b/lib/stack_one/models/shared/employee.rb index 2abe1b17..ca43aa16 100644 --- a/lib/stack_one/models/shared/employee.rb +++ b/lib/stack_one/models/shared/employee.rb @@ -54,7 +54,7 @@ class Employee < ::StackOne::Utils::FieldAugmented # The employee gender field :gender, T.nilable(::StackOne::Shared::Gender), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('gender') } } # The employee groups - field :groups, T.nilable(::StackOne::Shared::Groups), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('groups') } } + field :groups, T.nilable(T::Array[::StackOne::Shared::HRISGroup]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('groups') } } # The employee hire date field :hire_date, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('hire_date'), 'decoder': Utils.datetime_from_iso_format(true) } } # The employee home location @@ -103,7 +103,7 @@ class Employee < ::StackOne::Utils::FieldAugmented field :work_phone_number, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('work_phone_number') } } - sig { params(avatar: T.nilable(::StackOne::Shared::Avatar), avatar_url: T.nilable(::String), benefits: T.nilable(T::Array[::StackOne::Shared::HRISBenefit]), birthday: T.nilable(::DateTime), citizenships: T.nilable(T::Array[::StackOne::Shared::CountryCodeEnum]), company: T.nilable(::StackOne::Shared::EmployeeCompany), company_name: T.nilable(::String), cost_centers: T.nilable(T::Array[::StackOne::Shared::CostCenters]), created_at: T.nilable(::DateTime), custom_fields: T.nilable(T::Array[::StackOne::Shared::EmployeeCustomFields]), date_of_birth: T.nilable(::DateTime), department: T.nilable(::String), display_name: T.nilable(::String), employee_number: T.nilable(::String), employment_contract_type: T.nilable(::StackOne::Shared::EmploymentContractType), employment_status: T.nilable(::StackOne::Shared::EmploymentStatus), employment_type: T.nilable(::StackOne::Shared::EmploymentType), employments: T.nilable(T::Array[::StackOne::Shared::Employment]), ethnicity: T.nilable(::StackOne::Shared::Ethnicity), first_name: T.nilable(::String), gender: T.nilable(::StackOne::Shared::Gender), groups: T.nilable(::StackOne::Shared::Groups), hire_date: T.nilable(::DateTime), home_location: T.nilable(::StackOne::Shared::HomeLocation), id: T.nilable(::String), job_description: T.nilable(::StackOne::Shared::JobDescription), job_title: T.nilable(::String), last_name: T.nilable(::String), manager_id: T.nilable(::String), marital_status: T.nilable(::StackOne::Shared::MaritalStatus), name: T.nilable(::String), national_identity_number: T.nilable(::StackOne::Shared::NationalIdentityNumber), personal_email: T.nilable(::String), personal_phone_number: T.nilable(::String), preferred_language: T.nilable(::StackOne::Shared::PreferredLanguage), remote_id: T.nilable(::String), remote_manager_id: T.nilable(::String), start_date: T.nilable(::DateTime), tenure: T.nilable(::Float), termination_date: T.nilable(::DateTime), updated_at: T.nilable(::DateTime), work_anniversary: T.nilable(::DateTime), work_email: T.nilable(::String), work_location: T.nilable(::StackOne::Shared::WorkLocation), work_phone_number: T.nilable(::String)).void } + sig { params(avatar: T.nilable(::StackOne::Shared::Avatar), avatar_url: T.nilable(::String), benefits: T.nilable(T::Array[::StackOne::Shared::HRISBenefit]), birthday: T.nilable(::DateTime), citizenships: T.nilable(T::Array[::StackOne::Shared::CountryCodeEnum]), company: T.nilable(::StackOne::Shared::EmployeeCompany), company_name: T.nilable(::String), cost_centers: T.nilable(T::Array[::StackOne::Shared::CostCenters]), created_at: T.nilable(::DateTime), custom_fields: T.nilable(T::Array[::StackOne::Shared::EmployeeCustomFields]), date_of_birth: T.nilable(::DateTime), department: T.nilable(::String), display_name: T.nilable(::String), employee_number: T.nilable(::String), employment_contract_type: T.nilable(::StackOne::Shared::EmploymentContractType), employment_status: T.nilable(::StackOne::Shared::EmploymentStatus), employment_type: T.nilable(::StackOne::Shared::EmploymentType), employments: T.nilable(T::Array[::StackOne::Shared::Employment]), ethnicity: T.nilable(::StackOne::Shared::Ethnicity), first_name: T.nilable(::String), gender: T.nilable(::StackOne::Shared::Gender), groups: T.nilable(T::Array[::StackOne::Shared::HRISGroup]), hire_date: T.nilable(::DateTime), home_location: T.nilable(::StackOne::Shared::HomeLocation), id: T.nilable(::String), job_description: T.nilable(::StackOne::Shared::JobDescription), job_title: T.nilable(::String), last_name: T.nilable(::String), manager_id: T.nilable(::String), marital_status: T.nilable(::StackOne::Shared::MaritalStatus), name: T.nilable(::String), national_identity_number: T.nilable(::StackOne::Shared::NationalIdentityNumber), personal_email: T.nilable(::String), personal_phone_number: T.nilable(::String), preferred_language: T.nilable(::StackOne::Shared::PreferredLanguage), remote_id: T.nilable(::String), remote_manager_id: T.nilable(::String), start_date: T.nilable(::DateTime), tenure: T.nilable(::Float), termination_date: T.nilable(::DateTime), updated_at: T.nilable(::DateTime), work_anniversary: T.nilable(::DateTime), work_email: T.nilable(::String), work_location: T.nilable(::StackOne::Shared::WorkLocation), work_phone_number: T.nilable(::String)).void } def initialize(avatar: nil, avatar_url: nil, benefits: nil, birthday: nil, citizenships: nil, company: nil, company_name: nil, cost_centers: nil, created_at: nil, custom_fields: nil, date_of_birth: nil, department: nil, display_name: nil, employee_number: nil, employment_contract_type: nil, employment_status: nil, employment_type: nil, employments: nil, ethnicity: nil, first_name: nil, gender: nil, groups: nil, hire_date: nil, home_location: nil, id: nil, job_description: nil, job_title: nil, last_name: nil, manager_id: nil, marital_status: nil, name: nil, national_identity_number: nil, personal_email: nil, personal_phone_number: nil, preferred_language: nil, remote_id: nil, remote_manager_id: nil, start_date: nil, tenure: nil, termination_date: nil, updated_at: nil, work_anniversary: nil, work_email: nil, work_location: nil, work_phone_number: nil) @avatar = avatar @avatar_url = avatar_url diff --git a/lib/stack_one/models/shared/employee_type.rb b/lib/stack_one/models/shared/employee_type.rb index 84126076..a6a94796 100644 --- a/lib/stack_one/models/shared/employee_type.rb +++ b/lib/stack_one/models/shared/employee_type.rb @@ -7,17 +7,17 @@ module StackOne module Shared - # The type of the group + class EmployeeType < ::StackOne::Utils::FieldAugmented extend T::Sig field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } - - field :value, T.nilable(::StackOne::Shared::EmployeeSchemasGroupsValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::EmployeeSchemasGroupsValue, true) } } + # The type of the national identity number + field :value, T.nilable(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue, true) } } - sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::EmployeeSchemasGroupsValue)).void } + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::EmployeeSchemasNationalIdentityNumberValue)).void } def initialize(source_value: nil, value: nil) @source_value = source_value @value = value diff --git a/lib/stack_one/models/shared/groups.rb b/lib/stack_one/models/shared/hrisdepartment.rb similarity index 86% rename from lib/stack_one/models/shared/groups.rb rename to lib/stack_one/models/shared/hrisdepartment.rb index e1adfaee..11555fe0 100644 --- a/lib/stack_one/models/shared/groups.rb +++ b/lib/stack_one/models/shared/hrisdepartment.rb @@ -7,8 +7,8 @@ module StackOne module Shared - # The employee groups - class Groups < ::StackOne::Utils::FieldAugmented + + class HRISDepartment < ::StackOne::Utils::FieldAugmented extend T::Sig # Unique identifier @@ -23,11 +23,11 @@ class Groups < ::StackOne::Utils::FieldAugmented field :remote_id, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_id') } } # Provider's list of parent group ids of the given group field :remote_parent_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('remote_parent_ids') } } - # The type of the group - field :type, T.nilable(::StackOne::Shared::EmployeeType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } } + # The type of the department group + field :type, T.nilable(::StackOne::Shared::HRISDepartmentType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } } - sig { params(id: T.nilable(::String), name: T.nilable(::String), owner_ids: T.nilable(T::Array[::String]), parent_ids: T.nilable(T::Array[::String]), remote_id: T.nilable(::String), remote_parent_ids: T.nilable(T::Array[::String]), type: T.nilable(::StackOne::Shared::EmployeeType)).void } + sig { params(id: T.nilable(::String), name: T.nilable(::String), owner_ids: T.nilable(T::Array[::String]), parent_ids: T.nilable(T::Array[::String]), remote_id: T.nilable(::String), remote_parent_ids: T.nilable(T::Array[::String]), type: T.nilable(::StackOne::Shared::HRISDepartmentType)).void } def initialize(id: nil, name: nil, owner_ids: nil, parent_ids: nil, remote_id: nil, remote_parent_ids: nil, type: nil) @id = id @name = name diff --git a/lib/stack_one/models/shared/hrisdepartment_type.rb b/lib/stack_one/models/shared/hrisdepartment_type.rb new file mode 100644 index 00000000..8b75d2d5 --- /dev/null +++ b/lib/stack_one/models/shared/hrisdepartment_type.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + # The type of the department group + class HRISDepartmentType < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :source_value, T.nilable(::Object), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('source_value') } } + + field :value, T.nilable(::StackOne::Shared::HRISDepartmentValue), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value'), 'decoder': Utils.enum_from_string(::StackOne::Shared::HRISDepartmentValue, true) } } + + + sig { params(source_value: T.nilable(::Object), value: T.nilable(::StackOne::Shared::HRISDepartmentValue)).void } + def initialize(source_value: nil, value: nil) + @source_value = source_value + @value = value + end + end + end +end diff --git a/lib/stack_one/models/shared/hrisdepartment_value.rb b/lib/stack_one/models/shared/hrisdepartment_value.rb new file mode 100644 index 00000000..181a7305 --- /dev/null +++ b/lib/stack_one/models/shared/hrisdepartment_value.rb @@ -0,0 +1,18 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class HRISDepartmentValue < T::Enum + enums do + DEPARTMENT = new('department') + end + end + + end +end diff --git a/lib/stack_one/models/shared/hrisdepartmentspaginated.rb b/lib/stack_one/models/shared/hrisdepartmentspaginated.rb new file mode 100644 index 00000000..0bbb208a --- /dev/null +++ b/lib/stack_one/models/shared/hrisdepartmentspaginated.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class HRISDepartmentsPaginated < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :data, T::Array[::StackOne::Shared::HRISDepartment], { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + + field :next_, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next') } } + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :next_page, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('next_page') } } + + field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } } + + + sig { params(data: T::Array[::StackOne::Shared::HRISDepartment], next_: T.nilable(::String), next_page: T.nilable(::String), raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + def initialize(data: nil, next_: nil, next_page: nil, raw: nil) + @data = data + @next_ = next_ + @next_page = next_page + @raw = raw + end + end + end +end diff --git a/lib/stack_one/models/shared/hrisdepartmentsresult.rb b/lib/stack_one/models/shared/hrisdepartmentsresult.rb new file mode 100644 index 00000000..5027e9af --- /dev/null +++ b/lib/stack_one/models/shared/hrisdepartmentsresult.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class HRISDepartmentsResult < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :data, ::StackOne::Shared::HRISDepartment, { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('data') } } + + field :raw, T.nilable(T::Array[::StackOne::Shared::RawResponse]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('raw') } } + + + sig { params(data: ::StackOne::Shared::HRISDepartment, raw: T.nilable(T::Array[::StackOne::Shared::RawResponse])).void } + def initialize(data: nil, raw: nil) + @data = data + @raw = raw + end + end + end +end diff --git a/lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto.rb b/lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto.rb new file mode 100644 index 00000000..2c4a36bd --- /dev/null +++ b/lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module StackOne + module Shared + + + class MarketingCreateContentBlocksRequestDto < ::StackOne::Utils::FieldAugmented + extend T::Sig + + + field :content, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('content') } } + + field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('name') } } + # Value to pass through to the provider + field :passthrough, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } } + + field :tags, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('tags') } } + + + sig { params(content: T.nilable(::String), name: T.nilable(::String), passthrough: T.nilable(T::Hash[Symbol, ::Object]), tags: T.nilable(T::Array[::String])).void } + def initialize(content: nil, name: nil, passthrough: nil, tags: nil) + @content = content + @name = name + @passthrough = passthrough + @tags = tags + end + end + end +end diff --git a/lib/stack_one/models/shared/national_identity_number.rb b/lib/stack_one/models/shared/national_identity_number.rb index a037a7ee..9889d3e3 100644 --- a/lib/stack_one/models/shared/national_identity_number.rb +++ b/lib/stack_one/models/shared/national_identity_number.rb @@ -12,12 +12,12 @@ class NationalIdentityNumber < ::StackOne::Utils::FieldAugmented extend T::Sig - field :type, T.nilable(::StackOne::Shared::EmployeeSchemasType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } } + field :type, T.nilable(::StackOne::Shared::EmployeeType), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('type') } } field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('value') } } - sig { params(type: T.nilable(::StackOne::Shared::EmployeeSchemasType), value: T.nilable(::String)).void } + sig { params(type: T.nilable(::StackOne::Shared::EmployeeType), value: T.nilable(::String)).void } def initialize(type: nil, value: nil) @type = type @value = value diff --git a/lib/stack_one/sdkconfiguration.rb b/lib/stack_one/sdkconfiguration.rb index 93177757..4516ddb5 100644 --- a/lib/stack_one/sdkconfiguration.rb +++ b/lib/stack_one/sdkconfiguration.rb @@ -38,9 +38,9 @@ def initialize(client, security, server_url, server_idx) @security = security @language = 'ruby' @openapi_doc_version = '1.0.0' - @sdk_version = '0.2.32' - @gen_version = '2.370.2' - @user_agent = 'speakeasy-sdk/ruby 0.2.32 2.370.2 1.0.0 stackone_client' + @sdk_version = '0.2.33' + @gen_version = '2.376.2' + @user_agent = 'speakeasy-sdk/ruby 0.2.33 2.376.2 1.0.0 stackone_client' end sig { returns([String, T::Hash[Symbol, String]]) } diff --git a/stackone_client.gemspec b/stackone_client.gemspec index 52a8ed75..232fb89a 100644 --- a/stackone_client.gemspec +++ b/stackone_client.gemspec @@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__) Gem::Specification.new do |s| s.name = 'stackone_client' - s.version = '0.2.32' + s.version = '0.2.33' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = ''