From 47aa32bfefaa8e8e33d777776435518a28a66095 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sun, 26 Jan 2025 00:08:55 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.462.2 --- .speakeasy/gen.lock | 1393 ++++++++++------- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +- README.md | 48 + RELEASES.md | 12 +- .../Components/AtsUpdateNotesRequestDto.md | 11 + .../AtsUpdateNotesRequestDtoSourceValue.md | 52 + .../AtsUpdateNotesRequestDtoSourceValue4.md | 7 + .../AtsUpdateNotesRequestDtoValue.md | 11 + .../AtsUpdateNotesRequestDtoVisibility.md | 11 + docs/Models/Components/Category.md | 3 +- docs/Models/Components/CategoryLanguage.md | 11 + .../Components/CategoryLanguageSourceValue.md | 50 + .../Components/CategoryLanguageValue.md | 419 +++++ .../CategorySourceValueLanguage4.md | 7 + docs/Models/Components/Course.md | 1 + .../Components/CreateCategoriesApiModel.md | 3 +- ...teCategoriesApiModelLanguageSourceValue.md | 50 + .../CreateCategoriesApiModelLanguageValue.md | 419 +++++ ...eCategoriesApiModelSourceValueLanguage4.md | 7 + docs/Models/Components/Language.md | 11 + .../Components/LmsUpsertContentRequestDto.md | 1 + .../Components/LmsUpsertCourseRequestDto.md | 1 + .../Components/UnifiedWarningApiModel.md | 8 + docs/Models/Components/WriteResultApiModel.md | 3 +- .../AtsCreateApplicationNoteRequest.md | 10 + .../AtsCreateApplicationNoteResponse.md | 12 + .../AtsGetApplicationNoteRequest.md | 13 + .../AtsGetApplicationNoteResponse.md | 12 + ...AtsListApplicationNotesQueryParamFilter.md | 10 + .../AtsListApplicationNotesRequest.md | 18 + .../AtsListApplicationNotesResponse.md | 12 + .../AtsListApplicationsQueryParamFilter.md | 1 + .../AtsListCandidatesQueryParamFilter.md | 1 + .../AtsListInterviewsQueryParamFilter.md | 5 +- .../Operations/AtsListInterviewsRequest.md | 2 +- .../AtsListJobPostingsQueryParamFilter.md | 5 +- .../Operations/AtsListJobPostingsRequest.md | 2 +- .../Operations/AtsListJobsQueryParamFilter.md | 10 +- .../AtsUpdateApplicationNoteRequest.md | 11 + .../AtsUpdateApplicationNoteResponse.md | 12 + docs/Models/Operations/JobStatus.md | 11 + .../Operations/LmsGetCategoryRequest.md | 2 +- .../Models/Operations/LmsGetContentRequest.md | 14 +- docs/Models/Operations/LmsGetCourseRequest.md | 14 +- .../Operations/LmsListCategoriesRequest.md | 2 +- .../Operations/LmsListContentRequest.md | 22 +- .../Operations/LmsListCoursesRequest.md | 2 +- docs/Models/Operations/Status.md | 4 +- docs/sdks/ats/README.md | 249 +++ docs/sdks/lms/README.md | 34 +- src/Ats.php | 300 ++++ .../Components/AtsUpdateNotesRequestDto.php | 66 + .../AtsUpdateNotesRequestDtoSourceValue4.php | 18 + .../AtsUpdateNotesRequestDtoValue.php | 17 + .../AtsUpdateNotesRequestDtoVisibility.php | 44 + src/Models/Components/Category.php | 14 +- src/Models/Components/CategoryLanguage.php | 43 + .../Components/CategoryLanguageValue.php | 425 +++++ .../CategorySourceValueLanguage4.php | 18 + src/Models/Components/Course.php | 13 +- .../Components/CreateCategoriesApiModel.php | 14 +- .../CreateCategoriesApiModelLanguageValue.php | 425 +++++ ...CategoriesApiModelSourceValueLanguage4.php | 18 + src/Models/Components/Language.php | 43 + .../Components/LmsUpsertContentRequestDto.php | 13 +- .../Components/LmsUpsertCourseRequestDto.php | 13 +- .../Components/UnifiedWarningApiModel.php | 29 + src/Models/Components/WriteResultApiModel.php | 14 +- .../AtsCreateApplicationNoteRequest.php | 48 + .../AtsCreateApplicationNoteResponse.php | 64 + .../AtsGetApplicationNoteRequest.php | 77 + .../AtsGetApplicationNoteResponse.php | 64 + ...tsListApplicationNotesQueryParamFilter.php | 30 + .../AtsListApplicationNotesRequest.php | 131 ++ .../AtsListApplicationNotesResponse.php | 64 + .../AtsListApplicationsQueryParamFilter.php | 12 +- .../AtsListCandidatesQueryParamFilter.php | 12 +- .../AtsListInterviewsQueryParamFilter.php | 14 +- .../Operations/AtsListInterviewsRequest.php | 2 +- .../AtsListJobPostingsQueryParamFilter.php | 14 +- .../Operations/AtsListJobPostingsRequest.php | 2 +- .../AtsListJobsQueryParamFilter.php | 23 +- .../AtsUpdateApplicationNoteRequest.php | 57 + .../AtsUpdateApplicationNoteResponse.php | 64 + src/Models/Operations/JobStatus.php | 17 + src/Models/Operations/Status.php | 6 +- src/SDKConfiguration.php | 4 +- 88 files changed, 4641 insertions(+), 634 deletions(-) create mode 100644 docs/Models/Components/AtsUpdateNotesRequestDto.md create mode 100644 docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue.md create mode 100644 docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.md create mode 100644 docs/Models/Components/AtsUpdateNotesRequestDtoValue.md create mode 100644 docs/Models/Components/AtsUpdateNotesRequestDtoVisibility.md create mode 100644 docs/Models/Components/CategoryLanguage.md create mode 100644 docs/Models/Components/CategoryLanguageSourceValue.md create mode 100644 docs/Models/Components/CategoryLanguageValue.md create mode 100644 docs/Models/Components/CategorySourceValueLanguage4.md create mode 100644 docs/Models/Components/CreateCategoriesApiModelLanguageSourceValue.md create mode 100644 docs/Models/Components/CreateCategoriesApiModelLanguageValue.md create mode 100644 docs/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.md create mode 100644 docs/Models/Components/Language.md create mode 100644 docs/Models/Components/UnifiedWarningApiModel.md create mode 100644 docs/Models/Operations/AtsCreateApplicationNoteRequest.md create mode 100644 docs/Models/Operations/AtsCreateApplicationNoteResponse.md create mode 100644 docs/Models/Operations/AtsGetApplicationNoteRequest.md create mode 100644 docs/Models/Operations/AtsGetApplicationNoteResponse.md create mode 100644 docs/Models/Operations/AtsListApplicationNotesQueryParamFilter.md create mode 100644 docs/Models/Operations/AtsListApplicationNotesRequest.md create mode 100644 docs/Models/Operations/AtsListApplicationNotesResponse.md create mode 100644 docs/Models/Operations/AtsUpdateApplicationNoteRequest.md create mode 100644 docs/Models/Operations/AtsUpdateApplicationNoteResponse.md create mode 100644 docs/Models/Operations/JobStatus.md create mode 100644 src/Models/Components/AtsUpdateNotesRequestDto.php create mode 100644 src/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.php create mode 100644 src/Models/Components/AtsUpdateNotesRequestDtoValue.php create mode 100644 src/Models/Components/AtsUpdateNotesRequestDtoVisibility.php create mode 100644 src/Models/Components/CategoryLanguage.php create mode 100644 src/Models/Components/CategoryLanguageValue.php create mode 100644 src/Models/Components/CategorySourceValueLanguage4.php create mode 100644 src/Models/Components/CreateCategoriesApiModelLanguageValue.php create mode 100644 src/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.php create mode 100644 src/Models/Components/Language.php create mode 100644 src/Models/Components/UnifiedWarningApiModel.php create mode 100644 src/Models/Operations/AtsCreateApplicationNoteRequest.php create mode 100644 src/Models/Operations/AtsCreateApplicationNoteResponse.php create mode 100644 src/Models/Operations/AtsGetApplicationNoteRequest.php create mode 100644 src/Models/Operations/AtsGetApplicationNoteResponse.php create mode 100644 src/Models/Operations/AtsListApplicationNotesQueryParamFilter.php create mode 100644 src/Models/Operations/AtsListApplicationNotesRequest.php create mode 100644 src/Models/Operations/AtsListApplicationNotesResponse.php create mode 100644 src/Models/Operations/AtsUpdateApplicationNoteRequest.php create mode 100644 src/Models/Operations/AtsUpdateApplicationNoteResponse.php create mode 100644 src/Models/Operations/JobStatus.php diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 51389ab2..ddb34909 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 3759371f-a095-4585-b437-50529a0eb248 management: - docChecksum: 81d85fcf17f0a74b6832fd03461f60ea + docChecksum: 33bed8bd340141965eee29b804ecab51 docVersion: 1.0.0 speakeasyVersion: 1.462.2 generationVersion: 2.486.1 - releaseVersion: 0.23.0 - configChecksum: a0bb5cce24065648c01cfc40ad2a76d3 + releaseVersion: 0.23.2 + configChecksum: 4c593310728e806d154cfa7715cb2238 repoURL: https://github.com/StackOneHQ/stackone-client-php.git installationURL: https://github.com/StackOneHQ/stackone-client-php published: true @@ -28,7 +28,6 @@ features: unions: 0.1.4 generatedFiles: - .gitattributes - - CONTRIBUTING.md - USAGE.md - composer.json - docs/Models/Components/ATSLocation.md @@ -154,6 +153,11 @@ generatedFiles: - docs/Models/Components/AtsUpdateJobRequestDtoSourceValue.md - docs/Models/Components/AtsUpdateJobRequestDtoSourceValue4.md - docs/Models/Components/AtsUpdateJobRequestDtoValue.md + - docs/Models/Components/AtsUpdateNotesRequestDto.md + - docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue.md + - docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.md + - docs/Models/Components/AtsUpdateNotesRequestDtoValue.md + - docs/Models/Components/AtsUpdateNotesRequestDtoVisibility.md - docs/Models/Components/Attachment.md - docs/Models/Components/AttachmentContentType.md - docs/Models/Components/AttachmentSourceValue.md @@ -202,10 +206,14 @@ generatedFiles: - docs/Models/Components/Categories.md - docs/Models/Components/CategoriesPaginated.md - docs/Models/Components/Category.md + - docs/Models/Components/CategoryLanguage.md + - docs/Models/Components/CategoryLanguageSourceValue.md + - docs/Models/Components/CategoryLanguageValue.md - docs/Models/Components/CategoryLevel.md - docs/Models/Components/CategoryResult.md - docs/Models/Components/CategorySourceValue.md - docs/Models/Components/CategorySourceValue4.md + - docs/Models/Components/CategorySourceValueLanguage4.md - docs/Models/Components/CategoryValue.md - docs/Models/Components/ChannelsEnum.md - docs/Models/Components/ChannelsEnumSourceValue.md @@ -269,8 +277,11 @@ generatedFiles: - docs/Models/Components/CreateAnswerType.md - docs/Models/Components/CreateAnswerValue.md - docs/Models/Components/CreateCategoriesApiModel.md + - docs/Models/Components/CreateCategoriesApiModelLanguageSourceValue.md + - docs/Models/Components/CreateCategoriesApiModelLanguageValue.md - docs/Models/Components/CreateCategoriesApiModelSourceValue.md - docs/Models/Components/CreateCategoriesApiModelSourceValue4.md + - docs/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.md - docs/Models/Components/CreateCategoriesApiModelValue.md - docs/Models/Components/CreateContentApiModel.md - docs/Models/Components/CreateCostCenterApiModel.md @@ -763,6 +774,7 @@ generatedFiles: - docs/Models/Components/JobValue.md - docs/Models/Components/JobsPaginated.md - docs/Models/Components/Label.md + - docs/Models/Components/Language.md - docs/Models/Components/LanguageEnum.md - docs/Models/Components/LanguageEnumSourceValue.md - docs/Models/Components/LanguageEnumSourceValue4.md @@ -962,6 +974,7 @@ generatedFiles: - docs/Models/Components/UnifiedUploadRequestDtoSourceValue4.md - docs/Models/Components/UnifiedUploadRequestDtoSourceValueConfidential4.md - docs/Models/Components/UnifiedUploadRequestDtoValue.md + - docs/Models/Components/UnifiedWarningApiModel.md - docs/Models/Components/UpdateEmployeeApiModel.md - docs/Models/Components/UpdateEmployeeApiModelAvatar.md - docs/Models/Components/UpdateEmployeeApiModelCountry.md @@ -1046,6 +1059,8 @@ generatedFiles: - docs/Models/Components/WorkEligibilityValue.md - docs/Models/Components/WorkLocation.md - docs/Models/Components/WriteResultApiModel.md + - docs/Models/Operations/AtsCreateApplicationNoteRequest.md + - docs/Models/Operations/AtsCreateApplicationNoteResponse.md - docs/Models/Operations/AtsCreateApplicationRequest.md - docs/Models/Operations/AtsCreateApplicationResponse.md - docs/Models/Operations/AtsCreateBackgroundCheckPackageRequest.md @@ -1065,6 +1080,8 @@ generatedFiles: - docs/Models/Operations/AtsGetApplicationCustomFieldDefinitionResponse.md - docs/Models/Operations/AtsGetApplicationDocumentRequest.md - docs/Models/Operations/AtsGetApplicationDocumentResponse.md + - docs/Models/Operations/AtsGetApplicationNoteRequest.md + - docs/Models/Operations/AtsGetApplicationNoteResponse.md - docs/Models/Operations/AtsGetApplicationOfferRequest.md - docs/Models/Operations/AtsGetApplicationOfferResponse.md - docs/Models/Operations/AtsGetApplicationRequest.md @@ -1121,6 +1138,9 @@ generatedFiles: - docs/Models/Operations/AtsListApplicationDocumentsQueryParamFilter.md - docs/Models/Operations/AtsListApplicationDocumentsRequest.md - docs/Models/Operations/AtsListApplicationDocumentsResponse.md + - docs/Models/Operations/AtsListApplicationNotesQueryParamFilter.md + - docs/Models/Operations/AtsListApplicationNotesRequest.md + - docs/Models/Operations/AtsListApplicationNotesResponse.md - docs/Models/Operations/AtsListApplicationScorecardsQueryParamFilter.md - docs/Models/Operations/AtsListApplicationScorecardsRequest.md - docs/Models/Operations/AtsListApplicationScorecardsResponse.md @@ -1188,6 +1208,8 @@ generatedFiles: - docs/Models/Operations/AtsMoveApplicationResponse.md - docs/Models/Operations/AtsRejectApplicationRequest.md - docs/Models/Operations/AtsRejectApplicationResponse.md + - docs/Models/Operations/AtsUpdateApplicationNoteRequest.md + - docs/Models/Operations/AtsUpdateApplicationNoteResponse.md - docs/Models/Operations/AtsUpdateApplicationRequest.md - docs/Models/Operations/AtsUpdateApplicationResponse.md - docs/Models/Operations/AtsUpdateCandidateRequest.md @@ -1352,6 +1374,7 @@ generatedFiles: - docs/Models/Operations/IamListUsersQueryParamFilter.md - docs/Models/Operations/IamListUsersRequest.md - docs/Models/Operations/IamListUsersResponse.md + - docs/Models/Operations/JobStatus.md - docs/Models/Operations/LearningObjectType.md - docs/Models/Operations/LmsBatchUpsertContentRequest.md - docs/Models/Operations/LmsBatchUpsertContentResponse.md @@ -1642,6 +1665,10 @@ generatedFiles: - src/Models/Components/AtsUpdateJobRequestDtoJobStatus.php - src/Models/Components/AtsUpdateJobRequestDtoSourceValue4.php - src/Models/Components/AtsUpdateJobRequestDtoValue.php + - src/Models/Components/AtsUpdateNotesRequestDto.php + - src/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.php + - src/Models/Components/AtsUpdateNotesRequestDtoValue.php + - src/Models/Components/AtsUpdateNotesRequestDtoVisibility.php - src/Models/Components/Attachment.php - src/Models/Components/AttachmentContentType.php - src/Models/Components/AttachmentSourceValue4.php @@ -1685,9 +1712,12 @@ generatedFiles: - src/Models/Components/Categories.php - src/Models/Components/CategoriesPaginated.php - src/Models/Components/Category.php + - src/Models/Components/CategoryLanguage.php + - src/Models/Components/CategoryLanguageValue.php - src/Models/Components/CategoryLevel.php - src/Models/Components/CategoryResult.php - src/Models/Components/CategorySourceValue4.php + - src/Models/Components/CategorySourceValueLanguage4.php - src/Models/Components/CategoryValue.php - src/Models/Components/ChannelsEnum.php - src/Models/Components/ChannelsEnumSourceValue4.php @@ -1744,7 +1774,9 @@ generatedFiles: - src/Models/Components/CreateAnswerType.php - src/Models/Components/CreateAnswerValue.php - src/Models/Components/CreateCategoriesApiModel.php + - src/Models/Components/CreateCategoriesApiModelLanguageValue.php - src/Models/Components/CreateCategoriesApiModelSourceValue4.php + - src/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.php - src/Models/Components/CreateCategoriesApiModelValue.php - src/Models/Components/CreateContentApiModel.php - src/Models/Components/CreateCostCenterApiModel.php @@ -2137,6 +2169,7 @@ generatedFiles: - src/Models/Components/JobValue.php - src/Models/Components/JobsPaginated.php - src/Models/Components/Label.php + - src/Models/Components/Language.php - src/Models/Components/LanguageEnum.php - src/Models/Components/LanguageEnumSourceValue4.php - src/Models/Components/LanguageEnumValue.php @@ -2310,6 +2343,7 @@ generatedFiles: - src/Models/Components/UnifiedUploadRequestDtoSourceValue4.php - src/Models/Components/UnifiedUploadRequestDtoSourceValueConfidential4.php - src/Models/Components/UnifiedUploadRequestDtoValue.php + - src/Models/Components/UnifiedWarningApiModel.php - src/Models/Components/UpdateEmployeeApiModel.php - src/Models/Components/UpdateEmployeeApiModelAvatar.php - src/Models/Components/UpdateEmployeeApiModelCountry.php @@ -2378,6 +2412,8 @@ generatedFiles: - src/Models/Components/WorkLocation.php - src/Models/Components/WriteResultApiModel.php - src/Models/Errors/SDKException.php + - src/Models/Operations/AtsCreateApplicationNoteRequest.php + - src/Models/Operations/AtsCreateApplicationNoteResponse.php - src/Models/Operations/AtsCreateApplicationRequest.php - src/Models/Operations/AtsCreateApplicationResponse.php - src/Models/Operations/AtsCreateBackgroundCheckPackageRequest.php @@ -2397,6 +2433,8 @@ generatedFiles: - src/Models/Operations/AtsGetApplicationCustomFieldDefinitionResponse.php - src/Models/Operations/AtsGetApplicationDocumentRequest.php - src/Models/Operations/AtsGetApplicationDocumentResponse.php + - src/Models/Operations/AtsGetApplicationNoteRequest.php + - src/Models/Operations/AtsGetApplicationNoteResponse.php - src/Models/Operations/AtsGetApplicationOfferRequest.php - src/Models/Operations/AtsGetApplicationOfferResponse.php - src/Models/Operations/AtsGetApplicationRequest.php @@ -2453,6 +2491,9 @@ generatedFiles: - src/Models/Operations/AtsListApplicationDocumentsQueryParamFilter.php - src/Models/Operations/AtsListApplicationDocumentsRequest.php - src/Models/Operations/AtsListApplicationDocumentsResponse.php + - src/Models/Operations/AtsListApplicationNotesQueryParamFilter.php + - src/Models/Operations/AtsListApplicationNotesRequest.php + - src/Models/Operations/AtsListApplicationNotesResponse.php - src/Models/Operations/AtsListApplicationScorecardsQueryParamFilter.php - src/Models/Operations/AtsListApplicationScorecardsRequest.php - src/Models/Operations/AtsListApplicationScorecardsResponse.php @@ -2520,6 +2561,8 @@ generatedFiles: - src/Models/Operations/AtsMoveApplicationResponse.php - src/Models/Operations/AtsRejectApplicationRequest.php - src/Models/Operations/AtsRejectApplicationResponse.php + - src/Models/Operations/AtsUpdateApplicationNoteRequest.php + - src/Models/Operations/AtsUpdateApplicationNoteResponse.php - src/Models/Operations/AtsUpdateApplicationRequest.php - src/Models/Operations/AtsUpdateApplicationResponse.php - src/Models/Operations/AtsUpdateCandidateRequest.php @@ -2684,6 +2727,7 @@ generatedFiles: - src/Models/Operations/IamListUsersQueryParamFilter.php - src/Models/Operations/IamListUsersRequest.php - src/Models/Operations/IamListUsersResponse.php + - src/Models/Operations/JobStatus.php - src/Models/Operations/LearningObjectType.php - src/Models/Operations/LmsBatchUpsertContentRequest.php - src/Models/Operations/LmsBatchUpsertContentResponse.php @@ -2874,22 +2918,25 @@ examples: stackone_create_connect_session: speakeasy-default-stackone-create-connect-session: requestBody: - application/json: {"categories": ["ats", "hris", "crm", "crm", "iam", "marketing", "lms", "ats", "documents"], "origin_owner_id": "", "origin_owner_name": ""} + application/json: {"categories": ["ats", "hris", "crm", "crm", "iam", "marketing", "lms", "ats", "documents"], "origin_owner_id": "", "origin_owner_name": "", "expires_in": 1800, "multiple": false} responses: "201": - application/json: {"id": "6908.66", "organization_id": "6497.42", "project_id": "", "categories": ["ats", "hris", "lms", "crm", "iam", "marketing", "lms", "marketing", "documents"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-12-16T09:37:09.059Z", "token": "", "auth_link_url": "https://brisk-widow.biz/"} + application/json: {"id": 6908.66, "organization_id": 6497.42, "project_id": "", "categories": ["ats", "hris", "lms", "crm", "iam", "marketing", "lms", "marketing", "documents"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2025-12-16T09:37:09.059Z", "token": "", "auth_link_url": "https://unsung-reasoning.name/"} stackone_authenticate_connect_session: speakeasy-default-stackone-authenticate-connect-session: requestBody: application/json: {"token": ""} responses: "201": - application/json: {"id": "3607.71", "organization_id": "2827.51", "project_id": "", "categories": ["ats", "hris", "crm", "crm", "iam", "marketing", "lms", "hris-legacy", "documents"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-04-16T14:12:57.983Z"} + application/json: {"id": 3607.71, "organization_id": 2827.51, "project_id": "", "categories": ["ats", "hris", "crm", "crm", "iam", "marketing", "lms", "hris-legacy", "documents"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2025-04-16T14:12:57.983Z"} stackone_list_linked_accounts: speakeasy-default-stackone-list-linked-accounts: + parameters: + query: + page_size: 25 responses: "200": - application/json: [{"id": "", "provider": "", "status": "error", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-05-08T05:38:50.041Z", "updated_at": "2022-10-16T22:20:04.604Z"}, {"id": "", "provider": "", "status": "inactive", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2023-06-22T10:35:22.941Z", "updated_at": "2023-07-18T01:19:55.761Z"}, {"id": "", "provider": "", "status": "inactive", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-05-31T15:24:35.176Z", "updated_at": "2022-07-10T17:07:30.423Z"}] + application/json: [{"id": "", "provider": "", "status": "error", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2025-05-08T05:38:50.041Z", "updated_at": "2023-10-16T22:20:04.604Z"}, {"id": "", "provider": "", "status": "inactive", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-06-21T10:35:22.941Z", "updated_at": "2024-07-17T01:19:55.761Z"}, {"id": "", "provider": "", "status": "inactive", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2025-05-31T15:24:35.176Z", "updated_at": "2023-07-10T17:07:30.423Z"}] stackone_get_account: speakeasy-default-stackone-get-account: parameters: @@ -2897,7 +2944,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "provider": "", "status": "active", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2022-04-27T20:34:29.195Z", "updated_at": "2022-07-29T07:34:48.454Z"} + application/json: {"id": "", "provider": "", "status": "active", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2023-04-27T20:34:29.195Z", "updated_at": "2023-07-29T07:34:48.454Z"} stackone_delete_account: speakeasy-default-stackone-delete-account: parameters: @@ -2905,15 +2952,17 @@ examples: id: "" responses: "200": - application/json: {"id": "", "provider": "", "status": "active", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-08-29T06:25:30.041Z", "updated_at": "2022-01-28T20:50:17.992Z"} + application/json: {"id": "", "provider": "", "status": "active", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2025-08-29T06:25:30.041Z", "updated_at": "2023-01-28T20:50:17.992Z"} stackone_update_account: speakeasy-default-stackone-update-account: parameters: path: id: "" + requestBody: + application/json: {} responses: "200": - application/json: {"id": "", "provider": "", "status": "inactive", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-07-26T23:05:41.174Z", "updated_at": "2022-10-01T04:05:44.873Z"} + application/json: {"id": "", "provider": "", "status": "inactive", "origin_owner_id": "", "origin_owner_name": "", "created_at": "2025-07-26T23:05:41.174Z", "updated_at": "2023-10-01T04:05:44.873Z"} stackone_get_account_meta_info: speakeasy-default-stackone-get-account-meta-info: parameters: @@ -2922,6 +2971,18 @@ examples: responses: "200": application/json: {"provider": "", "category": "crm", "models": {"key": ""}} + create: + speakeasy-default-create: + parameters: + path: + id: 6384.24 + header: + x-account-id: "" + requestBody: + application/json: [{"event": "hris_employees.created", "record_id": ""}] + responses: + "207": + application/json: [{"event": "hris_employees.created", "record_id": "", "status": 200, "message": "The event was created"}, {"event": "hris_employees.created", "record_id": "", "status": 200, "message": "The event was created"}] stackone_list_connectors_meta: "": parameters: @@ -2929,7 +2990,7 @@ examples: include: "field_path,unmapped_fields,resources,inactive,webhooks,static_fields" responses: "200": - application/json: [{"provider": "hibob", "provider_name": "Hibob", "category": "hris", "active": true, "models": {"employees": {"create": {"apiPath": "/unified/hris/employees/:id", "input": {"defaultFields": [{"name": "first_name", "type": "string"}]}, "output": {"defaultFields": [{"name": "id", "type": "string"}]}}}, "time_off": {"get": {"apiPath": "/unified/hris/employees/:id/time_off/:id", "output": {"defaultFields": [{"name": "id", "type": "string"}]}}}}, "resources": {"images": {"logo_url": "https://app.stackone.com/assets/logos/hibob.png", "original_logo_horizontal_url": "https://app.stackone.com/assets/logos/original/hibob_horizontal.png"}}}] + application/json: [{"provider": "hibob", "provider_name": "Hibob", "category": "hris", "active": true, "models": {"employees": {"create": {"apiPath": "/unified/hris/employees/:id", "input": {"defaultFields": [{"name": "first_name", "type": "string"}]}, "output": {"defaultFields": [{"name": "id", "type": "string"}]}}}, "time_off": {"get": {"apiPath": "/unified/hris/employees/:id/time_off/:id", "output": {"defaultFields": [{"name": "id", "type": "string"}]}}}}, "resources": {"images": {"logo_url": "https://app.stackone.com/assets/logos/hibob.png", "original_logo_horizontal_url": "https://app.stackone.com/assets/logos/original/hibob_horizontal.png"}}}, {"provider": "hibob", "provider_name": "Hibob", "category": "hris", "active": true, "models": {"employees": {"create": {"apiPath": "/unified/hris/employees/:id", "input": {"defaultFields": [{"name": "first_name", "type": "string"}]}, "output": {"defaultFields": [{"name": "id", "type": "string"}]}}}, "time_off": {"get": {"apiPath": "/unified/hris/employees/:id/time_off/:id", "output": {"defaultFields": [{"name": "id", "type": "string"}]}}}}, "resources": {"images": {"logo_url": "https://app.stackone.com/assets/logos/hibob.png", "original_logo_horizontal_url": "https://app.stackone.com/assets/logos/original/hibob_horizontal.png"}}}] stackone_get_connector_meta: "": parameters: @@ -2946,13 +3007,15 @@ examples: header: x-account-id: "" requestBody: - application/json: {"url": "https://api.sample-integration.com/v1", "path": "/employees/directory", "headers": {"Content-Type": "application/json"}} + application/json: {"url": "https://api.sample-integration.com/v1", "method": "get", "path": "/employees/directory", "headers": {"Content-Type": "application/json"}} hris_list_companies: "": parameters: query: + raw: false fields: "id,remote_id,name,full_name,display_name,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -2965,18 +3028,51 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,full_name,display_name,created_at,updated_at" header: x-account-id: "" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}} + hris_list_employee_custom_field_definitions: + "": + parameters: + query: + raw: false + fields: "id,remote_id,name,description,type,options" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": []} + hris_get_employee_custom_field_definition: + "": + parameters: + path: + id: "" + query: + raw: false + fields: "id,remote_id,name,description,type,options" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "options": ["Not Started", "In Progress", "Completed", "Overdue"]}} hris_list_employees: "": parameters: query: + raw: false fields: "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" expand: "company,employments,work_location,home_location,groups" include: "avatar_url,avatar,custom_fields,job_description,benefits" @@ -2991,7 +3087,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "R-6789", "job_title": "Physicist", "department_id": "3093", "department": "Physics", "manager_id": "67890", "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}], "employments": [], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "passthrough": {"other_known_names": "John Doe"}} + application/json: {"first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "R-6789", "job_title": "Physicist", "department_id": "3093", "department": "Physics", "manager_id": "67890", "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}, {"value": "US"}], "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "cost_centers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "R&D", "distribution_percentage": 100}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "R&D", "distribution_percentage": 100}], "passthrough": {"other_known_names": "John Doe"}} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3001,6 +3097,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number" expand: "company,employments,work_location,home_location,groups" include: "avatar_url,avatar,custom_fields,job_description,benefits" @@ -3008,7 +3105,7 @@ examples: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "5290", "job_title": "Physicist", "job_description": {"text": "Testing the laws of motion"}, "department_id": "3093", "department": "Physics", "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}], "cost_centers": [], "manager_id": "67890", "remote_manager_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "preferred_language": {"value": "eng"}, "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}, {"value": "US"}], "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "company": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}, "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "5290", "job_title": "Physicist", "department_id": "3093", "department": "Physics", "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}], "cost_centers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "R&D", "distribution_percentage": 100}], "manager_id": "67890", "remote_manager_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}, {"value": "US"}, {"value": "US"}], "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "company": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}, "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} hris_update_employee: speakeasy-default-hris-update-employee: parameters: @@ -3017,18 +3114,20 @@ examples: header: x-account-id: "" requestBody: - application/json: {"first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "R-6789", "job_title": "Physicist", "department_id": "3093", "department": "Physics", "manager_id": "67890", "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}], "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S"}], "custom_fields": [], "benefits": [], "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "passthrough": {"other_known_names": "John Doe"}} + application/json: {"first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "R-6789", "job_title": "Physicist", "department_id": "3093", "department": "Physics", "manager_id": "67890", "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}], "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {} + application/json: {"first_name": "Issac", "last_name": "Newton", "name": "Issac Newton", "display_name": "Sir Issac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_id": "R-6789", "job_title": "Physicist", "department_id": "3093", "department": "Physics", "manager_id": "67890", "date_of_birth": "1990-01-01T00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "hire_date": "2021-01-01T00:00.000Z", "start_date": "2021-01-01T00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "termination_date": "2021-01-01T00:00:00Z", "company_name": "Example Corp", "citizenships": [{"value": "US"}, {"value": "US"}, {"value": "US"}], "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_number": {"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}, "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}}} hris_list_employee_time_off_requests: "": parameters: path: id: "" query: + raw: false 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" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3054,6 +3153,7 @@ examples: id: "" subResourceId: "" query: + raw: false 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" header: x-account-id: "" @@ -3080,10 +3180,10 @@ examples: header: x-account-id: "" requestBody: - application/json: {"name": "weather-forecast", "file_format": {"value": "pdf", "source_value": "abc"}, "content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", "category_id": "6530", "path": "/path/to/file", "category": {"value": "unmapped_value", "source_value": "550e8400-e29b-41d4-a716-446655440000"}, "confidential": {"value": "true", "source_value": "public"}} + application/json: {"name": "weather-forecast", "file_format": {"value": "pdf", "source_value": "abc"}, "content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", "category_id": "6530", "path": "/path/to/file", "confidential": {"value": "true", "source_value": "public"}} responses: "201": - application/json: {"statusCode": 201, "message": "Employee created successfully", "timestamp": "2021-01-01T01:01:01.000Z", "provider_errors": [{"status": 400, "url": "https://api.someprovider.com/v1/endpoint"}]} + application/json: {"statusCode": 201, "message": "Employee created successfully", "timestamp": "2021-01-01T01:01:01.000Z", "provider_errors": [{"status": 400, "url": "https://api.someprovider.com/v1/endpoint"}], "unified_warnings": [{"message": "The provided field type is not supported in the current model."}]} hris_download_employee_document: "": parameters: @@ -3103,8 +3203,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3118,6 +3220,7 @@ examples: id: "" subResourceId: "" query: + raw: false fields: "id,remote_id,name,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format" header: x-account-id: "" @@ -3128,8 +3231,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,active" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3142,6 +3247,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,active" header: x-account-id: "" @@ -3154,8 +3260,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3181,6 +3289,7 @@ examples: id: "" subResourceId: "" query: + raw: false fields: "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number" header: x-account-id: "" @@ -3201,43 +3310,60 @@ examples: "": parameters: query: + raw: false 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,time_worked,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" expand: "groups" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} hris_get_employment: "": parameters: path: id: "" query: + raw: false 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,time_worked,created_at,updated_at" expand: "groups" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} hris_list_employee_employments: "": parameters: path: id: "" query: + raw: false 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,time_worked,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" expand: "groups" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + hris_create_employee_employment: + speakeasy-default-hris-create-employee-employment: + parameters: + path: + id: "" + header: + x-account-id: "" + requestBody: + application/json: {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "passthrough": {"other_known_names": "John Doe"}} + responses: + "201": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} hris_get_employee_employment: "": parameters: @@ -3245,19 +3371,35 @@ examples: id: "" subResourceId: "" query: + raw: false 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,time_worked,created_at,updated_at" expand: "groups" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "employment_type": {"value": "permanent", "source_value": "Permanent"}, "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + hris_update_employee_employment: + speakeasy-default-hris-update-employee-employment: + parameters: + path: + id: "" + subResourceId: "" + header: + x-account-id: "" + requestBody: + application/json: {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "passthrough": {"other_known_names": "John Doe"}} + responses: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} hris_list_locations: "": parameters: query: + raw: false 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" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3270,18 +3412,21 @@ examples: path: id: "" query: + raw: false 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" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} hris_list_time_off_requests: "": parameters: query: + raw: false 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" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3304,6 +3449,7 @@ examples: path: id: "" query: + raw: false 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" header: x-account-id: "" @@ -3322,12 +3468,41 @@ examples: responses: "200": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + hris_list_time_off_types: + "": + parameters: + query: + raw: false + fields: "id,remote_id,name,active" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": [{"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}]} + hris_get_time_off_type: + "": + parameters: + path: + id: "" + query: + raw: false + fields: "id,remote_id,name,active" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}} hris_list_benefits: "": parameters: query: + raw: false fields: "id,remote_id,name,benefit_type,provider,description,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3340,6 +3515,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,benefit_type,provider,description,created_at,updated_at" header: x-account-id: "" @@ -3350,8 +3526,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3362,20 +3540,37 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"]}]} + hris_list_cost_center_groups: + "": + parameters: + query: + raw: false + fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "department"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "department"}}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}]} hris_get_group: "": parameters: path: id: "" query: + raw: false fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" header: x-account-id: "" @@ -3388,18 +3583,34 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "department"}}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"]}} + hris_get_cost_center_group: + "": + parameters: + path: + id: "" + query: + raw: false + fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}} hris_list_jobs: "": parameters: query: + raw: false fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3412,18 +3623,21 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "remote_department_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "location_ids": ["668570", "678571", "688572"], "remote_location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "remote_department_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "location_ids": ["668570", "678571", "688572"], "remote_location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} ats_list_applications: "": parameters: query: + raw: false fields: "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_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,custom_fields,candidate" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" expand: "documents" include: "attachments,custom_fields" @@ -3432,14 +3646,14 @@ examples: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "remote_interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "rejected_reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}], "rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "remote_rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "rejected_at": "2021-01-01T01:01:01.000Z", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "remote_location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "remote_location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "right_to_work", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "answers": [{"id": "answer1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "Short Text"}, "values": ["Yes"]}]}], "candidate": {"name": "Romain Sestier", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "phone_numbers": [], "social_links": [], "company": "Company Inc.", "title": "Software Engineer"}, "documents": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}], "result_links": [], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "remote_interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "rejected_reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}], "rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "remote_rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "rejected_at": "2021-01-01T01:01:01.000Z", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "remote_location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "remote_location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "right_to_work", "answers": [{"id": "answer1", "values": ["Yes"]}]}], "candidate": {"name": "Romain Sestier", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "phone_numbers": [{"phone": "+447700112233"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer"}, "documents": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}], "result_links": [{"label": "test result link", "url": "http://example.com/test-result/4565765/data"}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}]} ats_create_application: speakeasy-default-ats-create-application: parameters: header: x-account-id: "" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "values": ["Yes", "No Travel", "It sounds pretty cool.", "Excel", "Power Point"]}]}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "candidate": {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "phone_number": "+1234567890", "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}, {"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer", "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "job_posting_id": "1c702a20-8de8-4d03-ac18-cbf4ac42eb51", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "values": ["Yes", "No Travel", "It sounds pretty cool.", "Excel", "Power Point"]}]}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "candidate": {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "phone_number": "+1234567890", "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}, {"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer", "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3449,6 +3663,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_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,custom_fields,candidate" expand: "documents" include: "attachments,custom_fields" @@ -3456,7 +3671,7 @@ examples: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "remote_interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "rejected_reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}], "rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "remote_rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "rejected_at": "2021-01-01T01:01:01.000Z", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "remote_location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "remote_location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "right_to_work", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "answers": [{"id": "answer1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "Short Text"}, "values": ["Yes"]}]}], "candidate": {"name": "Romain Sestier", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}], "social_links": [], "company": "Company Inc.", "title": "Software Engineer"}, "documents": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}], "result_links": [{"label": "assessment result link", "url": "http://example.com/assessment-result/4565765/data"}, {"label": "assessment result link", "url": "http://example.com/assessment-result/4565765/data"}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "remote_interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "rejected_reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}], "rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "remote_rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "rejected_at": "2021-01-01T01:01:01.000Z", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "remote_location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "remote_location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "right_to_work", "answers": [{"id": "answer1", "values": ["Yes"]}]}], "candidate": {"name": "Romain Sestier", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer"}, "documents": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}], "result_links": [{"label": "test result link", "url": "http://example.com/test-result/4565765/data"}, {"label": "test result link", "url": "http://example.com/test-result/4565765/data"}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}} ats_update_application: speakeasy-default-ats-update-application: parameters: @@ -3465,7 +3680,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "rejected_reason_id": "f223d7f6-908b-48f0-9237-b201c307f609", "custom_fields": [], "application_status": {"value": "hired", "source_value": "Hired"}, "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480"} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "application_status": {"value": "hired", "source_value": "Hired"}, "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480"} responses: "200": application/json: {"statusCode": 200, "message": "Record updated successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} @@ -3475,14 +3690,16 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": []}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": []}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}]} ats_move_application: speakeasy-default-ats-move-application: parameters: @@ -3514,6 +3731,7 @@ examples: id: "" subResourceId: "" query: + raw: false fields: "id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history" header: x-account-id: "" @@ -3526,14 +3744,16 @@ examples: path: id: "" query: + raw: false 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" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": []}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": []}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "number", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "short_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "single_select", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "strong_yes", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "boolean", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "phone", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "boolean", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "long_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "email", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "no_decision", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": []}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "long_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "email", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "strong_yes", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "short_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "number", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "short_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "single_select", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "location", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "no", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "phone", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "boolean", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "long_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "email", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "score", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "no_decision", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "long_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "no", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}]} ats_get_application_scorecard: "": parameters: @@ -3541,26 +3761,84 @@ examples: id: "" subResourceId: "" query: + raw: false 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" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "boolean", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "score", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "long_text", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "date", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "unmapped_value", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "boolean", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "score", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "email", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Technical Skills", "fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Problem Solving", "type": "date", "values": ["Excellent", "Good", "Average", "Poor"], "required": true}]}], "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "unmapped_value", "created_at": "2021-01-01T00:00.000Z", "updated_at": "2021-01-01T00:00.000Z"}} + ats_list_application_notes: + "": + parameters: + path: + id: "" + query: + raw: false + fields: "id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}]} + ats_create_application_note: + speakeasy-default-ats-create-application-note: + parameters: + path: + id: "" + header: + x-account-id: "" + requestBody: + application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "passthrough": {"other_known_names": "John Doe"}} + responses: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + ats_get_application_note: + "": + parameters: + path: + id: "" + subResourceId: "" + query: + raw: false + fields: "id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at" + header: + x-account-id: "" + responses: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}} + ats_update_application_note: + speakeasy-default-ats-update-application-note: + parameters: + path: + id: "" + subResourceId: "" + header: + x-account-id: "" + requestBody: + application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "passthrough": {"other_known_names": "John Doe"}} + responses: + "200": + application/json: {"statusCode": 200, "message": "Record updated successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} ats_list_applications_scheduled_interviews: "": parameters: path: id: "" query: + raw: false 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" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} ats_get_application_scheduled_interview: "": parameters: @@ -3568,12 +3846,13 @@ examples: id: "" subResourceId: "" query: + raw: false fields: "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_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,custom_fields,candidate" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} ats_upload_application_document: speakeasy-default-ats-upload-application-document: parameters: @@ -3585,7 +3864,7 @@ examples: application/json: {"name": "weather-forecast", "file_format": {"value": "pdf", "source_value": "abc"}, "content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", "category_id": "6530", "path": "/path/to/file", "category": {"value": "reports, resumes", "source_value": "550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME"}, "confidential": {"value": "true", "source_value": "public"}} responses: "201": - application/json: {"statusCode": 201, "message": "Employee created successfully", "timestamp": "2021-01-01T01:01:01.000Z", "provider_errors": [{"status": 400, "url": "https://api.someprovider.com/v1/endpoint"}]} + application/json: {"statusCode": 201, "message": "Employee created successfully", "timestamp": "2021-01-01T01:01:01.000Z", "provider_errors": [{"status": 400, "url": "https://api.someprovider.com/v1/endpoint"}], "unified_warnings": [{"message": "The provided field type is not supported in the current model."}]} ats_download_application_document: "": parameters: @@ -3605,8 +3884,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3620,6 +3901,7 @@ examples: id: "" subResourceId: "" query: + raw: false fields: "id,remote_id,name,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format" header: x-account-id: "" @@ -3630,22 +3912,24 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" include: "custom_fields" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}, {"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}, {"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}, {"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}, {"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}, {"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} ats_create_candidate: speakeasy-default-ats-create-candidate: parameters: header: x-account-id: "" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "phone_number": "+1234567890", "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer", "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "phone_number": "+1234567890", "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}, {"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer", "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} responses: "200": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3655,13 +3939,14 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at" include: "custom_fields" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}, {"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}, {"phone": "+447700112233"}, {"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} ats_update_candidate: speakeasy-default-ats-update-candidate: parameters: @@ -3670,7 +3955,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [], "phone_numbers": [{"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": []} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} responses: "200": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3680,8 +3965,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3696,7 +3983,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"content": [], "author_id": "1234567890", "passthrough": {"other_known_names": "John Doe"}} + application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "passthrough": {"other_known_names": "John Doe"}} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3707,18 +3994,21 @@ examples: id: "" subResourceId: "" query: + raw: false fields: "id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "visibility": {"value": "public", "source_value": "Public"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}, {"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}} ats_list_application_custom_field_definitions: "": parameters: query: + raw: false fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3731,8 +4021,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3743,8 +4035,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3757,8 +4051,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3769,8 +4065,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3783,8 +4081,10 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3795,8 +4095,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3809,6 +4111,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name" header: x-account-id: "" @@ -3819,8 +4122,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,order,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3833,6 +4138,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,order,created_at,updated_at" header: x-account-id: "" @@ -3843,32 +4149,37 @@ examples: "": parameters: query: + raw: false 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" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} ats_get_interview: "": parameters: path: id: "" query: + raw: false 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" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} ats_list_jobs: "": parameters: query: + raw: false fields: "id,remote_id,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" expand: "job_postings,interview_stages" include: "custom_fields" @@ -3883,7 +4194,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3893,6 +4204,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at" expand: "job_postings,interview_stages" include: "custom_fields" @@ -3900,7 +4212,7 @@ examples: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "remote_department_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "location_ids": ["668570", "678571", "688572"], "remote_location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "remote_department_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "location_ids": ["668570", "678571", "688572"], "remote_location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} ats_update_job: speakeasy-default-ats-update-job: parameters: @@ -3909,7 +4221,7 @@ examples: header: x-account-id: "" requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [], "passthrough": {"other_known_names": "John Doe"}} + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -3917,8 +4229,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,name,created_at,updated_at,items,type" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3931,18 +4245,21 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name,created_at,updated_at,items,type" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}} ats_list_locations: "": parameters: query: + raw: false fields: "id,remote_id,name" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3955,6 +4272,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,name" header: x-account-id: "" @@ -3965,8 +4283,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,label,type,rejected_reason_type" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -3979,6 +4299,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,label,type,rejected_reason_type" header: x-account-id: "" @@ -3989,8 +4310,10 @@ examples: "": parameters: query: + raw: false fields: "id,remote_id,first_name,last_name,name,email" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -4003,6 +4326,7 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,first_name,last_name,name,email" header: x-account-id: "" @@ -4013,40 +4337,45 @@ examples: "": parameters: query: + raw: false 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" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" include: "questionnaires" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "New York"}, {"id": "67890", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "responsibilities", "source_value": "key_responsibilities"}, "label": "Key Responsibilities", "content": "This is a plain description"}]}, "compensation": [{"name": "Base Salary", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "50000", "min_value": "45000", "max_value": "55000"}, {"name": "Bonus", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "About", "internal": "false", "questions": [{"id": "question001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your name?", "required": true, "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question002", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What are your hobbies?", "required": "true", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question003", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your favorite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Dog"}, {"id": "2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Cat"}, {"id": "3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Bird"}, {"id": "4", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Other"}]}]}, {"id": "experience001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Please upload your resume.", "required": true, "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question005", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "JavaScript"}, {"id": "2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Python"}, {"id": "3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Java"}]}, {"id": "question006", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Are you willing to relocate?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question007", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How many years of experience do you have?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question008", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "When did you start your most recent position?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}]}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "New York"}, {"id": "67890", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "responsibilities", "source_value": "key_responsibilities"}, "label": "Key Responsibilities", "content": "This is a plain description"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "responsibilities", "source_value": "key_responsibilities"}, "label": "Key Responsibilities", "content": "This is a plain description"}]}, "compensation": [{"name": "Base Salary", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "50000", "min_value": "45000", "max_value": "55000"}, {"name": "Bonus", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "About", "internal": "false", "questions": [{"id": "question001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your name?", "required": true, "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question002", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What are your hobbies?", "required": true, "multiple_choice_answers": []}, {"id": "question003", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your favorite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Dog"}, {"id": "2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Cat"}, {"id": "3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Bird"}, {"id": "4", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Other"}]}]}, {"id": "experience001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Please upload your resume.", "required": true, "multiple_choice_answers": []}, {"id": "question005", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "JavaScript"}, {"id": "2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Python"}, {"id": "3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Java"}]}, {"id": "question006", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Are you willing to relocate?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question007", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How many years of experience do you have?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question008", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "When did you start your most recent position?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}]}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "name": "New York"}, {"id": "67890", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

"}, "compensation": [{"name": "Base Salary", "currency": "USD", "value": "50000", "min_value": "45000", "max_value": "55000"}, {"name": "Bonus", "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "name": "About", "internal": "false", "questions": [{"id": "question001", "text": "What is your name?", "required": true, "parent_question": null}, {"id": "question002", "text": "What are your hobbies?", "required": "true", "parent_question": null}, {"id": "question003", "text": "What is your favorite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Dog"}, {"id": "2", "text": "Cat"}, {"id": "3", "text": "Bird"}, {"id": "4", "text": "Other"}], "parent_question": null}, {"id": "question004", "text": "Do you have previous work experience??", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question005", "text": "What was the duration of your last employment?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Less than 1 year"}, {"id": "2", "text": "1-2 years"}, {"id": "2", "text": "More than 2 year"}], "parent_question": {"id": "question004", "option_ids": ["1"]}}]}, {"id": "experience001", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "text": "Please upload your resume.", "required": true, "parent_question": null}, {"id": "question005", "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "text": "JavaScript"}, {"id": "2", "text": "Python"}, {"id": "3", "text": "Java"}], "parent_question": null}, {"id": "question006", "text": "Are you willing to relocate?", "parent_question": null}, {"id": "question007", "text": "How many years of experience do you have?", "parent_question": null}, {"id": "question008", "text": "When did you start your most recent position?", "parent_question": null}, {"id": "question009", "text": "Do you have Project Management Experience?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question010", "text": "How much Project Management experience do you have?", "multiple_choice_answers": [{"id": "1", "text": "1-3 years"}, {"id": "2", "text": "3-5 years"}, {"id": "3", "text": "5-10 years"}, {"id": "4", "text": "More than 10 years"}], "parent_question": {"id": "question009", "option_ids": ["1"]}}]}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "name": "New York"}, {"id": "67890", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

"}, "compensation": [{"name": "Base Salary", "currency": "USD", "value": "50000", "min_value": "45000", "max_value": "55000"}, {"name": "Bonus", "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "name": "About", "internal": "false", "questions": [{"id": "question001", "text": "What is your name?", "required": true, "parent_question": null}, {"id": "question002", "text": "What are your hobbies?", "required": "true", "parent_question": null}, {"id": "question003", "text": "What is your favorite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Dog"}, {"id": "2", "text": "Cat"}, {"id": "3", "text": "Bird"}, {"id": "4", "text": "Other"}], "parent_question": null}, {"id": "question004", "text": "Do you have previous work experience??", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question005", "text": "What was the duration of your last employment?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Less than 1 year"}, {"id": "2", "text": "1-2 years"}, {"id": "2", "text": "More than 2 year"}], "parent_question": {"id": "question004", "option_ids": ["1"]}}]}, {"id": "experience001", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "text": "Please upload your resume.", "required": true, "parent_question": null}, {"id": "question005", "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "text": "JavaScript"}, {"id": "2", "text": "Python"}, {"id": "3", "text": "Java"}], "parent_question": null}, {"id": "question006", "text": "Are you willing to relocate?", "parent_question": null}, {"id": "question007", "text": "How many years of experience do you have?", "parent_question": null}, {"id": "question008", "text": "When did you start your most recent position?", "parent_question": null}, {"id": "question009", "text": "Do you have Project Management Experience?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question010", "text": "How much Project Management experience do you have?", "multiple_choice_answers": [{"id": "1", "text": "1-3 years"}, {"id": "2", "text": "3-5 years"}, {"id": "3", "text": "5-10 years"}, {"id": "4", "text": "More than 10 years"}], "parent_question": {"id": "question009", "option_ids": ["1"]}}]}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} ats_get_job_posting: "": parameters: path: id: "" query: + raw: false 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" include: "questionnaires" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "New York"}, {"id": "67890", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

", "sections": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "responsibilities", "source_value": "key_responsibilities"}, "label": "Key Responsibilities", "content": "This is a plain description"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "responsibilities", "source_value": "key_responsibilities"}, "label": "Key Responsibilities", "content": "This is a plain description"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "responsibilities", "source_value": "key_responsibilities"}, "label": "Key Responsibilities", "content": "This is a plain description"}]}, "compensation": [{"name": "Base Salary", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "50000", "min_value": "45000", "max_value": "55000"}, {"name": "Bonus", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "About", "internal": "false", "questions": [{"id": "question001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your name?", "required": true, "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question002", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What are your hobbies?", "required": "true", "multiple_choice_answers": []}, {"id": "question003", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your favorite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Dog"}, {"id": "2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Cat"}, {"id": "3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Bird"}, {"id": "4", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Other"}]}]}, {"id": "experience001", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Please upload your resume.", "required": true, "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question005", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "JavaScript"}, {"id": "2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Python"}, {"id": "3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "text": "Java"}]}, {"id": "question006", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Are you willing to relocate?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question007", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How many years of experience do you have?", "multiple_choice_answers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}]}, {"id": "question008", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "When did you start your most recent position?", "multiple_choice_answers": []}]}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "name": "New York"}, {"id": "67890", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

"}, "compensation": [{"name": "Base Salary", "currency": "USD", "value": "50000", "min_value": "45000", "max_value": "55000"}, {"name": "Bonus", "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "name": "About", "internal": "false", "questions": [{"id": "question001", "text": "What is your name?", "required": true, "parent_question": null}, {"id": "question002", "text": "What are your hobbies?", "required": "true", "parent_question": null}, {"id": "question003", "text": "What is your favorite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Dog"}, {"id": "2", "text": "Cat"}, {"id": "3", "text": "Bird"}, {"id": "4", "text": "Other"}], "parent_question": null}, {"id": "question004", "text": "Do you have previous work experience??", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question005", "text": "What was the duration of your last employment?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Less than 1 year"}, {"id": "2", "text": "1-2 years"}, {"id": "2", "text": "More than 2 year"}], "parent_question": {"id": "question004", "option_ids": ["1"]}}]}, {"id": "experience001", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "text": "Please upload your resume.", "required": true, "parent_question": null}, {"id": "question005", "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "text": "JavaScript"}, {"id": "2", "text": "Python"}, {"id": "3", "text": "Java"}], "parent_question": null}, {"id": "question006", "text": "Are you willing to relocate?", "parent_question": null}, {"id": "question007", "text": "How many years of experience do you have?", "parent_question": null}, {"id": "question008", "text": "When did you start your most recent position?", "parent_question": null}, {"id": "question009", "text": "Do you have Project Management Experience?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question010", "text": "How much Project Management experience do you have?", "multiple_choice_answers": [{"id": "1", "text": "1-3 years"}, {"id": "2", "text": "3-5 years"}, {"id": "3", "text": "5-10 years"}, {"id": "4", "text": "More than 10 years"}], "parent_question": {"id": "question009", "option_ids": ["1"]}}]}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} ats_list_offers: "": parameters: query: + raw: false fields: "id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": []}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}]} + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}]} ats_create_offer: speakeasy-default-ats-create-offer: parameters: @@ -4063,17 +4392,20 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": []}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}} ats_list_assessments_packages: "": parameters: query: + raw: false filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" @@ -4085,7 +4417,8 @@ examples: parameters: path: id: "" - query: {} + query: + raw: false header: x-account-id: "" responses: @@ -4097,1069 +4430,1009 @@ examples: path: id: "" query: + raw: false fields: "id,remote_id,package,application,job,candidate,requester,results_update_url" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update"}} ats_get_assessments_result: "": parameters: path: id: "" query: + raw: false fields: "id,remote_id,candidate,score,start_date,submission_date,summary,result,result_url,attachments" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "score": {"label": "Percentage", "value": "80", "min": "0", "max": "100"}, "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Candidate demonstrates strong understanding of core concepts, but struggles with application", "result": {"value": "passed", "source_value": "Passed"}, "result_url": "https://exmaple.com/result?id=xyz", "attachments": [{"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}]}} - crm_list_contacts: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "score": {"label": "Percentage", "value": "80", "min": "0", "max": "100"}, "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed", "result": {"value": "passed", "source_value": "Passed"}, "result_url": "https://exmaple.com/result?id=xyz", "attachments": [{"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}, {"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}]}} + ats_list_background_check_packages: "": parameters: query: - 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" + raw: false + fields: "id,remote_id,name,description,tests" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" - include: "custom_fields" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} - crm_create_contact: - speakeasy-default-crm-create-contact: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}]} + ats_create_background_check_package: + speakeasy-default-ats-create-background-check-package: parameters: header: x-account-id: "" requestBody: - application/json: {"first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "account_ids": ["account-123", "account-456"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} + application/json: {"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}], "passthrough": {"other_known_names": "John Doe"}} responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - crm_get_contact: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + ats_get_background_check_package: "": parameters: path: id: "" query: - 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" - include: "custom_fields" - header: - x-account-id: "" - responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - crm_update_contact: - speakeasy-default-crm-update-contact: - parameters: - path: - id: "" + raw: false + fields: "id,remote_id,name,description,tests" header: x-account-id: "" - requestBody: - application/json: {"first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "account_ids": ["account-123", "account-456"], "custom_fields": [], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - crm_list_accounts: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}} + ats_list_background_check_request: "": parameters: query: - fields: "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at" + raw: false + fields: "id,remote_id,package,application,job,candidate,requester,results_update_url" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [{"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}, {"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} - crm_get_account: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}]} + ats_get_background_check_request: "": parameters: path: id: "" query: - fields: "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at" + raw: false + fields: "id,remote_id,package,application,job,candidate,requester,results_update_url" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - crm_list_lists: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}} + ats_get_background_check_result: "": parameters: + path: + id: "" query: - fields: "id,remote_id,name,created_at,updated_at,items,type" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" + raw: false + fields: "id,remote_id,candidate,score,start_date,submission_date,summary,result,result_url,attachments" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}]} - crm_get_list: - "": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "score": {"label": "Percentage", "value": "80", "min": "0", "max": "100"}, "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed", "result": {"value": "passed", "source_value": "Passed"}, "result_url": "https://exmaple.com/result?id=xyz", "attachments": [{"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}, {"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}, {"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}]}} + lms_batch_upsert_course: + speakeasy-default-lms-batch-upsert-course: parameters: - path: - id: "" - query: - fields: "id,remote_id,name,created_at,updated_at,items,type" header: x-account-id: "" + requestBody: + application/json: {"items": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-Content"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "provider": "Course Provider", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}, {"id": "16873-IT345", "name": "Information-Technology"}, {"id": "16873-IT345", "name": "Information-Technology"}], "content": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}]}, {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-Content"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}, {"value": "en_GB"}, {"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "provider": "Course Provider", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}, {"id": "16873-IT345", "name": "Information-Technology"}], "content": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}, {"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}, {"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}]}]} responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}} - iam_list_users: + "202": + application/json: {"statusCode": 202, "message": "Batch operation accepted", "timestamp": "2021-01-01T01:01:01.000Z", "errors": [["Missing field: name"], [], []]} + lms_list_courses: "": parameters: query: - fields: "id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled" + raw: false + fields: "id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" - expand: "roles,groups" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}, {"value": "totp"}, {"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}, {"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}}}]} - iam_get_user: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_content_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "name": "Technology"}], "skills": [{"id": "12345", "name": "Sales Techniques"}], "provider": "Course Provider", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}]} + lms_upsert_course: + speakeasy-default-lms-upsert-course: + parameters: + header: + x-account-id: "" + requestBody: + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-Content"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "provider": "Course Provider", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "content": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}]} + responses: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"}} + lms_get_course: "": parameters: path: id: "" query: - fields: "id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled" - expand: "roles,groups" + raw: false + fields: "id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}, {"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}}}} - iam_list_roles: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_content_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "name": "Technology"}], "skills": [{"id": "12345", "name": "Sales Techniques"}], "provider": "Course Provider", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}} + lms_list_user_assignments: "": parameters: + path: + id: "" query: - fields: "id,remote_id,name,type,policies,description,created_at,updated_at" + raw: false + fields: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" - expand: "policies" + user_id: "c28xyrc55866bvuv" + remote_user_id: "e3cb75bf-aa84-466e-a6c1-b8322b257a48" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} - iam_get_role: - "": + application/json: {"data": [{"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "e3gd34-23tr21-er234-345er56", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "in_progress"}, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "e3gd34-23tr21-er234-345er56", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "in_progress"}, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} + lms_create_user_assignment: + speakeasy-default-lms-create-user-assignment: parameters: path: id: "" - query: - fields: "id,remote_id,name,type,policies,description,created_at,updated_at" - expand: "policies" header: x-account-id: "" + requestBody: + application/json: {"passthrough": {"other_known_names": "John Doe"}, "external_reference": "e3gd34-23tr21-er234-345er56", "learning_object_id": "e3gd34-23tr21-er234-345er56", "learning_object_external_reference": "learning-content-123", "progress": "40", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "pending"}} responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - iam_list_groups: - "": + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + lms_get_user_assignment: + speakeasy-default-lms-get-user-assignment: parameters: + path: + id: "" + subResourceId: "" query: - fields: "id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" - expand: "roles" + raw: false header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} - iam_get_group: - "": + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "e3gd34-23tr21-er234-345er56", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "completed"}, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} + lms_batch_upsert_content: + speakeasy-default-lms-batch-upsert-content: parameters: - path: - id: "" - query: - fields: "id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at" - expand: "roles" header: x-account-id: "" + requestBody: + application/json: {"items": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "short_description": "This course is a valuable resource and acts as learning content for...", "languages": [{"value": "en_GB"}, {"value": "en_GB"}, {"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "order": 1, "provider": "Content Provider", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}]}, {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "short_description": "This course is a valuable resource and acts as learning content for...", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "order": 1, "provider": "Content Provider", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}]}]} responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - iam_list_policies: + "202": + application/json: {"statusCode": 202, "message": "Batch operation accepted", "timestamp": "2021-01-01T01:01:01.000Z", "errors": [["Missing field: name"], [], []]} + lms_list_content: "": parameters: query: - fields: "id,remote_id,name,permissions,description,created_at,updated_at" + raw: false + fields: "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" - expand: "permissions" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} - iam_get_policy: + application/json: {"data": [{"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}, {"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}, {"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}]} + lms_upsert_content: + speakeasy-default-lms-upsert-content: + parameters: + header: + x-account-id: "" + requestBody: + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "short_description": "This course is a valuable resource and acts as learning content for...", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "order": 1, "provider": "Content Provider", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}]} + responses: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"}} + lms_get_content: "": parameters: path: id: "" query: - fields: "id,remote_id,name,permissions,description,created_at,updated_at" - expand: "permissions" + raw: false + fields: "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - marketing_list_email_templates: + application/json: {"data": {"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}} + lms_list_user_completions: "": parameters: + path: + id: "" query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} - marketing_create_email_template: - speakeasy-default-marketing-create-email-template: + application/json: {"data": []} + lms_create_user_completion: + speakeasy-default-lms-create-user-completion: parameters: + path: + id: "" header: x-account-id: "" requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "external_reference": "e3gd34-23tr21-er234-345er56", "completed_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "learning_object_external_reference": "learning-content-123"} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_get_email_template: - "": + lms_get_user_completion: + speakeasy-default-lms-get-user-completion: parameters: path: id: "" + subResourceId: "" query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" - header: - x-account-id: "" - responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} - marketing_update_email_template: - speakeasy-default-marketing-update-email-template: - parameters: - path: - id: "" + raw: false header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_list_in_app_templates: + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "e3gd34-23tr21-er234-345er56", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} + lms_list_completions: "": parameters: query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} - marketing_create_in_app_template: - speakeasy-default-marketing-create-in-app-template: - parameters: - header: - x-account-id: "" - requestBody: - application/json: {"messages": [], "passthrough": {"other_known_names": "John Doe"}} - responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_get_in_app_template: - "": + application/json: {"data": []} + lms_get_completion: + speakeasy-default-lms-get-completion: parameters: path: id: "" query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": []}} - marketing_update_in_app_template: - speakeasy-default-marketing-update-in-app-template: + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "e3gd34-23tr21-er234-345er56", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} + lms_get_category: + "": parameters: path: id: "" + query: + raw: false + fields: "id,remote_id,name,active,level,language" header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_list_sms_templates: + application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}}} + lms_list_categories: "": parameters: query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,name,active,level,language" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} - marketing_create_sms_template: - speakeasy-default-marketing-create-sms-template: + application/json: {"data": []} + lms_list_users: + "": parameters: + query: + raw: false + fields: "id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_get_sms_template: + "200": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + lms_get_user: "": parameters: path: id: "" query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} - marketing_update_sms_template: - speakeasy-default-marketing-update-sms-template: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + lms_get_skill: + "": parameters: path: id: "" + query: + raw: false + fields: "id,remote_id,name,active,level" header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_list_omni_channel_templates: + application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}} + lms_list_skills: "": parameters: query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,name,active,level" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": []} - marketing_create_omni_channel_template: - speakeasy-default-marketing-create-omni-channel-template: + application/json: {"data": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}, {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}]} + lms_list_assignments: + "": parameters: + query: + raw: false + fields: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + user_id: "c28xyrc55866bvuv" + remote_user_id: "e3cb75bf-aa84-466e-a6c1-b8322b257a48" header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_get_omni_channel_template: - "": + "200": + application/json: {"data": []} + lms_get_assignment: + speakeasy-default-lms-get-assignment: parameters: path: id: "" query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z"}} - marketing_update_omni_channel_template: - speakeasy-default-marketing-update-omni-channel-template: + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "e3gd34-23tr21-er234-345er56", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "completed"}, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} + lms_create_collection: + speakeasy-default-lms-create-collection: + parameters: + header: + x-account-id: "" + requestBody: + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-collection-1", "learning_object_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_learning_object_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1 Collection", "description": "This collection acts as learning pathway for software engineers.", "cover_url": "https://www.googledrive.com/?v=16873", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}, {"id": "16873-IT345", "name": "Information-Technology"}, {"id": "16873-IT345", "name": "Information-Technology"}]} + responses: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + lms_update_collection: + speakeasy-default-lms-update-collection: parameters: path: id: "" header: x-account-id: "" requestBody: - application/json: {"messages": [], "passthrough": {"other_known_names": "John Doe"}} + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-collection-1", "learning_object_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_learning_object_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1 Collection", "description": "This collection acts as learning pathway for software engineers.", "cover_url": "https://www.googledrive.com/?v=16873", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}, {"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}, {"id": "16873-IT345", "name": "Information-Technology"}]} responses: - "200": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_list_push_templates: + "201": + application/json: {"statusCode": 200, "message": "Record updated successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} + iam_list_users: "": parameters: query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" + expand: "roles,groups" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": []}]} - marketing_create_push_template: - speakeasy-default-marketing-create-push-template: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}, {"value": "totp"}, {"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}}}]} + iam_get_user: + "": parameters: + path: + id: "" + query: + raw: false + fields: "id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled" + expand: "roles,groups" header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_get_push_template: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}, {"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "path": "/path/to/file", "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "abc"}}}} + iam_list_roles: "": parameters: - path: - id: "" query: - fields: "id,remote_id,name,messages,created_at,updated_at,tags" + raw: false + fields: "id,remote_id,name,type,policies,description,created_at,updated_at" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" + expand: "policies" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} - marketing_update_push_template: - speakeasy-default-marketing-update-push-template: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + iam_get_role: + "": parameters: path: id: "" + query: + raw: false + fields: "id,remote_id,name,type,policies,description,created_at,updated_at" + expand: "policies" header: x-account-id: "" - requestBody: - application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_list_campaigns: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + iam_list_groups: "": parameters: query: - fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages" + raw: false + fields: "id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" + expand: "roles" header: x-account-id: "" responses: "200": - application/json: {"data": []} - marketing_get_campaign: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + iam_get_group: "": parameters: path: id: "" query: - fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages" + raw: false + fields: "id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at" + expand: "roles" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "schedule_type": {"value": "immediate", "source_value": "Immediate"}, "status": {"value": "draft", "source_value": "Email"}, "channels": [{"value": "sms", "source_value": "SMS"}, {"value": "sms", "source_value": "SMS"}, {"value": "sms", "source_value": "SMS"}], "first_sent_at": "2021-01-01T01:01:01.000Z", "last_sent_at": "2021-01-01T01:01:01.000Z", "messages": [{"id": "message-id-1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "SMS Message", "message_type": {"value": "email", "source_value": "Email"}, "message_content": {"body": "This is an example SMS body.", "from": "1-555-123-4567"}}, {"id": "message-id-2", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Email Message", "message_type": {"value": "email", "source_value": "Email"}, "message_content": {"subject": "Example Email Subject", "body": "

This is an example

\n

email body

", "from": "Jane Smith", "reply-to": "reply@example.com", "preheader": "This is the preheader of the email."}}, {"id": "message-id-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "iOS Push Message", "message_type": {"value": "email", "source_value": "Email"}, "message_content": {"body": "This is an example push notification body."}}]}} - marketing_list_content_blocks: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + iam_list_policies: "": parameters: query: - fields: "id,remote_id,name,type,content,status,tags,created_at,updated_at" + raw: false + fields: "id,remote_id,name,permissions,description,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" + expand: "permissions" header: x-account-id: "" responses: "200": - application/json: {"data": []} - marketing_create_content_block: - speakeasy-default-marketing-create-content-block: - parameters: - header: - x-account-id: "" - requestBody: - application/json: {"type": {"value": "html", "source_value": "text"}, "passthrough": {"other_known_names": "John Doe"}} - responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - marketing_get_content_block: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + iam_get_policy: "": parameters: path: id: "" query: - fields: "id,remote_id,name,type,content,status,tags,created_at,updated_at" + raw: false + fields: "id,remote_id,name,permissions,description,created_at,updated_at" + expand: "permissions" header: x-account-id: "" responses: "200": - application/json: {"data": {}} - marketing_update_content_block: - speakeasy-default-marketing-update-content-block: - parameters: - path: - id: "" - header: - x-account-id: "" - requestBody: - application/json: {"type": {"value": "html", "source_value": "text"}, "passthrough": {"other_known_names": "John Doe"}} - responses: - "200": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - lms_list_courses: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + crm_list_contacts: "": parameters: query: - fields: "id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content" + raw: false + 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" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" + include: "custom_fields" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "16873-ENG-VIDEO-1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_content_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Technology", "active": true}], "skills": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Sales Techniques", "active": true}], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}]} - lms_get_course: - "": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + crm_create_contact: + speakeasy-default-crm-create-contact: parameters: - path: - id: "" - query: - fields: "id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content" header: x-account-id: "" + requestBody: + application/json: {"first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "account_ids": ["account-123", "account-456"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"data": {"id": "16873-ENG-VIDEO-1", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_content_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Technology", "active": true}], "skills": [{"id": "12345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Sales Techniques", "active": true}], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}} - lms_list_user_assignments: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + crm_get_contact: "": parameters: path: id: "" query: - fields: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" - user_id: "c28xyrc55866bvuv" - remote_user_id: "e3cb75bf-aa84-466e-a6c1-b8322b257a48" + raw: false + 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" + include: "custom_fields" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "e3gd34-23tr21-er234-345er56", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "course_id": "16873-ENG-1", "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "e3gd34-23tr21-er234-345er56", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "course_id": "16873-ENG-1", "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} - lms_get_user_assignment: - speakeasy-default-lms-get-user-assignment: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + crm_update_contact: + speakeasy-default-crm-update-contact: parameters: path: id: "" - subResourceId: "" - query: {} - header: - x-account-id: "" - responses: - "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "course_id": "16873-ENG-1", "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} - lms_batch_upsert_content: - speakeasy-default-lms-batch-upsert-content: - parameters: header: x-account-id: "" requestBody: - application/json: {"items": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "order": 1, "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}]}, {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "order": 1, "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}]}]} + application/json: {"first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "account_ids": ["account-123", "account-456"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: - "202": - application/json: {"statusCode": 202, "message": "Batch operation accepted", "timestamp": "2021-01-01T01:01:01.000Z", "errors": [["Missing field: name"], [], []]} - lms_list_content: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + crm_list_accounts: "": parameters: query: - fields: "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at" + raw: false + fields: "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}, {"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}, {"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}]} - lms_upsert_content: - speakeasy-default-lms-upsert-content: - parameters: - header: - x-account-id: "" - requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "order": 1, "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}]} - responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"}} - lms_create_content: - speakeasy-default-lms-create-content: - parameters: - header: - x-account-id: "" - requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}], "order": 1, "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "active": true}]} - responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"}} - lms_get_content: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [{"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}, {"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [{"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} + crm_get_account: "": parameters: path: id: "" query: - fields: "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at" + raw: false + fields: "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at" header: x-account-id: "" responses: "200": - application/json: {"data": {"url": "https://example.com/file.pdf", "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", "file_format": {"value": "pdf", "source_value": "abc"}}} - lms_update_content: - speakeasy-default-lms-update-content: - parameters: - path: - id: "" - header: - x-account-id: "" - requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}, {"value": "en_GB"}, {"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}], "order": 1, "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "active": true}]} - responses: - "201": - application/json: {"statusCode": 200, "message": "Record updated successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} - lms_list_user_completions: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [{"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + crm_list_lists: "": parameters: - path: - id: "" query: - fields: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + raw: false + fields: "id,remote_id,name,created_at,updated_at,items,type" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": []} - lms_create_user_completion: - speakeasy-default-lms-create-user-completion: - parameters: - path: - id: "" - header: - x-account-id: "" - requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "completed_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "learning_object_external_reference": "learning-content-123", "external_id": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION", "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT", "content_id": "16873-ENG-VIDEO-1"} - responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - lms_get_user_completion: - speakeasy-default-lms-get-user-completion: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}]} + crm_get_list: + "": parameters: path: id: "" - subResourceId: "" - query: {} + query: + raw: false + fields: "id,remote_id,name,created_at,updated_at,items,type" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "external_id": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION", "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT", "remote_external_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content_id": "16873-ENG-VIDEO-1", "remote_content_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "course_id": "16873-ENG-COURSE-1", "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} - lms_list_completions: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}} + crm_list_contact_custom_field_definitions: "": parameters: query: - fields: "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" + raw: false + fields: "id,remote_id,name,description,type,options" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": application/json: {"data": []} - lms_get_completion: - speakeasy-default-lms-get-completion: - parameters: - path: - id: "" - query: {} - header: - x-account-id: "" - responses: - "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "external_id": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION", "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT", "remote_external_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content_id": "16873-ENG-VIDEO-1", "remote_content_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "course_id": "16873-ENG-COURSE-1", "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} - lms_get_category: + crm_get_contact_custom_field_definition: "": parameters: path: id: "" query: - fields: "id,remote_id,name,active,level" + raw: false + fields: "id,remote_id,name,description,type,options" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "active": true}} - lms_list_categories: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "options": ["Not Started", "In Progress", "Completed", "Overdue"]}} + marketing_list_email_templates: "": parameters: query: - fields: "id,remote_id,name,active,level" + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": []} - lms_list_users: - "": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} + marketing_create_email_template: + speakeasy-default-marketing-create-email-template: parameters: - query: - fields: "id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" + requestBody: + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} - lms_get_user: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_get_email_template: "": parameters: path: id: "" query: - fields: "id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name" + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - lms_get_skill: - "": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} + marketing_update_email_template: + speakeasy-default-marketing-update-email-template: parameters: path: id: "" - query: - fields: "id,remote_id,name,active,level" header: x-account-id: "" + requestBody: + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}} - lms_list_skills: + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_list_in_app_templates: "": parameters: query: - fields: "id,remote_id,name,active,level" + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}, {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true}]} - lms_list_assignments: - "": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} + marketing_create_in_app_template: + speakeasy-default-marketing-create-in-app-template: parameters: - query: - fields: "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" - user_id: "c28xyrc55866bvuv" - remote_user_id: "e3cb75bf-aa84-466e-a6c1-b8322b257a48" header: x-account-id: "" + requestBody: + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "200": - application/json: {"data": []} - lms_get_assignment: - speakeasy-default-lms-get-assignment: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_get_in_app_template: + "": parameters: path: id: "" - query: {} + query: + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": "40", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "course_id": "16873-ENG-1", "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}} - hris_list_cost_center_groups: - "": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} + marketing_update_in_app_template: + speakeasy-default-marketing-update-in-app-template: parameters: - query: - fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" + path: + id: "" header: x-account-id: "" + requestBody: + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}]} - hris_get_cost_center_group: + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_list_sms_templates: "": parameters: - path: - id: "" query: - fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids" + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "type": {"value": "team"}}} - create: - speakeasy-default-create: + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} + marketing_create_sms_template: + speakeasy-default-marketing-create-sms-template: parameters: - path: - id: "6384.24" header: x-account-id: "" requestBody: - application/json: [{"event": "hris_employees.created", "record_id": ""}] + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "207": - application/json: [{"event": "hris_employees.created", "record_id": "", "status": 200, "message": "The event was created"}] - hris_create_employee_employment: - speakeasy-default-hris-create-employee-employment: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_get_sms_template: + "": parameters: path: id: "" + query: + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" header: x-account-id: "" - requestBody: - application/json: {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "passthrough": {"other_known_names": "John Doe"}} responses: - "201": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - hris_update_employee_employment: - speakeasy-default-hris-update-employee-employment: + "200": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} + marketing_update_sms_template: + speakeasy-default-marketing-update-sms-template: parameters: path: id: "" - subResourceId: "" header: x-account-id: "" requestBody: - application/json: {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "passthrough": {"other_known_names": "John Doe"}} + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_title": "Software Engineer", "pay_rate": "40.00", "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "time_worked": "P0Y0M0DT8H0M0S", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} - crm_list_contact_custom_field_definitions: + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_list_omni_channel_templates: "": parameters: query: - fields: "id,remote_id,name,description,type,options" + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": application/json: {"data": []} - crm_get_contact_custom_field_definition: - "": + marketing_create_omni_channel_template: + speakeasy-default-marketing-create-omni-channel-template: parameters: - path: - id: "" - query: - fields: "id,remote_id,name,description,type,options" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" + requestBody: + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "options": ["Not Started", "In Progress", "Completed", "Overdue"]}} - lms_delete_content: - speakeasy-default-lms-delete-content: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_get_omni_channel_template: + "": parameters: path: id: "" + query: + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" header: x-account-id: "" responses: "200": - application/json: {"statusCode": 200, "message": "Record deleted successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} - lms_batch_upsert_course: - speakeasy-default-lms-batch-upsert-course: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z"}} + marketing_update_omni_channel_template: + speakeasy-default-marketing-update-omni-channel-template: parameters: + path: + id: "" header: x-account-id: "" requestBody: - application/json: {"items": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-Content"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "content": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}, {"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}]}, {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-Content"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}, {"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "content": []}]} + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: - "202": - application/json: {"statusCode": 202, "message": "Batch operation accepted", "timestamp": "2021-01-01T01:01:01.000Z", "errors": [["Missing field: name"], [], []]} - lms_upsert_course: - speakeasy-default-lms-upsert-course: + "200": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_list_push_templates: + "": parameters: + query: + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" + filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" + updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" - requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-Content"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}], "content": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "content_url": "https://www.youtube.com/watch?v=16873", "order": 1}]} responses: - "201": - application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"}} - lms_create_collection: - speakeasy-default-lms-create-collection: + "200": + application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} + marketing_create_push_template: + speakeasy-default-marketing-create-push-template: parameters: header: x-account-id: "" requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-collection-1", "learning_object_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_learning_object_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1 Collection", "description": "This collection acts as learning pathway for software engineers.", "cover_url": "https://www.googledrive.com/?v=16873", "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}]} + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - lms_update_collection: - speakeasy-default-lms-update-collection: + marketing_get_push_template: + "": parameters: path: id: "" - header: - x-account-id: "" - requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-collection-1", "learning_object_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_learning_object_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1 Collection", "description": "This collection acts as learning pathway for software engineers.", "cover_url": "https://www.googledrive.com/?v=16873", "categories": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology"}], "skills": [{"id": "16873-IT345", "name": "Information-Technology"}]} - responses: - "201": - application/json: {"statusCode": 200, "message": "Record updated successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} - hris_list_time_off_types: - "": - parameters: query: - fields: "id,remote_id,name,active" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" + raw: false + fields: "id,remote_id,name,messages,created_at,updated_at,tags" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}]} - hris_get_time_off_type: - "": + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} + marketing_update_push_template: + speakeasy-default-marketing-update-push-template: parameters: path: id: "" - query: - fields: "id,remote_id,name,active" header: x-account-id: "" + requestBody: + application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: "200": - application/json: {"data": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}} - hris_list_employee_custom_field_definitions: + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + marketing_list_campaigns: "": parameters: query: - fields: "id,remote_id,name,description,type,options" + raw: false + fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": application/json: {"data": []} - hris_get_employee_custom_field_definition: + marketing_get_campaign: "": parameters: path: id: "" query: - fields: "id,remote_id,name,description,type,options" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" + raw: false + fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "options": ["Not Started", "In Progress", "Completed", "Overdue"]}} - ats_list_background_check_packages: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "schedule_type": {"value": "immediate", "source_value": "Immediate"}, "status": {"value": "draft", "source_value": "Email"}, "channels": [{"value": "sms", "source_value": "SMS"}, {"value": "sms", "source_value": "SMS"}, {"value": "sms", "source_value": "SMS"}], "first_sent_at": "2021-01-01T01:01:01.000Z", "last_sent_at": "2021-01-01T01:01:01.000Z", "messages": [{"id": "message-id-1", "name": "SMS Message", "message_type": {"value": "sms"}, "message_content": {"body": "This is an example SMS body.", "from": "1-555-123-4567"}}, {"id": "message-id-2", "name": "Email Message", "message_type": {"value": "email"}, "message_content": {"subject": "Example Email Subject", "body": "

This is an example

\n

email body

", "from": "Jane Smith", "reply-to": "reply@example.com", "preheader": "This is the preheader of the email."}}, {"id": "message-id-3", "name": "iOS Push Message", "message_type": {"value": "ios_push"}, "message_content": {"body": "This is an example push notification body."}}]}} + marketing_list_content_blocks: "": parameters: query: - fields: "id,remote_id,name,description,tests" + raw: false + fields: "id,remote_id,name,type,content,status,tags,created_at,updated_at" filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + page_size: "25" updated_after: "2020-01-01T00:00:00.000Z" header: x-account-id: "" responses: "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}]} - ats_create_background_check_package: - speakeasy-default-ats-create-background-check-package: + application/json: {"data": []} + marketing_create_content_block: + speakeasy-default-marketing-create-content-block: parameters: header: x-account-id: "" requestBody: - application/json: {"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}], "passthrough": {"other_known_names": "John Doe"}} + application/json: {"type": {"value": "html", "source_value": "text"}, "passthrough": {"other_known_names": "John Doe"}} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} - ats_get_background_check_package: - "": - parameters: - path: - id: "" - query: - fields: "id,remote_id,name,description,tests" - header: - x-account-id: "" - responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": []}} - ats_list_background_check_request: - "": - parameters: - query: - fields: "id,remote_id,package,application,job,candidate,requester,results_update_url" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} - updated_after: "2020-01-01T00:00:00.000Z" - header: - x-account-id: "" - responses: - "200": - application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}]} - ats_get_background_check_request: - "": - parameters: - path: - id: "" - query: - fields: "id,remote_id,package,application,job,candidate,requester,results_update_url" - header: - x-account-id: "" - responses: - "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}, {"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}}} - ats_get_background_check_result: + marketing_get_content_block: "": parameters: path: id: "" query: - fields: "id,remote_id,candidate,score,start_date,submission_date,summary,result,result_url,attachments" + raw: false + fields: "id,remote_id,name,type,content,status,tags,created_at,updated_at" header: x-account-id: "" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "score": {"label": "Percentage", "value": "80", "min": "0", "max": "100"}, "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed", "result": {"value": "passed", "source_value": "Passed"}, "result_url": "https://exmaple.com/result?id=xyz", "attachments": [{"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}, {"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}, {"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}]}} - lms_create_user_assignment: - speakeasy-default-lms-create-user-assignment: + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "html", "source_value": "text"}, "status": {"value": "live", "source_value": "active"}, "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z"}} + marketing_update_content_block: + speakeasy-default-marketing-update-content-block: parameters: path: id: "" header: x-account-id: "" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "external_reference": "e3gd34-23tr21-er234-345er56", "learning_object_id": "e3gd34-23tr21-er234-345er56", "learning_object_external_reference": "learning-content-123", "progress": "40", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "pending"}} + application/json: {"type": {"value": "html", "source_value": "text"}, "passthrough": {"other_known_names": "John Doe"}} responses: - "201": + "200": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} generatedTests: {} +examplesVersion: 1.0.0 diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 2b5759a6..4f9dec08 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -13,7 +13,7 @@ generation: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false php: - version: 0.23.0 + version: 0.23.2 additionalDependencies: autoload: {} autoload-dev: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 7fce8027..9606b306 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -8,20 +8,20 @@ sources: - latest stackone-specs: sourceNamespace: stackone-specs - sourceRevisionDigest: sha256:8b88a8b8e385b59815587a748cd055160a39025f600c23082178614448726271 - sourceBlobDigest: sha256:cd8b29022ae7d5e8855f17d266665e45e376777e62be6a36b64c1e4e145fa41c + sourceRevisionDigest: sha256:c1dfaa091afe705a84027c10227ab061ca6db9e304b76b7d69ce22aca3253a31 + sourceBlobDigest: sha256:7feb39b65be170bb5679b836c652a6f0e35f84d5facd478c0bf49acb34659d86 tags: - latest - - speakeasy-sdk-regen-1731801831 + - speakeasy-sdk-regen-1736640213 - 1.0.0 targets: stack-one: source: stackone-specs sourceNamespace: stackone-specs - sourceRevisionDigest: sha256:8b88a8b8e385b59815587a748cd055160a39025f600c23082178614448726271 - sourceBlobDigest: sha256:cd8b29022ae7d5e8855f17d266665e45e376777e62be6a36b64c1e4e145fa41c + sourceRevisionDigest: sha256:c1dfaa091afe705a84027c10227ab061ca6db9e304b76b7d69ce22aca3253a31 + sourceBlobDigest: sha256:7feb39b65be170bb5679b836c652a6f0e35f84d5facd478c0bf49acb34659d86 codeSamplesNamespace: stackone-specs-php-code-samples - codeSamplesRevisionDigest: sha256:9fd72c670f53deeea3c0d31ee1de7a8fc3f4fa2420d767275932dc603e636ae3 + codeSamplesRevisionDigest: sha256:996c3fa7ba636577228ba378a3477ef4378e585952c687eebb8dd4e114730def workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index cc2545a3..a960e2fe 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Marketing: The documentation for the StackOne Unified API - MARKETING * [stackone/client-sdk](#stackoneclient-sdk) * [SDK Installation](#sdk-installation) * [SDK Example Usage](#sdk-example-usage) + * [Authentication](#authentication) * [Available Resources and Operations](#available-resources-and-operations) * [Pagination](#pagination) * [Error Handling](#error-handling) @@ -84,6 +85,49 @@ foreach ($responses as $response) { ``` + +## Authentication + +### Per-Client Security Schemes + +This SDK supports the following security scheme globally: + +| Name | Type | Scheme | +| ------------------------- | ---- | ---------- | +| `username`
`password` | http | HTTP Basic | + +You can set the security parameters through the `setSecurity` function on the `SDKBuilder` when initializing the SDK. For example: +```php +declare(strict_types=1); + +require 'vendor/autoload.php'; + +use StackOne\client; +use StackOne\client\Models\Components; + +$sdk = client\StackOne::builder() + ->setSecurity( + new Components\Security( + username: '', + password: '', + ) + ) + ->build(); + +$request = new Components\ConnectSessionAuthenticate( + token: '', +); + +$response = $sdk->connectSessions->authenticateConnectSession( + request: $request +); + +if ($response->connectSession !== null) { + // handle response +} +``` + + ## Available Resources and Operations @@ -101,6 +145,7 @@ foreach ($responses as $response) { ### [ats](docs/sdks/ats/README.md) * [createApplication](docs/sdks/ats/README.md#createapplication) - Create Application +* [createApplicationNote](docs/sdks/ats/README.md#createapplicationnote) - Create Application Note * [createBackgroundCheckPackage](docs/sdks/ats/README.md#createbackgroundcheckpackage) - Create Background Check Package * [createCandidate](docs/sdks/ats/README.md#createcandidate) - Create Candidate * [createCandidateNote](docs/sdks/ats/README.md#createcandidatenote) - Create Candidate Note @@ -110,6 +155,7 @@ foreach ($responses as $response) { * [getApplication](docs/sdks/ats/README.md#getapplication) - Get Application * [getApplicationCustomFieldDefinition](docs/sdks/ats/README.md#getapplicationcustomfielddefinition) - Get Application Custom Field Definition * [getApplicationDocument](docs/sdks/ats/README.md#getapplicationdocument) - Get Application Document +* [getApplicationNote](docs/sdks/ats/README.md#getapplicationnote) - Get Application Note * [getApplicationOffer](docs/sdks/ats/README.md#getapplicationoffer) - Get Application Offer * [getApplicationScheduledInterview](docs/sdks/ats/README.md#getapplicationscheduledinterview) - Get Applications scheduled interview * [getApplicationScorecard](docs/sdks/ats/README.md#getapplicationscorecard) - Get Application Scorecard @@ -135,6 +181,7 @@ foreach ($responses as $response) { * [getUser](docs/sdks/ats/README.md#getuser) - Get User * [listApplicationCustomFieldDefinitions](docs/sdks/ats/README.md#listapplicationcustomfielddefinitions) - List Application Custom Field Definitions * [listApplicationDocuments](docs/sdks/ats/README.md#listapplicationdocuments) - List Application Documents +* [listApplicationNotes](docs/sdks/ats/README.md#listapplicationnotes) - List Application Notes * [listApplicationScorecards](docs/sdks/ats/README.md#listapplicationscorecards) - List Application Scorecards * [listApplications](docs/sdks/ats/README.md#listapplications) - List Applications * [listApplicationsOffers](docs/sdks/ats/README.md#listapplicationsoffers) - List Application Offers @@ -159,6 +206,7 @@ foreach ($responses as $response) { * [moveApplication](docs/sdks/ats/README.md#moveapplication) - Move Application * [rejectApplication](docs/sdks/ats/README.md#rejectapplication) - Reject Application * [updateApplication](docs/sdks/ats/README.md#updateapplication) - Update an Application +* [updateApplicationNote](docs/sdks/ats/README.md#updateapplicationnote) - Update an Application Note * [updateCandidate](docs/sdks/ats/README.md#updatecandidate) - Update Candidate * [updateJob](docs/sdks/ats/README.md#updatejob) - Update Job * [uploadApplicationDocument](docs/sdks/ats/README.md#uploadapplicationdocument) - Upload Application Document diff --git a/RELEASES.md b/RELEASES.md index 9932c5fa..5e1fa5d9 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -148,4 +148,14 @@ Based on: ### Generated - [php v0.23.0] . ### Releases -- [Composer v0.23.0] https://packagist.org/packages/stackone/client-sdk#v0.23.0 - . \ No newline at end of file +- [Composer v0.23.0] https://packagist.org/packages/stackone/client-sdk#v0.23.0 - . + +## 2025-01-26 00:03:11 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.462.2 (2.486.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [php v0.23.2] . +### Releases +- [Composer v0.23.2] https://packagist.org/packages/stackone/client-sdk#v0.23.2 - . \ No newline at end of file diff --git a/docs/Models/Components/AtsUpdateNotesRequestDto.md b/docs/Models/Components/AtsUpdateNotesRequestDto.md new file mode 100644 index 00000000..12eca8a4 --- /dev/null +++ b/docs/Models/Components/AtsUpdateNotesRequestDto.md @@ -0,0 +1,11 @@ +# AtsUpdateNotesRequestDto + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `content` | array<[Components\NoteContentApiModel](../../Models/Components/NoteContentApiModel.md)> | :heavy_minus_sign: | N/A | | +| `authorId` | *?string* | :heavy_minus_sign: | Unique identifier of the author | 1234567890 | +| `visibility` | [?Components\AtsUpdateNotesRequestDtoVisibility](../../Models/Components/AtsUpdateNotesRequestDtoVisibility.md) | :heavy_minus_sign: | Visibility of the note | public | +| `passthrough` | array | :heavy_minus_sign: | Value to pass through to the provider | {
"other_known_names": "John Doe"
} | \ No newline at end of file diff --git a/docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue.md b/docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue.md new file mode 100644 index 00000000..5542da8a --- /dev/null +++ b/docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue.md @@ -0,0 +1,52 @@ +# AtsUpdateNotesRequestDtoSourceValue + +The source value of the notes visibility. + + +## Supported Types + +### `string` + +```php +/** +* @var string +*/ +string $value = /* values here */ +``` + +### `float` + +```php +/** +* @var float +*/ +float $value = /* values here */ +``` + +### `bool` + +```php +/** +* @var bool +*/ +bool $value = /* values here */ +``` + +### `Components\AtsUpdateNotesRequestDtoSourceValue4` + +```php +/** +* @var Components\AtsUpdateNotesRequestDtoSourceValue4 +*/ +Components\AtsUpdateNotesRequestDtoSourceValue4 $value = /* values here */ +``` + +### `array` + +```php +/** +* @var array +*/ +array $value = /* values here */ +``` + diff --git a/docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.md b/docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.md new file mode 100644 index 00000000..e0d65acd --- /dev/null +++ b/docs/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.md @@ -0,0 +1,7 @@ +# AtsUpdateNotesRequestDtoSourceValue4 + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/Models/Components/AtsUpdateNotesRequestDtoValue.md b/docs/Models/Components/AtsUpdateNotesRequestDtoValue.md new file mode 100644 index 00000000..3ee928d9 --- /dev/null +++ b/docs/Models/Components/AtsUpdateNotesRequestDtoValue.md @@ -0,0 +1,11 @@ +# AtsUpdateNotesRequestDtoValue + +The visibility of the notes. + + +## Values + +| Name | Value | +| --------- | --------- | +| `Private` | private | +| `Public` | public | \ No newline at end of file diff --git a/docs/Models/Components/AtsUpdateNotesRequestDtoVisibility.md b/docs/Models/Components/AtsUpdateNotesRequestDtoVisibility.md new file mode 100644 index 00000000..612f02d9 --- /dev/null +++ b/docs/Models/Components/AtsUpdateNotesRequestDtoVisibility.md @@ -0,0 +1,11 @@ +# AtsUpdateNotesRequestDtoVisibility + +Visibility of the note + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | [?Components\AtsUpdateNotesRequestDtoValue](../../Models/Components/AtsUpdateNotesRequestDtoValue.md) | :heavy_minus_sign: | The visibility of the notes. | public | +| `sourceValue` | [string\|float\|bool\|Components\AtsUpdateNotesRequestDtoSourceValue4\|array\|null](../../Models/Components/AtsUpdateNotesRequestDtoSourceValue.md) | :heavy_minus_sign: | The source value of the notes visibility. | Public | \ No newline at end of file diff --git a/docs/Models/Components/Category.md b/docs/Models/Components/Category.md index 33776b90..45cddfdd 100644 --- a/docs/Models/Components/Category.md +++ b/docs/Models/Components/Category.md @@ -10,4 +10,5 @@ | `unifiedCustomFields` | array | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | | `name` | *?string* | :heavy_minus_sign: | The name associated with this category | Information-Technology | | `active` | *?bool* | :heavy_minus_sign: | Whether the category is active and therefore available for use | true | -| `level` | [?Components\CategoryLevel](../../Models/Components/CategoryLevel.md) | :heavy_minus_sign: | The hierarchal level of the category | | \ No newline at end of file +| `level` | [?Components\CategoryLevel](../../Models/Components/CategoryLevel.md) | :heavy_minus_sign: | The hierarchal level of the category | | +| `language` | [?Components\CategoryLanguage](../../Models/Components/CategoryLanguage.md) | :heavy_minus_sign: | The language associated with this category | | \ No newline at end of file diff --git a/docs/Models/Components/CategoryLanguage.md b/docs/Models/Components/CategoryLanguage.md new file mode 100644 index 00000000..46a1c916 --- /dev/null +++ b/docs/Models/Components/CategoryLanguage.md @@ -0,0 +1,11 @@ +# CategoryLanguage + +The language associated with this category + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `value` | [?Components\CategoryLanguageValue](../../Models/Components/CategoryLanguageValue.md) | :heavy_minus_sign: | The Locale Code of the language | en_GB | +| `sourceValue` | [string\|float\|bool\|Components\CategorySourceValueLanguage4\|array\|null](../../Models/Components/CategoryLanguageSourceValue.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/Models/Components/CategoryLanguageSourceValue.md b/docs/Models/Components/CategoryLanguageSourceValue.md new file mode 100644 index 00000000..93c15abf --- /dev/null +++ b/docs/Models/Components/CategoryLanguageSourceValue.md @@ -0,0 +1,50 @@ +# CategoryLanguageSourceValue + + +## Supported Types + +### `string` + +```php +/** +* @var string +*/ +string $value = /* values here */ +``` + +### `float` + +```php +/** +* @var float +*/ +float $value = /* values here */ +``` + +### `bool` + +```php +/** +* @var bool +*/ +bool $value = /* values here */ +``` + +### `Components\CategorySourceValueLanguage4` + +```php +/** +* @var Components\CategorySourceValueLanguage4 +*/ +Components\CategorySourceValueLanguage4 $value = /* values here */ +``` + +### `array` + +```php +/** +* @var array +*/ +array $value = /* values here */ +``` + diff --git a/docs/Models/Components/CategoryLanguageValue.md b/docs/Models/Components/CategoryLanguageValue.md new file mode 100644 index 00000000..4a670215 --- /dev/null +++ b/docs/Models/Components/CategoryLanguageValue.md @@ -0,0 +1,419 @@ +# CategoryLanguageValue + +The Locale Code of the language + + +## Values + +| Name | Value | +| ------- | ------- | +| `ARAR` | ar_AR | +| `AaER` | aa_ER | +| `AfNA` | af_NA | +| `AfZA` | af_ZA | +| `AmET` | am_ET | +| `ArAE` | ar_AE | +| `ArBH` | ar_BH | +| `ArDJ` | ar_DJ | +| `ArDZ` | ar_DZ | +| `ArEG` | ar_EG | +| `ArER` | ar_ER | +| `ArIQ` | ar_IQ | +| `ArJO` | ar_JO | +| `ArKM` | ar_KM | +| `ArKW` | ar_KW | +| `ArLB` | ar_LB | +| `ArLY` | ar_LY | +| `ArMA` | ar_MA | +| `ArMR` | ar_MR | +| `ArOM` | ar_OM | +| `ArPS` | ar_PS | +| `ArQA` | ar_QA | +| `ArSA` | ar_SA | +| `ArSD` | ar_SD | +| `ArSY` | ar_SY | +| `ArTD` | ar_TD | +| `ArTN` | ar_TN | +| `ArYE` | ar_YE | +| `AyBO` | ay_BO | +| `AyPE` | ay_PE | +| `AZAZ` | az_AZ | +| `AzIR` | az_IR | +| `BeBY` | be_BY | +| `BGBG` | bg_BG | +| `BiVU` | bi_VU | +| `BnBD` | bn_BD | +| `BnIN` | bn_IN | +| `BsBA` | bs_BA | +| `BsME` | bs-ME | +| `BynER` | byn_ER | +| `CaAD` | ca_AD | +| `CaES` | ca_ES | +| `CaFR` | ca_FR | +| `CaIT` | ca_IT | +| `ChGU` | ch_GU | +| `CsCZ` | cs_CZ | +| `DaDK` | da_DK | +| `DeAT` | de_AT | +| `DeBE` | de_BE | +| `DeCH` | de_CH | +| `DEDE` | de_DE | +| `DeLI` | de_LI | +| `DeLU` | de_LU | +| `DeVA` | de_VA | +| `DeMV` | de_MV | +| `DvMV` | dv_MV | +| `DzBT` | dz_BT | +| `ElCY` | el_CY | +| `ElGR` | el_GR | +| `EnAG` | en_AG | +| `EnAI` | en_AI | +| `EnAS` | en_AS | +| `EnAU` | en_AU | +| `EnBB` | en_BB | +| `EnBE` | en_BE | +| `EnBM` | en_BM | +| `EnBS` | en_BS | +| `EnBW` | en_BW | +| `EnBZ` | en_BZ | +| `EnCA` | en_CA | +| `EnCC` | en_CC | +| `EnCK` | en_CK | +| `EnCM` | en_CM | +| `EnCW` | en_CW | +| `EnCX` | en_CX | +| `EnDG` | en_DG | +| `EnDM` | en_DM | +| `EnER` | en_ER | +| `EnFJ` | en_FJ | +| `EnFK` | en_FK | +| `EnFM` | en_FM | +| `EnGB` | en_GB | +| `EnGD` | en_GD | +| `EnGG` | en_GG | +| `EnGH` | en_GH | +| `EnGI` | en_GI | +| `EnGM` | en_GM | +| `EnGS` | en_GS | +| `EnGU` | en_GU | +| `EnGY` | en_GY | +| `EnHK` | en_HK | +| `EnIE` | en_IE | +| `EnIM` | en_IM | +| `EnIN` | en_IN | +| `EnIO` | en_IO | +| `EnJE` | en_JE | +| `EnJM` | en_JM | +| `EnKE` | en_KE | +| `EnKI` | en_KI | +| `EnKN` | en_KN | +| `EnKY` | en_KY | +| `EnLC` | en_LC | +| `EnLR` | en_LR | +| `EnLS` | en_LS | +| `EnMF` | en_MF | +| `EnMG` | en_MG | +| `EnMH` | en_MH | +| `EnMO` | en_MO | +| `EnMP` | en_MP | +| `EnMS` | en_MS | +| `EnMT` | en_MT | +| `EnMU` | en_MU | +| `EnMW` | en_MW | +| `EnMY` | en_MY | +| `EnNA` | en_NA | +| `EnNF` | en_NF | +| `EnNG` | en_NG | +| `EnNL` | en_NL | +| `EnNR` | en_NR | +| `EnNU` | en_NU | +| `EnNZ` | en_NZ | +| `EnPG` | en_PG | +| `EnPH` | en_PH | +| `EnPK` | en_PK | +| `EnPN` | en_PN | +| `EnPR` | en_PR | +| `EnPW` | en_PW | +| `EnRW` | en_RW | +| `EnSB` | en_SB | +| `EnSC` | en_SC | +| `EnSD` | en_SD | +| `EnSG` | en_SG | +| `EnSH` | en_SH | +| `EnSL` | en_SL | +| `EnSS` | en_SS | +| `EnSX` | en_SX | +| `EnSZ` | en_SZ | +| `EnTC` | en_TC | +| `EnTK` | en_TK | +| `EnTO` | en_TO | +| `EnTT` | en_TT | +| `EnTV` | en_TV | +| `EnTZ` | en_TZ | +| `EnUG` | en_UG | +| `EnUM` | en_UM | +| `EnUS` | en_US | +| `EnVC` | en_VC | +| `EnVG` | en_VG | +| `EnVI` | en_VI | +| `EnVU` | en_VU | +| `EnWS` | en_WS | +| `EnZA` | en_ZA | +| `EnZM` | en_ZM | +| `EnZW` | en_ZW | +| `EsAR` | es_AR | +| `EsBO` | es_BO | +| `EsBZ` | es_BZ | +| `EsCL` | es_CL | +| `EsCO` | es_CO | +| `EsCR` | es_CR | +| `EsCU` | es_CU | +| `EsDO` | es_DO | +| `EsEA` | es_EA | +| `EsEC` | es_EC | +| `EsEH` | es_EH | +| `ESES` | es_ES | +| `EsGQ` | es_GQ | +| `EsGT` | es_GT | +| `EsHN` | es_HN | +| `EsIC` | es_IC | +| `EsLA` | es_LA | +| `EsMX` | es_MX | +| `EsNI` | es_NI | +| `EsPA` | es_PA | +| `EsPE` | es_PE | +| `EsPH` | es_PH | +| `EsPR` | es_PR | +| `EsPY` | es_PY | +| `EsSV` | es_SV | +| `EsUS` | es_US | +| `EsUY` | es_UY | +| `EsVE` | es_VE | +| `EtEE` | et_EE | +| `FaAF` | fa_AF | +| `FaIR` | fa_IR | +| `FanGA` | fan_GA | +| `FfCM` | ff_CM | +| `FfGN` | ff_GN | +| `FfMR` | ff_MR | +| `FfSN` | ff_SN | +| `FfBF` | ff_BF | +| `FIFI` | fi_FI | +| `FJFJ` | fj_FJ | +| `FOFO` | fo_FO | +| `FrBE` | fr_BE | +| `FrBF` | fr_BF | +| `FrBI` | fr_BI | +| `FrBJ` | fr_BJ | +| `FrBL` | fr_BL | +| `FrCA` | fr_CA | +| `FrCD` | fr_CD | +| `FrCF` | fr_CF | +| `FrCG` | fr_CG | +| `FrCH` | fr_CH | +| `FrCI` | fr_CI | +| `FrCM` | fr_CM | +| `FrDJ` | fr_DJ | +| `FrDZ` | fr_DZ | +| `FRFR` | fr_FR | +| `FrGA` | fr_GA | +| `FrGF` | fr_GF | +| `FrGG` | fr_GG | +| `FrGN` | fr_GN | +| `FrGP` | fr_GP | +| `FrGQ` | fr_GQ | +| `FrHT` | fr_HT | +| `FrKM` | fr_KM | +| `FrJE` | fr_JE | +| `FrLU` | fr_LU | +| `FrLB` | fr_LB | +| `FrMA` | fr_MA | +| `FrMC` | fr_MC | +| `FrMF` | fr_MF | +| `FrMG` | fr_MG | +| `FrML` | fr_ML | +| `FrMQ` | fr_MQ | +| `FrMR` | fr_MR | +| `FrMU` | fr_MU | +| `FrNC` | fr_NC | +| `FrNE` | fr_NE | +| `FrPF` | fr_PF | +| `FrPM` | fr_PM | +| `FrRE` | fr_RE | +| `FrRW` | fr_RW | +| `FrSC` | fr_SC | +| `FrSN` | fr_SN | +| `FrSY` | fr_SY | +| `FrTD` | fr_TD | +| `FrTF` | fr_TF | +| `FrTG` | fr_TG | +| `FrTN` | fr_TN | +| `FrVU` | fr_VU | +| `FrVA` | fr_VA | +| `FrWF` | fr_WF | +| `FrYT` | fr_YT | +| `GaIE` | ga_IE | +| `GnPY` | gn_PY | +| `GnAR` | gn_AR | +| `GuIN` | gu_IN | +| `GvIM` | gv_IM | +| `HeIL` | he_IL | +| `HiIN` | hi_IN | +| `HrBA` | hr_BA | +| `HRHR` | hr_HR | +| `HrME` | hr_ME | +| `HTHT` | ht_HT | +| `HUHU` | hu_HU | +| `HyAM` | hy_AM | +| `HyCY` | hy_CY | +| `IDID` | id_ID | +| `ISIS` | is_IS | +| `ItCH` | it_CH | +| `ITIT` | it_IT | +| `ItSM` | it_SM | +| `ItVA` | it_VA | +| `JaJP` | ja_JP | +| `KaGE` | ka_GE | +| `KgCD` | kg_CD | +| `KkKZ` | kk_KZ | +| `KlGL` | kl_GL | +| `KmKH` | km_KH | +| `KoKP` | ko_KP | +| `KoKR` | ko_KR | +| `KuIQ` | ku_IQ | +| `KyKG` | ky_KG | +| `LaVA` | la_VA | +| `LbLU` | lb_LU | +| `LnAO` | ln_AO | +| `LnCD` | ln_CD | +| `LnCF` | ln_CF | +| `LnCG` | ln_CG | +| `LoLA` | lo_LA | +| `LTLT` | lt_LT | +| `LuCD` | lu_CD | +| `LVLV` | lv_LV | +| `MGMG` | mg_MG | +| `MHMH` | mh_MH | +| `MiNZ` | mi_NZ | +| `MKMK` | mk_MK | +| `MNMN` | mn_MN | +| `MrIN` | mr_IN | +| `MsBN` | ms_BN | +| `MsMY` | ms_MY | +| `MsSG` | ms_SG | +| `MTMT` | mt_MT | +| `MyMM` | my_MM | +| `NbNO` | nb_NO | +| `NbBV` | nb_BV | +| `NbZW` | nb_ZW | +| `NeNP` | ne_NP | +| `NlAW` | nl_AW | +| `NlBE` | nl_BE | +| `NlBQ` | nl_BQ | +| `NlCW` | nl_CW | +| `NLNL` | nl_NL | +| `NlSR` | nl_SR | +| `NlSX` | nl_SX | +| `NlMF` | nl_MF | +| `NnNO` | nn_NO | +| `NnBV` | nn_BV | +| `NONO` | no_NO | +| `NoBV` | no_BV | +| `NoSJ` | no_SJ | +| `NrZA` | nr_ZA | +| `NyMW` | ny_MW | +| `PaIN` | pa_IN | +| `PaPK` | pa_PK | +| `PLPL` | pl_PL | +| `PsAF` | ps_AF | +| `PtAO` | pt_AO | +| `PtBR` | pt_BR | +| `PtCH` | pt_CH | +| `PtCV` | pt_CV | +| `PtGQ` | pt_GQ | +| `PtGW` | pt_GW | +| `PtLU` | pt_LU | +| `PtMO` | pt_MO | +| `PtMZ` | pt_MZ | +| `PTPT` | pt_PT | +| `PtST` | pt_ST | +| `PtTL` | pt_TL | +| `QuBO` | qu_BO | +| `QuEC` | qu_EC | +| `QuPE` | qu_PE | +| `RarCK` | rar_CK | +| `RmCH` | rm_CH | +| `RupMK` | rup_MK | +| `RoMD` | ro_MD | +| `RORO` | ro_RO | +| `RuBY` | ru_BY | +| `RuKG` | ru_KG | +| `RuKZ` | ru_KZ | +| `RuMD` | ru_MD | +| `RURU` | ru_RU | +| `RuUA` | ru_UA | +| `RuAQ` | ru_AQ | +| `RuTJ` | ru_TJ | +| `RuTM` | ru_TM | +| `RuUZ` | ru_UZ | +| `RWRW` | rw_RW | +| `SESE` | se_SE | +| `SgCF` | sg_CF | +| `SiLK` | si_LK | +| `SKSK` | sk_SK | +| `SlSI` | sl_SI | +| `SmAS` | sm_AS | +| `SmWS` | sm_WS | +| `SnZW` | sn_ZW | +| `SoDJ` | so_DJ | +| `SoET` | so_ET | +| `SoKE` | so_KE | +| `SOSO` | so_SO | +| `SqAL` | sq_AL | +| `SqME` | sq_ME | +| `SqXK` | sq_XK | +| `SrBA` | sr_BA | +| `SrME` | sr_ME | +| `SrRS` | sr_RS | +| `SrXK` | sr_XK | +| `SsSZ` | ss_SZ | +| `SsZA` | ss_ZA | +| `SvAX` | sv_AX | +| `SvFI` | sv_FI | +| `SvSE` | sv_SE | +| `SwKE` | sw_KE | +| `SwTZ` | sw_TZ | +| `SwUG` | sw_UG | +| `SwCD` | sw_CD | +| `TaIN` | ta_IN | +| `TaMY` | ta_MY | +| `TaSG` | ta_SG | +| `TaLK` | ta_LK | +| `TeIN` | te_IN | +| `TgTJ` | tg_TJ | +| `THTH` | th_TH | +| `TiER` | ti_ER | +| `TiET` | ti_ET | +| `TigER` | tig_ER | +| `TkTM` | tk_TM | +| `TkAF` | tk_AF | +| `TnBW` | tn_BW | +| `TnZA` | tn_ZA | +| `TOTO` | to_TO | +| `TrCY` | tr_CY | +| `TRTR` | tr_TR | +| `TsZA` | ts_ZA | +| `UkUA` | uk_UA | +| `UrIN` | ur_IN | +| `UrPK` | ur_PK | +| `UzAF` | uz_AF | +| `UZUZ` | uz_UZ | +| `VeZA` | ve_ZA | +| `ViVN` | vi_VN | +| `XhZA` | xh_ZA | +| `ZhCN` | zh_CN | +| `ZhHK` | zh_HK | +| `ZhMO` | zh_MO | +| `ZhSG` | zh_SG | +| `ZhTW` | zh_TW | +| `ZuZA` | zu_ZA | \ No newline at end of file diff --git a/docs/Models/Components/CategorySourceValueLanguage4.md b/docs/Models/Components/CategorySourceValueLanguage4.md new file mode 100644 index 00000000..4f2cf7d3 --- /dev/null +++ b/docs/Models/Components/CategorySourceValueLanguage4.md @@ -0,0 +1,7 @@ +# CategorySourceValueLanguage4 + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/Models/Components/Course.md b/docs/Models/Components/Course.md index 291da9f3..45ef19e8 100644 --- a/docs/Models/Components/Course.md +++ b/docs/Models/Components/Course.md @@ -20,5 +20,6 @@ | `duration` | *?string* | :heavy_minus_sign: | The duration of the course following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string | P3Y6M4DT12H30M5S | | `categories` | array<[Components\Category](../../Models/Components/Category.md)> | :heavy_minus_sign: | The categories associated with this course | [
{
"id": "12345",
"name": "Technology"
}
] | | `skills` | array<[Components\Skills](../../Models/Components/Skills.md)> | :heavy_minus_sign: | The skills associated with this course | [
{
"id": "12345",
"name": "Sales Techniques"
}
] | +| `provider` | *?string* | :heavy_minus_sign: | The name of the course provider | Course Provider | | `updatedAt` | *?string* | :heavy_minus_sign: | The date on which the course was last updated. | 2021-07-21T14:00:00.000Z | | `createdAt` | *?string* | :heavy_minus_sign: | The date on which the course was created. | 2021-07-21T14:00:00.000Z | \ No newline at end of file diff --git a/docs/Models/Components/CreateCategoriesApiModel.md b/docs/Models/Components/CreateCategoriesApiModel.md index f60ae0c3..cf474fbb 100644 --- a/docs/Models/Components/CreateCategoriesApiModel.md +++ b/docs/Models/Components/CreateCategoriesApiModel.md @@ -8,4 +8,5 @@ | `id` | *?string* | :heavy_minus_sign: | The ID associated with this category | 16873-IT345 | | `unifiedCustomFields` | array | :heavy_minus_sign: | Custom Unified Fields configured in your StackOne project | {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
} | | `name` | *?string* | :heavy_minus_sign: | The name associated with this category | Information-Technology | -| `level` | [?Components\Level](../../Models/Components/Level.md) | :heavy_minus_sign: | The hierarchal level of the category | | \ No newline at end of file +| `level` | [?Components\Level](../../Models/Components/Level.md) | :heavy_minus_sign: | The hierarchal level of the category | | +| `language` | [?Components\Language](../../Models/Components/Language.md) | :heavy_minus_sign: | The language associated with this category | | \ No newline at end of file diff --git a/docs/Models/Components/CreateCategoriesApiModelLanguageSourceValue.md b/docs/Models/Components/CreateCategoriesApiModelLanguageSourceValue.md new file mode 100644 index 00000000..e6c08688 --- /dev/null +++ b/docs/Models/Components/CreateCategoriesApiModelLanguageSourceValue.md @@ -0,0 +1,50 @@ +# CreateCategoriesApiModelLanguageSourceValue + + +## Supported Types + +### `string` + +```php +/** +* @var string +*/ +string $value = /* values here */ +``` + +### `float` + +```php +/** +* @var float +*/ +float $value = /* values here */ +``` + +### `bool` + +```php +/** +* @var bool +*/ +bool $value = /* values here */ +``` + +### `Components\CreateCategoriesApiModelSourceValueLanguage4` + +```php +/** +* @var Components\CreateCategoriesApiModelSourceValueLanguage4 +*/ +Components\CreateCategoriesApiModelSourceValueLanguage4 $value = /* values here */ +``` + +### `array` + +```php +/** +* @var array +*/ +array $value = /* values here */ +``` + diff --git a/docs/Models/Components/CreateCategoriesApiModelLanguageValue.md b/docs/Models/Components/CreateCategoriesApiModelLanguageValue.md new file mode 100644 index 00000000..e2bb9513 --- /dev/null +++ b/docs/Models/Components/CreateCategoriesApiModelLanguageValue.md @@ -0,0 +1,419 @@ +# CreateCategoriesApiModelLanguageValue + +The Locale Code of the language + + +## Values + +| Name | Value | +| ------- | ------- | +| `ARAR` | ar_AR | +| `AaER` | aa_ER | +| `AfNA` | af_NA | +| `AfZA` | af_ZA | +| `AmET` | am_ET | +| `ArAE` | ar_AE | +| `ArBH` | ar_BH | +| `ArDJ` | ar_DJ | +| `ArDZ` | ar_DZ | +| `ArEG` | ar_EG | +| `ArER` | ar_ER | +| `ArIQ` | ar_IQ | +| `ArJO` | ar_JO | +| `ArKM` | ar_KM | +| `ArKW` | ar_KW | +| `ArLB` | ar_LB | +| `ArLY` | ar_LY | +| `ArMA` | ar_MA | +| `ArMR` | ar_MR | +| `ArOM` | ar_OM | +| `ArPS` | ar_PS | +| `ArQA` | ar_QA | +| `ArSA` | ar_SA | +| `ArSD` | ar_SD | +| `ArSY` | ar_SY | +| `ArTD` | ar_TD | +| `ArTN` | ar_TN | +| `ArYE` | ar_YE | +| `AyBO` | ay_BO | +| `AyPE` | ay_PE | +| `AZAZ` | az_AZ | +| `AzIR` | az_IR | +| `BeBY` | be_BY | +| `BGBG` | bg_BG | +| `BiVU` | bi_VU | +| `BnBD` | bn_BD | +| `BnIN` | bn_IN | +| `BsBA` | bs_BA | +| `BsME` | bs-ME | +| `BynER` | byn_ER | +| `CaAD` | ca_AD | +| `CaES` | ca_ES | +| `CaFR` | ca_FR | +| `CaIT` | ca_IT | +| `ChGU` | ch_GU | +| `CsCZ` | cs_CZ | +| `DaDK` | da_DK | +| `DeAT` | de_AT | +| `DeBE` | de_BE | +| `DeCH` | de_CH | +| `DEDE` | de_DE | +| `DeLI` | de_LI | +| `DeLU` | de_LU | +| `DeVA` | de_VA | +| `DeMV` | de_MV | +| `DvMV` | dv_MV | +| `DzBT` | dz_BT | +| `ElCY` | el_CY | +| `ElGR` | el_GR | +| `EnAG` | en_AG | +| `EnAI` | en_AI | +| `EnAS` | en_AS | +| `EnAU` | en_AU | +| `EnBB` | en_BB | +| `EnBE` | en_BE | +| `EnBM` | en_BM | +| `EnBS` | en_BS | +| `EnBW` | en_BW | +| `EnBZ` | en_BZ | +| `EnCA` | en_CA | +| `EnCC` | en_CC | +| `EnCK` | en_CK | +| `EnCM` | en_CM | +| `EnCW` | en_CW | +| `EnCX` | en_CX | +| `EnDG` | en_DG | +| `EnDM` | en_DM | +| `EnER` | en_ER | +| `EnFJ` | en_FJ | +| `EnFK` | en_FK | +| `EnFM` | en_FM | +| `EnGB` | en_GB | +| `EnGD` | en_GD | +| `EnGG` | en_GG | +| `EnGH` | en_GH | +| `EnGI` | en_GI | +| `EnGM` | en_GM | +| `EnGS` | en_GS | +| `EnGU` | en_GU | +| `EnGY` | en_GY | +| `EnHK` | en_HK | +| `EnIE` | en_IE | +| `EnIM` | en_IM | +| `EnIN` | en_IN | +| `EnIO` | en_IO | +| `EnJE` | en_JE | +| `EnJM` | en_JM | +| `EnKE` | en_KE | +| `EnKI` | en_KI | +| `EnKN` | en_KN | +| `EnKY` | en_KY | +| `EnLC` | en_LC | +| `EnLR` | en_LR | +| `EnLS` | en_LS | +| `EnMF` | en_MF | +| `EnMG` | en_MG | +| `EnMH` | en_MH | +| `EnMO` | en_MO | +| `EnMP` | en_MP | +| `EnMS` | en_MS | +| `EnMT` | en_MT | +| `EnMU` | en_MU | +| `EnMW` | en_MW | +| `EnMY` | en_MY | +| `EnNA` | en_NA | +| `EnNF` | en_NF | +| `EnNG` | en_NG | +| `EnNL` | en_NL | +| `EnNR` | en_NR | +| `EnNU` | en_NU | +| `EnNZ` | en_NZ | +| `EnPG` | en_PG | +| `EnPH` | en_PH | +| `EnPK` | en_PK | +| `EnPN` | en_PN | +| `EnPR` | en_PR | +| `EnPW` | en_PW | +| `EnRW` | en_RW | +| `EnSB` | en_SB | +| `EnSC` | en_SC | +| `EnSD` | en_SD | +| `EnSG` | en_SG | +| `EnSH` | en_SH | +| `EnSL` | en_SL | +| `EnSS` | en_SS | +| `EnSX` | en_SX | +| `EnSZ` | en_SZ | +| `EnTC` | en_TC | +| `EnTK` | en_TK | +| `EnTO` | en_TO | +| `EnTT` | en_TT | +| `EnTV` | en_TV | +| `EnTZ` | en_TZ | +| `EnUG` | en_UG | +| `EnUM` | en_UM | +| `EnUS` | en_US | +| `EnVC` | en_VC | +| `EnVG` | en_VG | +| `EnVI` | en_VI | +| `EnVU` | en_VU | +| `EnWS` | en_WS | +| `EnZA` | en_ZA | +| `EnZM` | en_ZM | +| `EnZW` | en_ZW | +| `EsAR` | es_AR | +| `EsBO` | es_BO | +| `EsBZ` | es_BZ | +| `EsCL` | es_CL | +| `EsCO` | es_CO | +| `EsCR` | es_CR | +| `EsCU` | es_CU | +| `EsDO` | es_DO | +| `EsEA` | es_EA | +| `EsEC` | es_EC | +| `EsEH` | es_EH | +| `ESES` | es_ES | +| `EsGQ` | es_GQ | +| `EsGT` | es_GT | +| `EsHN` | es_HN | +| `EsIC` | es_IC | +| `EsLA` | es_LA | +| `EsMX` | es_MX | +| `EsNI` | es_NI | +| `EsPA` | es_PA | +| `EsPE` | es_PE | +| `EsPH` | es_PH | +| `EsPR` | es_PR | +| `EsPY` | es_PY | +| `EsSV` | es_SV | +| `EsUS` | es_US | +| `EsUY` | es_UY | +| `EsVE` | es_VE | +| `EtEE` | et_EE | +| `FaAF` | fa_AF | +| `FaIR` | fa_IR | +| `FanGA` | fan_GA | +| `FfCM` | ff_CM | +| `FfGN` | ff_GN | +| `FfMR` | ff_MR | +| `FfSN` | ff_SN | +| `FfBF` | ff_BF | +| `FIFI` | fi_FI | +| `FJFJ` | fj_FJ | +| `FOFO` | fo_FO | +| `FrBE` | fr_BE | +| `FrBF` | fr_BF | +| `FrBI` | fr_BI | +| `FrBJ` | fr_BJ | +| `FrBL` | fr_BL | +| `FrCA` | fr_CA | +| `FrCD` | fr_CD | +| `FrCF` | fr_CF | +| `FrCG` | fr_CG | +| `FrCH` | fr_CH | +| `FrCI` | fr_CI | +| `FrCM` | fr_CM | +| `FrDJ` | fr_DJ | +| `FrDZ` | fr_DZ | +| `FRFR` | fr_FR | +| `FrGA` | fr_GA | +| `FrGF` | fr_GF | +| `FrGG` | fr_GG | +| `FrGN` | fr_GN | +| `FrGP` | fr_GP | +| `FrGQ` | fr_GQ | +| `FrHT` | fr_HT | +| `FrKM` | fr_KM | +| `FrJE` | fr_JE | +| `FrLU` | fr_LU | +| `FrLB` | fr_LB | +| `FrMA` | fr_MA | +| `FrMC` | fr_MC | +| `FrMF` | fr_MF | +| `FrMG` | fr_MG | +| `FrML` | fr_ML | +| `FrMQ` | fr_MQ | +| `FrMR` | fr_MR | +| `FrMU` | fr_MU | +| `FrNC` | fr_NC | +| `FrNE` | fr_NE | +| `FrPF` | fr_PF | +| `FrPM` | fr_PM | +| `FrRE` | fr_RE | +| `FrRW` | fr_RW | +| `FrSC` | fr_SC | +| `FrSN` | fr_SN | +| `FrSY` | fr_SY | +| `FrTD` | fr_TD | +| `FrTF` | fr_TF | +| `FrTG` | fr_TG | +| `FrTN` | fr_TN | +| `FrVU` | fr_VU | +| `FrVA` | fr_VA | +| `FrWF` | fr_WF | +| `FrYT` | fr_YT | +| `GaIE` | ga_IE | +| `GnPY` | gn_PY | +| `GnAR` | gn_AR | +| `GuIN` | gu_IN | +| `GvIM` | gv_IM | +| `HeIL` | he_IL | +| `HiIN` | hi_IN | +| `HrBA` | hr_BA | +| `HRHR` | hr_HR | +| `HrME` | hr_ME | +| `HTHT` | ht_HT | +| `HUHU` | hu_HU | +| `HyAM` | hy_AM | +| `HyCY` | hy_CY | +| `IDID` | id_ID | +| `ISIS` | is_IS | +| `ItCH` | it_CH | +| `ITIT` | it_IT | +| `ItSM` | it_SM | +| `ItVA` | it_VA | +| `JaJP` | ja_JP | +| `KaGE` | ka_GE | +| `KgCD` | kg_CD | +| `KkKZ` | kk_KZ | +| `KlGL` | kl_GL | +| `KmKH` | km_KH | +| `KoKP` | ko_KP | +| `KoKR` | ko_KR | +| `KuIQ` | ku_IQ | +| `KyKG` | ky_KG | +| `LaVA` | la_VA | +| `LbLU` | lb_LU | +| `LnAO` | ln_AO | +| `LnCD` | ln_CD | +| `LnCF` | ln_CF | +| `LnCG` | ln_CG | +| `LoLA` | lo_LA | +| `LTLT` | lt_LT | +| `LuCD` | lu_CD | +| `LVLV` | lv_LV | +| `MGMG` | mg_MG | +| `MHMH` | mh_MH | +| `MiNZ` | mi_NZ | +| `MKMK` | mk_MK | +| `MNMN` | mn_MN | +| `MrIN` | mr_IN | +| `MsBN` | ms_BN | +| `MsMY` | ms_MY | +| `MsSG` | ms_SG | +| `MTMT` | mt_MT | +| `MyMM` | my_MM | +| `NbNO` | nb_NO | +| `NbBV` | nb_BV | +| `NbZW` | nb_ZW | +| `NeNP` | ne_NP | +| `NlAW` | nl_AW | +| `NlBE` | nl_BE | +| `NlBQ` | nl_BQ | +| `NlCW` | nl_CW | +| `NLNL` | nl_NL | +| `NlSR` | nl_SR | +| `NlSX` | nl_SX | +| `NlMF` | nl_MF | +| `NnNO` | nn_NO | +| `NnBV` | nn_BV | +| `NONO` | no_NO | +| `NoBV` | no_BV | +| `NoSJ` | no_SJ | +| `NrZA` | nr_ZA | +| `NyMW` | ny_MW | +| `PaIN` | pa_IN | +| `PaPK` | pa_PK | +| `PLPL` | pl_PL | +| `PsAF` | ps_AF | +| `PtAO` | pt_AO | +| `PtBR` | pt_BR | +| `PtCH` | pt_CH | +| `PtCV` | pt_CV | +| `PtGQ` | pt_GQ | +| `PtGW` | pt_GW | +| `PtLU` | pt_LU | +| `PtMO` | pt_MO | +| `PtMZ` | pt_MZ | +| `PTPT` | pt_PT | +| `PtST` | pt_ST | +| `PtTL` | pt_TL | +| `QuBO` | qu_BO | +| `QuEC` | qu_EC | +| `QuPE` | qu_PE | +| `RarCK` | rar_CK | +| `RmCH` | rm_CH | +| `RupMK` | rup_MK | +| `RoMD` | ro_MD | +| `RORO` | ro_RO | +| `RuBY` | ru_BY | +| `RuKG` | ru_KG | +| `RuKZ` | ru_KZ | +| `RuMD` | ru_MD | +| `RURU` | ru_RU | +| `RuUA` | ru_UA | +| `RuAQ` | ru_AQ | +| `RuTJ` | ru_TJ | +| `RuTM` | ru_TM | +| `RuUZ` | ru_UZ | +| `RWRW` | rw_RW | +| `SESE` | se_SE | +| `SgCF` | sg_CF | +| `SiLK` | si_LK | +| `SKSK` | sk_SK | +| `SlSI` | sl_SI | +| `SmAS` | sm_AS | +| `SmWS` | sm_WS | +| `SnZW` | sn_ZW | +| `SoDJ` | so_DJ | +| `SoET` | so_ET | +| `SoKE` | so_KE | +| `SOSO` | so_SO | +| `SqAL` | sq_AL | +| `SqME` | sq_ME | +| `SqXK` | sq_XK | +| `SrBA` | sr_BA | +| `SrME` | sr_ME | +| `SrRS` | sr_RS | +| `SrXK` | sr_XK | +| `SsSZ` | ss_SZ | +| `SsZA` | ss_ZA | +| `SvAX` | sv_AX | +| `SvFI` | sv_FI | +| `SvSE` | sv_SE | +| `SwKE` | sw_KE | +| `SwTZ` | sw_TZ | +| `SwUG` | sw_UG | +| `SwCD` | sw_CD | +| `TaIN` | ta_IN | +| `TaMY` | ta_MY | +| `TaSG` | ta_SG | +| `TaLK` | ta_LK | +| `TeIN` | te_IN | +| `TgTJ` | tg_TJ | +| `THTH` | th_TH | +| `TiER` | ti_ER | +| `TiET` | ti_ET | +| `TigER` | tig_ER | +| `TkTM` | tk_TM | +| `TkAF` | tk_AF | +| `TnBW` | tn_BW | +| `TnZA` | tn_ZA | +| `TOTO` | to_TO | +| `TrCY` | tr_CY | +| `TRTR` | tr_TR | +| `TsZA` | ts_ZA | +| `UkUA` | uk_UA | +| `UrIN` | ur_IN | +| `UrPK` | ur_PK | +| `UzAF` | uz_AF | +| `UZUZ` | uz_UZ | +| `VeZA` | ve_ZA | +| `ViVN` | vi_VN | +| `XhZA` | xh_ZA | +| `ZhCN` | zh_CN | +| `ZhHK` | zh_HK | +| `ZhMO` | zh_MO | +| `ZhSG` | zh_SG | +| `ZhTW` | zh_TW | +| `ZuZA` | zu_ZA | \ No newline at end of file diff --git a/docs/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.md b/docs/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.md new file mode 100644 index 00000000..e12152c4 --- /dev/null +++ b/docs/Models/Components/CreateCategoriesApiModelSourceValueLanguage4.md @@ -0,0 +1,7 @@ +# CreateCategoriesApiModelSourceValueLanguage4 + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/Models/Components/Language.md b/docs/Models/Components/Language.md new file mode 100644 index 00000000..989bc570 --- /dev/null +++ b/docs/Models/Components/Language.md @@ -0,0 +1,11 @@ +# Language + +The language associated with this category + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | [?Components\CreateCategoriesApiModelLanguageValue](../../Models/Components/CreateCategoriesApiModelLanguageValue.md) | :heavy_minus_sign: | The Locale Code of the language | en_GB | +| `sourceValue` | [string\|float\|bool\|Components\CreateCategoriesApiModelSourceValueLanguage4\|array\|null](../../Models/Components/CreateCategoriesApiModelLanguageSourceValue.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/Models/Components/LmsUpsertContentRequestDto.md b/docs/Models/Components/LmsUpsertContentRequestDto.md index db184680..a58eaf3b 100644 --- a/docs/Models/Components/LmsUpsertContentRequestDto.md +++ b/docs/Models/Components/LmsUpsertContentRequestDto.md @@ -19,4 +19,5 @@ | `duration` | *?string* | :heavy_minus_sign: | The duration of the content following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string or the minimum unit accepted by the provider. | P3Y6M4DT12H30M5S | | `skills` | array<[Components\CreateSkillsApiModel](../../Models/Components/CreateSkillsApiModel.md)> | :heavy_minus_sign: | The skills associated with this content | [
{
"id": "12345",
"name": "Sales Techniques"
}
] | | `order` | *?float* | :heavy_minus_sign: | The order of the individual content within a content grouping. This is not applicable for pushing individual content. | 1 | +| `provider` | *?string* | :heavy_minus_sign: | The name of the content provider | Content Provider | | `categories` | array<[Components\CreateCategoriesApiModel](../../Models/Components/CreateCategoriesApiModel.md)> | :heavy_minus_sign: | The categories associated with this content | | \ No newline at end of file diff --git a/docs/Models/Components/LmsUpsertCourseRequestDto.md b/docs/Models/Components/LmsUpsertCourseRequestDto.md index 03135a6f..b16df8b6 100644 --- a/docs/Models/Components/LmsUpsertCourseRequestDto.md +++ b/docs/Models/Components/LmsUpsertCourseRequestDto.md @@ -15,6 +15,7 @@ | `url` | *?string* | :heavy_minus_sign: | The redirect URL of the course. | https://www.linkedinlearning.com/?v=16873 | | `active` | *?bool* | :heavy_minus_sign: | Whether the course is active and available for users. | true | | `duration` | *?string* | :heavy_minus_sign: | The duration of the course following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string | P3Y6M4DT12H30M5S | +| `provider` | *?string* | :heavy_minus_sign: | The name of the course provider | Course Provider | | `categories` | array<[Components\CreateCategoriesApiModel](../../Models/Components/CreateCategoriesApiModel.md)> | :heavy_minus_sign: | The categories associated with this content | | | `skills` | array<[Components\CreateSkillsApiModel](../../Models/Components/CreateSkillsApiModel.md)> | :heavy_minus_sign: | The skills associated with this content | | | `content` | array<[Components\CreateContentApiModel](../../Models/Components/CreateContentApiModel.md)> | :heavy_minus_sign: | The content associated with this course | | \ No newline at end of file diff --git a/docs/Models/Components/UnifiedWarningApiModel.md b/docs/Models/Components/UnifiedWarningApiModel.md new file mode 100644 index 00000000..4a03e027 --- /dev/null +++ b/docs/Models/Components/UnifiedWarningApiModel.md @@ -0,0 +1,8 @@ +# UnifiedWarningApiModel + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `message` | *?string* | :heavy_minus_sign: | N/A | The provided field type is not supported in the current model. | \ No newline at end of file diff --git a/docs/Models/Components/WriteResultApiModel.md b/docs/Models/Components/WriteResultApiModel.md index c5fa8c26..801cbfd4 100644 --- a/docs/Models/Components/WriteResultApiModel.md +++ b/docs/Models/Components/WriteResultApiModel.md @@ -8,4 +8,5 @@ | `statusCode` | *?float* | :heavy_minus_sign: | N/A | 201 | | `message` | *?string* | :heavy_minus_sign: | N/A | Employee created successfully | | `timestamp` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2021-01-01T01:01:01.000Z | -| `providerErrors` | array<[Components\ProviderErrorApiModel](../../Models/Components/ProviderErrorApiModel.md)> | :heavy_minus_sign: | N/A | [
{
"status": 400,
"url": "https://api.someprovider.com/v1/endpoint",
"raw": {
"error": "Bad Request",
"message": "The supplied data is invalid"
},
"headers": {
"date": "Tue, 02 Apr 2024 13:52:01 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close"
}
}
] | \ No newline at end of file +| `providerErrors` | array<[Components\ProviderErrorApiModel](../../Models/Components/ProviderErrorApiModel.md)> | :heavy_minus_sign: | N/A | [
{
"status": 400,
"url": "https://api.someprovider.com/v1/endpoint",
"raw": {
"error": "Bad Request",
"message": "The supplied data is invalid"
},
"headers": {
"date": "Tue, 02 Apr 2024 13:52:01 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close"
}
}
] | +| `unifiedWarnings` | array<[Components\UnifiedWarningApiModel](../../Models/Components/UnifiedWarningApiModel.md)> | :heavy_minus_sign: | N/A | [
{
"message": "The provided field type is not supported in the current model."
}
] | \ No newline at end of file diff --git a/docs/Models/Operations/AtsCreateApplicationNoteRequest.md b/docs/Models/Operations/AtsCreateApplicationNoteRequest.md new file mode 100644 index 00000000..d9a6ba6a --- /dev/null +++ b/docs/Models/Operations/AtsCreateApplicationNoteRequest.md @@ -0,0 +1,10 @@ +# AtsCreateApplicationNoteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | +| `id` | *string* | :heavy_check_mark: | N/A | +| `atsCreateNotesRequestDto` | [Components\AtsCreateNotesRequestDto](../../Models/Components/AtsCreateNotesRequestDto.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Operations/AtsCreateApplicationNoteResponse.md b/docs/Models/Operations/AtsCreateApplicationNoteResponse.md new file mode 100644 index 00000000..5e1fb7cd --- /dev/null +++ b/docs/Models/Operations/AtsCreateApplicationNoteResponse.md @@ -0,0 +1,12 @@ +# AtsCreateApplicationNoteResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `headers` | array> | :heavy_check_mark: | N/A | +| `createResult` | [?Components\CreateResult](../../Models/Components/CreateResult.md) | :heavy_minus_sign: | Record created successfully. | \ No newline at end of file diff --git a/docs/Models/Operations/AtsGetApplicationNoteRequest.md b/docs/Models/Operations/AtsGetApplicationNoteRequest.md new file mode 100644 index 00000000..90259516 --- /dev/null +++ b/docs/Models/Operations/AtsGetApplicationNoteRequest.md @@ -0,0 +1,13 @@ +# AtsGetApplicationNoteRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | +| `id` | *string* | :heavy_check_mark: | N/A | | +| `subResourceId` | *string* | :heavy_check_mark: | N/A | | +| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `fields` | *?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,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at | \ No newline at end of file diff --git a/docs/Models/Operations/AtsGetApplicationNoteResponse.md b/docs/Models/Operations/AtsGetApplicationNoteResponse.md new file mode 100644 index 00000000..607c40ce --- /dev/null +++ b/docs/Models/Operations/AtsGetApplicationNoteResponse.md @@ -0,0 +1,12 @@ +# AtsGetApplicationNoteResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `headers` | array> | :heavy_check_mark: | N/A | +| `noteResult` | [?Components\NoteResult](../../Models/Components/NoteResult.md) | :heavy_minus_sign: | The note with the given identifier related to the application with the given identifier was retrieved. | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListApplicationNotesQueryParamFilter.md b/docs/Models/Operations/AtsListApplicationNotesQueryParamFilter.md new file mode 100644 index 00000000..173ca99a --- /dev/null +++ b/docs/Models/Operations/AtsListApplicationNotesQueryParamFilter.md @@ -0,0 +1,10 @@ +# AtsListApplicationNotesQueryParamFilter + +Filter parameters that allow greater customisation of the list response + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `updatedAfter` | *?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/AtsListApplicationNotesRequest.md b/docs/Models/Operations/AtsListApplicationNotesRequest.md new file mode 100644 index 00000000..b6f42a26 --- /dev/null +++ b/docs/Models/Operations/AtsListApplicationNotesRequest.md @@ -0,0 +1,18 @@ +# AtsListApplicationNotesRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | +| `id` | *string* | :heavy_check_mark: | N/A | | +| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `fields` | *?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,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at | +| `filter` | [?Operations\AtsListApplicationNotesQueryParamFilter](../../Models/Operations/AtsListApplicationNotesQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | +| ~~`page`~~ | *?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 | | +| `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | +| `next` | *?string* | :heavy_minus_sign: | The unified cursor | | +| ~~`updatedAfter`~~ | *?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 | +| ~~`syncToken`~~ | *?string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The sync token to select the only updated results | | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListApplicationNotesResponse.md b/docs/Models/Operations/AtsListApplicationNotesResponse.md new file mode 100644 index 00000000..5903eec3 --- /dev/null +++ b/docs/Models/Operations/AtsListApplicationNotesResponse.md @@ -0,0 +1,12 @@ +# AtsListApplicationNotesResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `headers` | array> | :heavy_check_mark: | N/A | +| `notesPaginated` | [?Components\NotesPaginated](../../Models/Components/NotesPaginated.md) | :heavy_minus_sign: | The notes related to the application with the given identifier was retrieved. | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListApplicationsQueryParamFilter.md b/docs/Models/Operations/AtsListApplicationsQueryParamFilter.md index ddb35592..f94f5fb4 100644 --- a/docs/Models/Operations/AtsListApplicationsQueryParamFilter.md +++ b/docs/Models/Operations/AtsListApplicationsQueryParamFilter.md @@ -8,5 +8,6 @@ ATS Application Filter | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `updatedAfter` | *?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 | +| `createdAfter` | *?string* | :heavy_minus_sign: | Use a string with a date to only select results created after that given date | 2020-01-01T00:00:00.000Z | | `jobId` | *?string* | :heavy_minus_sign: | Filter to select applications by job_id | | | `stage` | *?string* | :heavy_minus_sign: | Filter to select applications by stage and sub-stage | | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListCandidatesQueryParamFilter.md b/docs/Models/Operations/AtsListCandidatesQueryParamFilter.md index 8014375b..357844c5 100644 --- a/docs/Models/Operations/AtsListCandidatesQueryParamFilter.md +++ b/docs/Models/Operations/AtsListCandidatesQueryParamFilter.md @@ -8,4 +8,5 @@ ATS Candidate Filter | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `updatedAfter` | *?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 | +| `createdAfter` | *?string* | :heavy_minus_sign: | Use a string with a date to only select results created after that given date | 2020-01-01T00:00:00.000Z | | `email` | *?string* | :heavy_minus_sign: | Filter to select candidates by email | | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListInterviewsQueryParamFilter.md b/docs/Models/Operations/AtsListInterviewsQueryParamFilter.md index de1a254d..2cb698ce 100644 --- a/docs/Models/Operations/AtsListInterviewsQueryParamFilter.md +++ b/docs/Models/Operations/AtsListInterviewsQueryParamFilter.md @@ -1,10 +1,11 @@ # AtsListInterviewsQueryParamFilter -Filter parameters that allow greater customisation of the list response +ATS Interviews Filter ## Fields | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `updatedAfter` | *?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 +| `updatedAfter` | *?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 | +| `createdAfter` | *?string* | :heavy_minus_sign: | Use a string with a date to only select results created after that given date | 2020-01-01T00:00:00.000Z | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListInterviewsRequest.md b/docs/Models/Operations/AtsListInterviewsRequest.md index ad774f85..6feb0a64 100644 --- a/docs/Models/Operations/AtsListInterviewsRequest.md +++ b/docs/Models/Operations/AtsListInterviewsRequest.md @@ -9,7 +9,7 @@ | `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | | `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | | `fields` | *?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,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 | -| `filter` | [?Operations\AtsListInterviewsQueryParamFilter](../../Models/Operations/AtsListInterviewsQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | +| `filter` | [?Operations\AtsListInterviewsQueryParamFilter](../../Models/Operations/AtsListInterviewsQueryParamFilter.md) | :heavy_minus_sign: | ATS Interviews Filter | | | ~~`page`~~ | *?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 | | | `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | | `next` | *?string* | :heavy_minus_sign: | The unified cursor | | diff --git a/docs/Models/Operations/AtsListJobPostingsQueryParamFilter.md b/docs/Models/Operations/AtsListJobPostingsQueryParamFilter.md index fc78b0f0..5e9e77a7 100644 --- a/docs/Models/Operations/AtsListJobPostingsQueryParamFilter.md +++ b/docs/Models/Operations/AtsListJobPostingsQueryParamFilter.md @@ -1,10 +1,11 @@ # AtsListJobPostingsQueryParamFilter -Filter parameters that allow greater customisation of the list response +ATS Job Postings Filter ## Fields | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `updatedAfter` | *?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 +| `updatedAfter` | *?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 | +| `createdAfter` | *?string* | :heavy_minus_sign: | Use a string with a date to only select results created after that given date | 2020-01-01T00:00:00.000Z | \ No newline at end of file diff --git a/docs/Models/Operations/AtsListJobPostingsRequest.md b/docs/Models/Operations/AtsListJobPostingsRequest.md index c40c0b17..54f21640 100644 --- a/docs/Models/Operations/AtsListJobPostingsRequest.md +++ b/docs/Models/Operations/AtsListJobPostingsRequest.md @@ -9,7 +9,7 @@ | `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | | `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | | `fields` | *?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,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 | -| `filter` | [?Operations\AtsListJobPostingsQueryParamFilter](../../Models/Operations/AtsListJobPostingsQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | +| `filter` | [?Operations\AtsListJobPostingsQueryParamFilter](../../Models/Operations/AtsListJobPostingsQueryParamFilter.md) | :heavy_minus_sign: | ATS Job Postings Filter | | | ~~`page`~~ | *?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 | | | `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | | `next` | *?string* | :heavy_minus_sign: | The unified cursor | | diff --git a/docs/Models/Operations/AtsListJobsQueryParamFilter.md b/docs/Models/Operations/AtsListJobsQueryParamFilter.md index e27ec0a7..9355a474 100644 --- a/docs/Models/Operations/AtsListJobsQueryParamFilter.md +++ b/docs/Models/Operations/AtsListJobsQueryParamFilter.md @@ -5,7 +5,9 @@ ATS Jobs filters ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `updatedAfter` | *?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 | -| `status` | [?Operations\Status](../../Models/Operations/Status.md) | :heavy_minus_sign: | The status of the job | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `updatedAfter` | *?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 | +| `createdAfter` | *?string* | :heavy_minus_sign: | Use a string with a date to only select results created after that given date | 2020-01-01T00:00:00.000Z | +| ~~`status`~~ | [?Operations\Status](../../Models/Operations/Status.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The status of the job | | +| `jobStatus` | [?Operations\JobStatus](../../Models/Operations/JobStatus.md) | :heavy_minus_sign: | The job_status of the job | | \ No newline at end of file diff --git a/docs/Models/Operations/AtsUpdateApplicationNoteRequest.md b/docs/Models/Operations/AtsUpdateApplicationNoteRequest.md new file mode 100644 index 00000000..704d2ae2 --- /dev/null +++ b/docs/Models/Operations/AtsUpdateApplicationNoteRequest.md @@ -0,0 +1,11 @@ +# AtsUpdateApplicationNoteRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | +| `id` | *string* | :heavy_check_mark: | N/A | +| `subResourceId` | *string* | :heavy_check_mark: | N/A | +| `atsUpdateNotesRequestDto` | [Components\AtsUpdateNotesRequestDto](../../Models/Components/AtsUpdateNotesRequestDto.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Operations/AtsUpdateApplicationNoteResponse.md b/docs/Models/Operations/AtsUpdateApplicationNoteResponse.md new file mode 100644 index 00000000..596450af --- /dev/null +++ b/docs/Models/Operations/AtsUpdateApplicationNoteResponse.md @@ -0,0 +1,12 @@ +# AtsUpdateApplicationNoteResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `headers` | array> | :heavy_check_mark: | N/A | +| `updateResult` | [?Components\UpdateResult](../../Models/Components/UpdateResult.md) | :heavy_minus_sign: | Record updated successfully. | \ No newline at end of file diff --git a/docs/Models/Operations/JobStatus.md b/docs/Models/Operations/JobStatus.md new file mode 100644 index 00000000..a80224de --- /dev/null +++ b/docs/Models/Operations/JobStatus.md @@ -0,0 +1,11 @@ +# JobStatus + +The job_status of the job + + +## Values + +| Name | Value | +| ------- | ------- | +| `Open` | open | +| `Draft` | draft | \ No newline at end of file diff --git a/docs/Models/Operations/LmsGetCategoryRequest.md b/docs/Models/Operations/LmsGetCategoryRequest.md index b8950857..ecb933f6 100644 --- a/docs/Models/Operations/LmsGetCategoryRequest.md +++ b/docs/Models/Operations/LmsGetCategoryRequest.md @@ -9,4 +9,4 @@ | `id` | *string* | :heavy_check_mark: | N/A | | | `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | | `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `fields` | *?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,active,level | \ No newline at end of file +| `fields` | *?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,active,level,language | \ No newline at end of file diff --git a/docs/Models/Operations/LmsGetContentRequest.md b/docs/Models/Operations/LmsGetContentRequest.md index b2591e81..dabe6e20 100644 --- a/docs/Models/Operations/LmsGetContentRequest.md +++ b/docs/Models/Operations/LmsGetContentRequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `fields` | *?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,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | +| `id` | *string* | :heavy_check_mark: | N/A | | +| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `fields` | *?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,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider | \ No newline at end of file diff --git a/docs/Models/Operations/LmsGetCourseRequest.md b/docs/Models/Operations/LmsGetCourseRequest.md index def5ece1..562d6c7a 100644 --- a/docs/Models/Operations/LmsGetCourseRequest.md +++ b/docs/Models/Operations/LmsGetCourseRequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `fields` | *?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,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | +| `id` | *string* | :heavy_check_mark: | N/A | | +| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `fields` | *?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,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider | \ No newline at end of file diff --git a/docs/Models/Operations/LmsListCategoriesRequest.md b/docs/Models/Operations/LmsListCategoriesRequest.md index 2cfc0685..0099b9e6 100644 --- a/docs/Models/Operations/LmsListCategoriesRequest.md +++ b/docs/Models/Operations/LmsListCategoriesRequest.md @@ -8,7 +8,7 @@ | `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | | `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | | `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `fields` | *?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,active,level | +| `fields` | *?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,active,level,language | | `filter` | [?Operations\LmsListCategoriesQueryParamFilter](../../Models/Operations/LmsListCategoriesQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | | ~~`page`~~ | *?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 | | | `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | diff --git a/docs/Models/Operations/LmsListContentRequest.md b/docs/Models/Operations/LmsListContentRequest.md index 9f61fdbe..c68355b6 100644 --- a/docs/Models/Operations/LmsListContentRequest.md +++ b/docs/Models/Operations/LmsListContentRequest.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | -| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | -| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `fields` | *?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,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at | -| `filter` | [?Operations\LmsListContentQueryParamFilter](../../Models/Operations/LmsListContentQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | -| ~~`page`~~ | *?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 | | -| `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | -| `next` | *?string* | :heavy_minus_sign: | The unified cursor | | -| ~~`updatedAfter`~~ | *?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 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | +| `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | +| `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | +| `fields` | *?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,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider | +| `filter` | [?Operations\LmsListContentQueryParamFilter](../../Models/Operations/LmsListContentQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | +| ~~`page`~~ | *?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 | | +| `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | +| `next` | *?string* | :heavy_minus_sign: | The unified cursor | | +| ~~`updatedAfter`~~ | *?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 | \ No newline at end of file diff --git a/docs/Models/Operations/LmsListCoursesRequest.md b/docs/Models/Operations/LmsListCoursesRequest.md index 20001a27..e1fbf281 100644 --- a/docs/Models/Operations/LmsListCoursesRequest.md +++ b/docs/Models/Operations/LmsListCoursesRequest.md @@ -8,7 +8,7 @@ | `xAccountId` | *string* | :heavy_check_mark: | The account identifier | | | `raw` | *?bool* | :heavy_minus_sign: | Indicates that the raw request result is returned | | | `proxy` | array | :heavy_minus_sign: | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | | -| `fields` | *?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,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content | +| `fields` | *?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,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider | | `filter` | [?Operations\LmsListCoursesQueryParamFilter](../../Models/Operations/LmsListCoursesQueryParamFilter.md) | :heavy_minus_sign: | Filter parameters that allow greater customisation of the list response | | | ~~`page`~~ | *?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 | | | `pageSize` | *?string* | :heavy_minus_sign: | The number of results per page | | diff --git a/docs/Models/Operations/Status.md b/docs/Models/Operations/Status.md index 5697a074..c48805f8 100644 --- a/docs/Models/Operations/Status.md +++ b/docs/Models/Operations/Status.md @@ -1,7 +1,9 @@ -# Status +# ~~Status~~ The status of the job +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. + ## Values diff --git a/docs/sdks/ats/README.md b/docs/sdks/ats/README.md index 855447a4..583a6245 100644 --- a/docs/sdks/ats/README.md +++ b/docs/sdks/ats/README.md @@ -6,6 +6,7 @@ ### Available Operations * [createApplication](#createapplication) - Create Application +* [createApplicationNote](#createapplicationnote) - Create Application Note * [createBackgroundCheckPackage](#createbackgroundcheckpackage) - Create Background Check Package * [createCandidate](#createcandidate) - Create Candidate * [createCandidateNote](#createcandidatenote) - Create Candidate Note @@ -15,6 +16,7 @@ * [getApplication](#getapplication) - Get Application * [getApplicationCustomFieldDefinition](#getapplicationcustomfielddefinition) - Get Application Custom Field Definition * [getApplicationDocument](#getapplicationdocument) - Get Application Document +* [getApplicationNote](#getapplicationnote) - Get Application Note * [getApplicationOffer](#getapplicationoffer) - Get Application Offer * [getApplicationScheduledInterview](#getapplicationscheduledinterview) - Get Applications scheduled interview * [getApplicationScorecard](#getapplicationscorecard) - Get Application Scorecard @@ -40,6 +42,7 @@ * [getUser](#getuser) - Get User * [listApplicationCustomFieldDefinitions](#listapplicationcustomfielddefinitions) - List Application Custom Field Definitions * [listApplicationDocuments](#listapplicationdocuments) - List Application Documents +* [listApplicationNotes](#listapplicationnotes) - List Application Notes * [listApplicationScorecards](#listapplicationscorecards) - List Application Scorecards * [listApplications](#listapplications) - List Applications * [listApplicationsOffers](#listapplicationsoffers) - List Application Offers @@ -64,6 +67,7 @@ * [moveApplication](#moveapplication) - Move Application * [rejectApplication](#rejectapplication) - Reject Application * [updateApplication](#updateapplication) - Update an Application +* [updateApplicationNote](#updateapplicationnote) - Update an Application Note * [updateCandidate](#updatecandidate) - Update Candidate * [updateJob](#updatejob) - Update Job * [uploadApplicationDocument](#uploadapplicationdocument) - Upload Application Document @@ -184,6 +188,70 @@ if ($response->createResult !== null) { | ------------------- | ------------------- | ------------------- | | Errors\SDKException | 4XX, 5XX | \*/\* | +## createApplicationNote + +Create Application Note + +### Example Usage + +```php +declare(strict_types=1); + +require 'vendor/autoload.php'; + +use StackOne\client; +use StackOne\client\Models\Components; + +$security = new Components\Security( + username: '', + password: '', +); + +$sdk = client\StackOne::builder()->setSecurity($security)->build(); + +$atsCreateNotesRequestDto = new Components\AtsCreateNotesRequestDto( + content: [ + new Components\NoteContentApiModel( + body: 'This candidate seems like a good fit for the role', + ), + ], + authorId: '1234567890', + visibility: new Components\AtsCreateNotesRequestDtoVisibility(), + passthrough: [ + 'other_known_names' => 'John Doe', + ], +); + +$response = $sdk->ats->createApplicationNote( + xAccountId: '', + id: '', + atsCreateNotesRequestDto: $atsCreateNotesRequestDto + +); + +if ($response->createResult !== null) { + // handle response +} +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | +| `id` | *string* | :heavy_check_mark: | N/A | +| `atsCreateNotesRequestDto` | [Components\AtsCreateNotesRequestDto](../../Models/Components/AtsCreateNotesRequestDto.md) | :heavy_check_mark: | N/A | + +### Response + +**[?Operations\AtsCreateApplicationNoteResponse](../../Models/Operations/AtsCreateApplicationNoteResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------- | ------------------- | ------------------- | +| Errors\SDKException | 4XX, 5XX | \*/\* | + ## createBackgroundCheckPackage Create Background Check Package @@ -792,6 +860,60 @@ if ($response->atsDocumentResult !== null) { | ------------------- | ------------------- | ------------------- | | Errors\SDKException | 4XX, 5XX | \*/\* | +## getApplicationNote + +Get Application Note + +### Example Usage + +```php +declare(strict_types=1); + +require 'vendor/autoload.php'; + +use StackOne\client; +use StackOne\client\Models\Components; +use StackOne\client\Models\Operations; + +$security = new Components\Security( + username: '', + password: '', +); + +$sdk = client\StackOne::builder()->setSecurity($security)->build(); + +$request = new Operations\AtsGetApplicationNoteRequest( + xAccountId: '', + id: '', + subResourceId: '', + fields: 'id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at', +); + +$response = $sdk->ats->getApplicationNote( + request: $request +); + +if ($response->noteResult !== null) { + // handle response +} +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `$request` | [Operations\AtsGetApplicationNoteRequest](../../Models/Operations/AtsGetApplicationNoteRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[?Operations\AtsGetApplicationNoteResponse](../../Models/Operations/AtsGetApplicationNoteResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------- | ------------------- | ------------------- | +| Errors\SDKException | 4XX, 5XX | \*/\* | + ## getApplicationOffer Get Application Offer @@ -2135,6 +2257,62 @@ if ($response->atsDocumentsPaginated !== null) { | ------------------- | ------------------- | ------------------- | | Errors\SDKException | 4XX, 5XX | \*/\* | +## listApplicationNotes + +List Application Notes + +### Example Usage + +```php +declare(strict_types=1); + +require 'vendor/autoload.php'; + +use StackOne\client; +use StackOne\client\Models\Components; +use StackOne\client\Models\Operations; + +$security = new Components\Security( + username: '', + password: '', +); + +$sdk = client\StackOne::builder()->setSecurity($security)->build(); + +$request = new Operations\AtsListApplicationNotesRequest( + xAccountId: '', + id: '', + fields: 'id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at', + filter: new Operations\AtsListApplicationNotesQueryParamFilter( + updatedAfter: '2020-01-01T00:00:00.000Z', + ), +); + +$response = $sdk->ats->listApplicationNotes( + request: $request +); + +if ($response->notesPaginated !== null) { + // handle response +} +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `$request` | [Operations\AtsListApplicationNotesRequest](../../Models/Operations/AtsListApplicationNotesRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[?Operations\AtsListApplicationNotesResponse](../../Models/Operations/AtsListApplicationNotesResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------- | ------------------- | ------------------- | +| Errors\SDKException | 4XX, 5XX | \*/\* | + ## listApplicationScorecards List Application Scorecards @@ -2218,6 +2396,7 @@ $request = new Operations\AtsListApplicationsRequest( fields: 'id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_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,custom_fields,candidate', filter: new Operations\AtsListApplicationsQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', + createdAfter: '2020-01-01T00:00:00.000Z', ), expand: 'documents', include: 'attachments,custom_fields', @@ -2662,6 +2841,7 @@ $request = new Operations\AtsListCandidatesRequest( fields: 'id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at', filter: new Operations\AtsListCandidatesQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', + createdAfter: '2020-01-01T00:00:00.000Z', ), include: 'custom_fields', ); @@ -2828,6 +3008,7 @@ $request = new Operations\AtsListInterviewsRequest( 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', filter: new Operations\AtsListInterviewsQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', + createdAfter: '2020-01-01T00:00:00.000Z', ), ); @@ -2938,6 +3119,7 @@ $request = new Operations\AtsListJobPostingsRequest( 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', filter: new Operations\AtsListJobPostingsQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', + createdAfter: '2020-01-01T00:00:00.000Z', ), include: 'questionnaires', ); @@ -2994,6 +3176,7 @@ $request = new Operations\AtsListJobsRequest( fields: 'id,remote_id,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at', filter: new Operations\AtsListJobsQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', + createdAfter: '2020-01-01T00:00:00.000Z', ), expand: 'job_postings,interview_stages', include: 'custom_fields', @@ -3491,6 +3674,72 @@ if ($response->updateResult !== null) { | ------------------- | ------------------- | ------------------- | | Errors\SDKException | 4XX, 5XX | \*/\* | +## updateApplicationNote + +Update an Application Note + +### Example Usage + +```php +declare(strict_types=1); + +require 'vendor/autoload.php'; + +use StackOne\client; +use StackOne\client\Models\Components; + +$security = new Components\Security( + username: '', + password: '', +); + +$sdk = client\StackOne::builder()->setSecurity($security)->build(); + +$atsUpdateNotesRequestDto = new Components\AtsUpdateNotesRequestDto( + content: [ + new Components\NoteContentApiModel( + body: 'This candidate seems like a good fit for the role', + ), + ], + authorId: '1234567890', + visibility: new Components\AtsUpdateNotesRequestDtoVisibility(), + passthrough: [ + 'other_known_names' => 'John Doe', + ], +); + +$response = $sdk->ats->updateApplicationNote( + xAccountId: '', + id: '', + subResourceId: '', + atsUpdateNotesRequestDto: $atsUpdateNotesRequestDto + +); + +if ($response->updateResult !== null) { + // handle response +} +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `xAccountId` | *string* | :heavy_check_mark: | The account identifier | +| `id` | *string* | :heavy_check_mark: | N/A | +| `subResourceId` | *string* | :heavy_check_mark: | N/A | +| `atsUpdateNotesRequestDto` | [Components\AtsUpdateNotesRequestDto](../../Models/Components/AtsUpdateNotesRequestDto.md) | :heavy_check_mark: | N/A | + +### Response + +**[?Operations\AtsUpdateApplicationNoteResponse](../../Models/Operations/AtsUpdateApplicationNoteResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ------------------- | ------------------- | ------------------- | +| Errors\SDKException | 4XX, 5XX | \*/\* | + ## updateCandidate Update Candidate diff --git a/docs/sdks/lms/README.md b/docs/sdks/lms/README.md index dfc06030..d0edd849 100644 --- a/docs/sdks/lms/README.md +++ b/docs/sdks/lms/README.md @@ -83,6 +83,7 @@ $lmsBatchUpsertContentRequestDto = new Components\LmsBatchUpsertContentRequestDt ), ], order: 1, + provider: 'Content Provider', categories: [ new Components\CreateCategoriesApiModel( id: '16873-IT345', @@ -91,6 +92,9 @@ $lmsBatchUpsertContentRequestDto = new Components\LmsBatchUpsertContentRequestDt 'my_project_custom_field_2' => 'some other value', ], name: 'Information-Technology', + language: new Components\Language( + value: Components\CreateCategoriesApiModelLanguageValue::EnGB, + ), ), ], ), @@ -168,6 +172,7 @@ $lmsBatchUpsertCourseRequestDto = new Components\LmsBatchUpsertCourseRequestDto( url: 'https://www.linkedinlearning.com/?v=16873', active: true, duration: 'P3Y6M4DT12H30M5S', + provider: 'Course Provider', categories: [ new Components\CreateCategoriesApiModel( id: '16873-IT345', @@ -176,6 +181,9 @@ $lmsBatchUpsertCourseRequestDto = new Components\LmsBatchUpsertCourseRequestDto( 'my_project_custom_field_2' => 'some other value', ], name: 'Information-Technology', + language: new Components\Language( + value: Components\CreateCategoriesApiModelLanguageValue::EnGB, + ), ), ], skills: [ @@ -270,6 +278,9 @@ $lmsCreateCollectionRequestDto = new Components\LmsCreateCollectionRequestDto( 'my_project_custom_field_2' => 'some other value', ], name: 'Information-Technology', + language: new Components\Language( + value: Components\CreateCategoriesApiModelLanguageValue::EnGB, + ), ), ], skills: [ @@ -512,7 +523,7 @@ $sdk = client\StackOne::builder()->setSecurity($security)->build(); $request = new Operations\LmsGetCategoryRequest( xAccountId: '', id: '', - fields: 'id,remote_id,name,active,level', + fields: 'id,remote_id,name,active,level,language', ); $response = $sdk->lms->getCategory( @@ -617,7 +628,7 @@ $sdk = client\StackOne::builder()->setSecurity($security)->build(); $request = new Operations\LmsGetContentRequest( xAccountId: '', id: '', - fields: 'id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at', + fields: 'id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider', ); $response = $sdk->lms->getContent( @@ -670,7 +681,7 @@ $sdk = client\StackOne::builder()->setSecurity($security)->build(); $request = new Operations\LmsGetCourseRequest( xAccountId: '', id: '', - fields: 'id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content', + fields: 'id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider', ); $response = $sdk->lms->getCourse( @@ -991,7 +1002,7 @@ $sdk = client\StackOne::builder()->setSecurity($security)->build(); $request = new Operations\LmsListCategoriesRequest( xAccountId: '', - fields: 'id,remote_id,name,active,level', + fields: 'id,remote_id,name,active,level,language', filter: new Operations\LmsListCategoriesQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', ), @@ -1101,7 +1112,7 @@ $sdk = client\StackOne::builder()->setSecurity($security)->build(); $request = new Operations\LmsListContentRequest( xAccountId: '', - fields: 'id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at', + fields: 'id,remote_id,external_reference,course_ids,remote_course_ids,title,description,short_description,languages,content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider', filter: new Operations\LmsListContentQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', ), @@ -1156,7 +1167,7 @@ $sdk = client\StackOne::builder()->setSecurity($security)->build(); $request = new Operations\LmsListCoursesRequest( xAccountId: '', - fields: 'id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content', + fields: 'id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider', filter: new Operations\LmsListCoursesQueryParamFilter( updatedAfter: '2020-01-01T00:00:00.000Z', ), @@ -1457,6 +1468,9 @@ $lmsCreateCollectionRequestDto = new Components\LmsCreateCollectionRequestDto( 'my_project_custom_field_2' => 'some other value', ], name: 'Information-Technology', + language: new Components\Language( + value: Components\CreateCategoriesApiModelLanguageValue::EnGB, + ), ), ], skills: [ @@ -1546,6 +1560,7 @@ $lmsUpsertContentRequestDto = new Components\LmsUpsertContentRequestDto( ), ], order: 1, + provider: 'Content Provider', categories: [ new Components\CreateCategoriesApiModel( id: '16873-IT345', @@ -1554,6 +1569,9 @@ $lmsUpsertContentRequestDto = new Components\LmsUpsertContentRequestDto( 'my_project_custom_field_2' => 'some other value', ], name: 'Information-Technology', + language: new Components\Language( + value: Components\CreateCategoriesApiModelLanguageValue::EnGB, + ), ), ], ); @@ -1627,6 +1645,7 @@ $lmsUpsertCourseRequestDto = new Components\LmsUpsertCourseRequestDto( url: 'https://www.linkedinlearning.com/?v=16873', active: true, duration: 'P3Y6M4DT12H30M5S', + provider: 'Course Provider', categories: [ new Components\CreateCategoriesApiModel( id: '16873-IT345', @@ -1635,6 +1654,9 @@ $lmsUpsertCourseRequestDto = new Components\LmsUpsertCourseRequestDto( 'my_project_custom_field_2' => 'some other value', ], name: 'Information-Technology', + language: new Components\Language( + value: Components\CreateCategoriesApiModelLanguageValue::EnGB, + ), ), ], skills: [ diff --git a/src/Ats.php b/src/Ats.php index 62b049fb..cbe184bc 100644 --- a/src/Ats.php +++ b/src/Ats.php @@ -122,6 +122,85 @@ public function createApplication(Components\AtsCreateApplicationRequestDto $ats } } + /** + * Create Application Note + * + * @param Components\AtsCreateNotesRequestDto $atsCreateNotesRequestDto + * @param string $xAccountId + * @param string $id + * @return Operations\AtsCreateApplicationNoteResponse + * @throws \StackOne\client\Models\Errors\SDKException + */ + public function createApplicationNote(Components\AtsCreateNotesRequestDto $atsCreateNotesRequestDto, string $xAccountId, string $id, ?Options $options = null): Operations\AtsCreateApplicationNoteResponse + { + $request = new Operations\AtsCreateApplicationNoteRequest( + xAccountId: $xAccountId, + id: $id, + atsCreateNotesRequestDto: $atsCreateNotesRequestDto, + ); + $baseUrl = $this->sdkConfiguration->getServerUrl(); + $url = Utils\Utils::generateUrl($baseUrl, '/unified/ats/applications/{id}/notes', Operations\AtsCreateApplicationNoteRequest::class, $request); + $urlOverride = null; + $httpOptions = ['http_errors' => false]; + $body = Utils\Utils::serializeRequestBody($request, 'atsCreateNotesRequestDto', 'json'); + if ($body === null) { + throw new \Exception('Request body is required'); + } + $httpOptions = array_merge_recursive($httpOptions, $body); + $httpOptions = array_merge_recursive($httpOptions, Utils\Utils::getHeaders($request)); + if (! array_key_exists('headers', $httpOptions)) { + $httpOptions['headers'] = []; + } + $httpOptions['headers']['Accept'] = 'application/json'; + $httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent; + $httpRequest = new \GuzzleHttp\Psr7\Request('POST', $url); + $hookContext = new HookContext('ats_create_application_note', null, $this->sdkConfiguration->securitySource); + $httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest); + $httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions); + $httpRequest = Utils\Utils::removeHeaders($httpRequest); + try { + $httpResponse = $this->sdkConfiguration->client->send($httpRequest, $httpOptions); + } catch (\GuzzleHttp\Exception\GuzzleException $error) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), null, $error); + if ($res !== null) { + $httpResponse = $res; + } + } + $contentType = $httpResponse->getHeader('Content-Type')[0] ?? ''; + + $statusCode = $httpResponse->getStatusCode(); + if ($statusCode == 400 || $statusCode == 403 || $statusCode == 408 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), $httpResponse, null); + if ($res !== null) { + $httpResponse = $res; + } + } + if ($statusCode == 201) { + if (Utils\Utils::matchContentType($contentType, 'application/json')) { + $httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse); + + $serializer = Utils\JSON::createSerializer(); + $responseData = (string) $httpResponse->getBody(); + $obj = $serializer->deserialize($responseData, '\StackOne\client\Models\Components\CreateResult', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true)); + $response = new Operations\AtsCreateApplicationNoteResponse( + statusCode: $statusCode, + contentType: $contentType, + rawResponse: $httpResponse, + createResult: $obj); + + return $response; + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } elseif ($statusCode == 400 || $statusCode == 403 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } elseif ($statusCode == 408) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown status code received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } + /** * Create Background Check Package * @@ -795,6 +874,76 @@ public function getApplicationDocument(Operations\AtsGetApplicationDocumentReque } } + /** + * Get Application Note + * + * @param Operations\AtsGetApplicationNoteRequest $request + * @return Operations\AtsGetApplicationNoteResponse + * @throws \StackOne\client\Models\Errors\SDKException + */ + public function getApplicationNote(Operations\AtsGetApplicationNoteRequest $request, ?Options $options = null): Operations\AtsGetApplicationNoteResponse + { + $baseUrl = $this->sdkConfiguration->getServerUrl(); + $url = Utils\Utils::generateUrl($baseUrl, '/unified/ats/applications/{id}/notes/{subResourceId}', Operations\AtsGetApplicationNoteRequest::class, $request); + $urlOverride = null; + $httpOptions = ['http_errors' => false]; + + $qp = Utils\Utils::getQueryParams(Operations\AtsGetApplicationNoteRequest::class, $request, $urlOverride); + $httpOptions = array_merge_recursive($httpOptions, Utils\Utils::getHeaders($request)); + if (! array_key_exists('headers', $httpOptions)) { + $httpOptions['headers'] = []; + } + $httpOptions['headers']['Accept'] = 'application/json'; + $httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent; + $httpRequest = new \GuzzleHttp\Psr7\Request('GET', $url); + $hookContext = new HookContext('ats_get_application_note', null, $this->sdkConfiguration->securitySource); + $httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest); + $httpOptions['query'] = Utils\QueryParameters::standardizeQueryParams($httpRequest, $qp); + $httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions); + $httpRequest = Utils\Utils::removeHeaders($httpRequest); + try { + $httpResponse = $this->sdkConfiguration->client->send($httpRequest, $httpOptions); + } catch (\GuzzleHttp\Exception\GuzzleException $error) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), null, $error); + if ($res !== null) { + $httpResponse = $res; + } + } + $contentType = $httpResponse->getHeader('Content-Type')[0] ?? ''; + + $statusCode = $httpResponse->getStatusCode(); + if ($statusCode == 400 || $statusCode == 403 || $statusCode == 408 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), $httpResponse, null); + if ($res !== null) { + $httpResponse = $res; + } + } + if ($statusCode == 200) { + if (Utils\Utils::matchContentType($contentType, 'application/json')) { + $httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse); + + $serializer = Utils\JSON::createSerializer(); + $responseData = (string) $httpResponse->getBody(); + $obj = $serializer->deserialize($responseData, '\StackOne\client\Models\Components\NoteResult', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true)); + $response = new Operations\AtsGetApplicationNoteResponse( + statusCode: $statusCode, + contentType: $contentType, + rawResponse: $httpResponse, + noteResult: $obj); + + return $response; + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } elseif ($statusCode == 400 || $statusCode == 403 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } elseif ($statusCode == 408) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown status code received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } + /** * Get Application Offer * @@ -2545,6 +2694,76 @@ public function listApplicationDocuments(Operations\AtsListApplicationDocumentsR } } + /** + * List Application Notes + * + * @param Operations\AtsListApplicationNotesRequest $request + * @return Operations\AtsListApplicationNotesResponse + * @throws \StackOne\client\Models\Errors\SDKException + */ + public function listApplicationNotes(Operations\AtsListApplicationNotesRequest $request, ?Options $options = null): Operations\AtsListApplicationNotesResponse + { + $baseUrl = $this->sdkConfiguration->getServerUrl(); + $url = Utils\Utils::generateUrl($baseUrl, '/unified/ats/applications/{id}/notes', Operations\AtsListApplicationNotesRequest::class, $request); + $urlOverride = null; + $httpOptions = ['http_errors' => false]; + + $qp = Utils\Utils::getQueryParams(Operations\AtsListApplicationNotesRequest::class, $request, $urlOverride); + $httpOptions = array_merge_recursive($httpOptions, Utils\Utils::getHeaders($request)); + if (! array_key_exists('headers', $httpOptions)) { + $httpOptions['headers'] = []; + } + $httpOptions['headers']['Accept'] = 'application/json'; + $httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent; + $httpRequest = new \GuzzleHttp\Psr7\Request('GET', $url); + $hookContext = new HookContext('ats_list_application_notes', null, $this->sdkConfiguration->securitySource); + $httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest); + $httpOptions['query'] = Utils\QueryParameters::standardizeQueryParams($httpRequest, $qp); + $httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions); + $httpRequest = Utils\Utils::removeHeaders($httpRequest); + try { + $httpResponse = $this->sdkConfiguration->client->send($httpRequest, $httpOptions); + } catch (\GuzzleHttp\Exception\GuzzleException $error) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), null, $error); + if ($res !== null) { + $httpResponse = $res; + } + } + $contentType = $httpResponse->getHeader('Content-Type')[0] ?? ''; + + $statusCode = $httpResponse->getStatusCode(); + if ($statusCode == 400 || $statusCode == 403 || $statusCode == 408 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), $httpResponse, null); + if ($res !== null) { + $httpResponse = $res; + } + } + if ($statusCode == 200) { + if (Utils\Utils::matchContentType($contentType, 'application/json')) { + $httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse); + + $serializer = Utils\JSON::createSerializer(); + $responseData = (string) $httpResponse->getBody(); + $obj = $serializer->deserialize($responseData, '\StackOne\client\Models\Components\NotesPaginated', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true)); + $response = new Operations\AtsListApplicationNotesResponse( + statusCode: $statusCode, + contentType: $contentType, + rawResponse: $httpResponse, + notesPaginated: $obj); + + return $response; + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } elseif ($statusCode == 400 || $statusCode == 403 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } elseif ($statusCode == 408) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown status code received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } + /** * List Application Scorecards * @@ -4252,6 +4471,87 @@ public function updateApplication(Components\AtsUpdateApplicationRequestDto $ats } } + /** + * Update an Application Note + * + * @param Components\AtsUpdateNotesRequestDto $atsUpdateNotesRequestDto + * @param string $xAccountId + * @param string $id + * @param string $subResourceId + * @return Operations\AtsUpdateApplicationNoteResponse + * @throws \StackOne\client\Models\Errors\SDKException + */ + public function updateApplicationNote(Components\AtsUpdateNotesRequestDto $atsUpdateNotesRequestDto, string $xAccountId, string $id, string $subResourceId, ?Options $options = null): Operations\AtsUpdateApplicationNoteResponse + { + $request = new Operations\AtsUpdateApplicationNoteRequest( + xAccountId: $xAccountId, + id: $id, + subResourceId: $subResourceId, + atsUpdateNotesRequestDto: $atsUpdateNotesRequestDto, + ); + $baseUrl = $this->sdkConfiguration->getServerUrl(); + $url = Utils\Utils::generateUrl($baseUrl, '/unified/ats/applications/{id}/notes/{subResourceId}', Operations\AtsUpdateApplicationNoteRequest::class, $request); + $urlOverride = null; + $httpOptions = ['http_errors' => false]; + $body = Utils\Utils::serializeRequestBody($request, 'atsUpdateNotesRequestDto', 'json'); + if ($body === null) { + throw new \Exception('Request body is required'); + } + $httpOptions = array_merge_recursive($httpOptions, $body); + $httpOptions = array_merge_recursive($httpOptions, Utils\Utils::getHeaders($request)); + if (! array_key_exists('headers', $httpOptions)) { + $httpOptions['headers'] = []; + } + $httpOptions['headers']['Accept'] = 'application/json'; + $httpOptions['headers']['user-agent'] = $this->sdkConfiguration->userAgent; + $httpRequest = new \GuzzleHttp\Psr7\Request('PATCH', $url); + $hookContext = new HookContext('ats_update_application_note', null, $this->sdkConfiguration->securitySource); + $httpRequest = $this->sdkConfiguration->hooks->beforeRequest(new Hooks\BeforeRequestContext($hookContext), $httpRequest); + $httpOptions = Utils\Utils::convertHeadersToOptions($httpRequest, $httpOptions); + $httpRequest = Utils\Utils::removeHeaders($httpRequest); + try { + $httpResponse = $this->sdkConfiguration->client->send($httpRequest, $httpOptions); + } catch (\GuzzleHttp\Exception\GuzzleException $error) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), null, $error); + if ($res !== null) { + $httpResponse = $res; + } + } + $contentType = $httpResponse->getHeader('Content-Type')[0] ?? ''; + + $statusCode = $httpResponse->getStatusCode(); + if ($statusCode == 400 || $statusCode == 403 || $statusCode == 408 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + $res = $this->sdkConfiguration->hooks->afterError(new Hooks\AfterErrorContext($hookContext), $httpResponse, null); + if ($res !== null) { + $httpResponse = $res; + } + } + if ($statusCode == 200) { + if (Utils\Utils::matchContentType($contentType, 'application/json')) { + $httpResponse = $this->sdkConfiguration->hooks->afterSuccess(new Hooks\AfterSuccessContext($hookContext), $httpResponse); + + $serializer = Utils\JSON::createSerializer(); + $responseData = (string) $httpResponse->getBody(); + $obj = $serializer->deserialize($responseData, '\StackOne\client\Models\Components\UpdateResult', 'json', DeserializationContext::create()->setRequireAllRequiredProperties(true)); + $response = new Operations\AtsUpdateApplicationNoteResponse( + statusCode: $statusCode, + contentType: $contentType, + rawResponse: $httpResponse, + updateResult: $obj); + + return $response; + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown content type received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } elseif ($statusCode == 400 || $statusCode == 403 || $statusCode == 412 || $statusCode == 429 || $statusCode >= 400 && $statusCode < 500 || $statusCode == 500 || $statusCode == 501 || $statusCode >= 500 && $statusCode < 600) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } elseif ($statusCode == 408) { + throw new \StackOne\client\Models\Errors\SDKException('API error occurred', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } else { + throw new \StackOne\client\Models\Errors\SDKException('Unknown status code received', $statusCode, $httpResponse->getBody()->getContents(), $httpResponse); + } + } + /** * Update Candidate * diff --git a/src/Models/Components/AtsUpdateNotesRequestDto.php b/src/Models/Components/AtsUpdateNotesRequestDto.php new file mode 100644 index 00000000..abdaa9e9 --- /dev/null +++ b/src/Models/Components/AtsUpdateNotesRequestDto.php @@ -0,0 +1,66 @@ + $content + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('content')] + #[\Speakeasy\Serializer\Annotation\Type('array<\StackOne\client\Models\Components\NoteContentApiModel>|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?array $content = null; + + /** + * Unique identifier of the author + * + * @var ?string $authorId + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('author_id')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?string $authorId = null; + + /** + * Visibility of the note + * + * @var ?AtsUpdateNotesRequestDtoVisibility $visibility + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('visibility')] + #[\Speakeasy\Serializer\Annotation\Type('\StackOne\client\Models\Components\AtsUpdateNotesRequestDtoVisibility|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?AtsUpdateNotesRequestDtoVisibility $visibility = null; + + /** + * Value to pass through to the provider + * + * @var ?array $passthrough + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('passthrough')] + #[\Speakeasy\Serializer\Annotation\Type('array|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?array $passthrough = null; + + /** + * @param ?array $content + * @param ?string $authorId + * @param ?AtsUpdateNotesRequestDtoVisibility $visibility + * @param ?array $passthrough + */ + public function __construct(?array $content = null, ?string $authorId = null, ?AtsUpdateNotesRequestDtoVisibility $visibility = null, ?array $passthrough = null) + { + $this->content = $content; + $this->authorId = $authorId; + $this->visibility = $visibility; + $this->passthrough = $passthrough; + } +} \ No newline at end of file diff --git a/src/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.php b/src/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.php new file mode 100644 index 00000000..16832807 --- /dev/null +++ b/src/Models/Components/AtsUpdateNotesRequestDtoSourceValue4.php @@ -0,0 +1,18 @@ +|null $sourceValue + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('source_value')] + #[\Speakeasy\Serializer\Annotation\Type('string|float|bool|\StackOne\client\Models\Components\AtsUpdateNotesRequestDtoSourceValue4|array')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public string|float|bool|AtsUpdateNotesRequestDtoSourceValue4|array|null $sourceValue = null; + + /** + * @param ?AtsUpdateNotesRequestDtoValue $value + * @param string|float|bool|AtsUpdateNotesRequestDtoSourceValue4|array|null $sourceValue + */ + public function __construct(?AtsUpdateNotesRequestDtoValue $value = null, string|float|bool|AtsUpdateNotesRequestDtoSourceValue4|array|null $sourceValue = null) + { + $this->value = $value; + $this->sourceValue = $sourceValue; + } +} \ No newline at end of file diff --git a/src/Models/Components/Category.php b/src/Models/Components/Category.php index a305ecda..92998276 100644 --- a/src/Models/Components/Category.php +++ b/src/Models/Components/Category.php @@ -67,6 +67,16 @@ class Category #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?CategoryLevel $level = null; + /** + * The language associated with this category + * + * @var ?CategoryLanguage $language + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('language')] + #[\Speakeasy\Serializer\Annotation\Type('\StackOne\client\Models\Components\CategoryLanguage|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?CategoryLanguage $language = null; + /** * @param ?string $id * @param ?string $remoteId @@ -74,8 +84,9 @@ class Category * @param ?string $name * @param ?bool $active * @param ?CategoryLevel $level + * @param ?CategoryLanguage $language */ - public function __construct(?string $id = null, ?string $remoteId = null, ?array $unifiedCustomFields = null, ?string $name = null, ?bool $active = null, ?CategoryLevel $level = null) + public function __construct(?string $id = null, ?string $remoteId = null, ?array $unifiedCustomFields = null, ?string $name = null, ?bool $active = null, ?CategoryLevel $level = null, ?CategoryLanguage $language = null) { $this->id = $id; $this->remoteId = $remoteId; @@ -83,5 +94,6 @@ public function __construct(?string $id = null, ?string $remoteId = null, ?array $this->name = $name; $this->active = $active; $this->level = $level; + $this->language = $language; } } \ No newline at end of file diff --git a/src/Models/Components/CategoryLanguage.php b/src/Models/Components/CategoryLanguage.php new file mode 100644 index 00000000..98284a46 --- /dev/null +++ b/src/Models/Components/CategoryLanguage.php @@ -0,0 +1,43 @@ +|null $sourceValue + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('source_value')] + #[\Speakeasy\Serializer\Annotation\Type('string|float|bool|\StackOne\client\Models\Components\CategorySourceValueLanguage4|array')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public string|float|bool|CategorySourceValueLanguage4|array|null $sourceValue = null; + + /** + * @param ?CategoryLanguageValue $value + * @param string|float|bool|CategorySourceValueLanguage4|array|null $sourceValue + */ + public function __construct(?CategoryLanguageValue $value = null, string|float|bool|CategorySourceValueLanguage4|array|null $sourceValue = null) + { + $this->value = $value; + $this->sourceValue = $sourceValue; + } +} \ No newline at end of file diff --git a/src/Models/Components/CategoryLanguageValue.php b/src/Models/Components/CategoryLanguageValue.php new file mode 100644 index 00000000..ce0da30c --- /dev/null +++ b/src/Models/Components/CategoryLanguageValue.php @@ -0,0 +1,425 @@ + $categories * @param ?array $skills + * @param ?string $provider * @param ?string $updatedAt * @param ?string $createdAt */ - public function __construct(?string $id = null, ?string $remoteId = null, ?array $unifiedCustomFields = null, ?string $externalReference = null, ?array $contentIds = null, ?array $remoteContentIds = null, ?string $title = null, ?string $description = null, ?array $languages = null, ?string $coverUrl = null, ?string $url = null, ?bool $active = null, ?string $duration = null, ?array $categories = null, ?array $skills = null, ?string $updatedAt = null, ?string $createdAt = null) + public function __construct(?string $id = null, ?string $remoteId = null, ?array $unifiedCustomFields = null, ?string $externalReference = null, ?array $contentIds = null, ?array $remoteContentIds = null, ?string $title = null, ?string $description = null, ?array $languages = null, ?string $coverUrl = null, ?string $url = null, ?bool $active = null, ?string $duration = null, ?array $categories = null, ?array $skills = null, ?string $provider = null, ?string $updatedAt = null, ?string $createdAt = null) { $this->id = $id; $this->remoteId = $remoteId; @@ -206,6 +216,7 @@ public function __construct(?string $id = null, ?string $remoteId = null, ?array $this->duration = $duration; $this->categories = $categories; $this->skills = $skills; + $this->provider = $provider; $this->updatedAt = $updatedAt; $this->createdAt = $createdAt; } diff --git a/src/Models/Components/CreateCategoriesApiModel.php b/src/Models/Components/CreateCategoriesApiModel.php index cfdade34..b16c57ab 100644 --- a/src/Models/Components/CreateCategoriesApiModel.php +++ b/src/Models/Components/CreateCategoriesApiModel.php @@ -49,17 +49,29 @@ class CreateCategoriesApiModel #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?Level $level = null; + /** + * The language associated with this category + * + * @var ?Language $language + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('language')] + #[\Speakeasy\Serializer\Annotation\Type('\StackOne\client\Models\Components\Language|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?Language $language = null; + /** * @param ?string $id * @param ?array $unifiedCustomFields * @param ?string $name * @param ?Level $level + * @param ?Language $language */ - public function __construct(?string $id = null, ?array $unifiedCustomFields = null, ?string $name = null, ?Level $level = null) + public function __construct(?string $id = null, ?array $unifiedCustomFields = null, ?string $name = null, ?Level $level = null, ?Language $language = null) { $this->id = $id; $this->unifiedCustomFields = $unifiedCustomFields; $this->name = $name; $this->level = $level; + $this->language = $language; } } \ No newline at end of file diff --git a/src/Models/Components/CreateCategoriesApiModelLanguageValue.php b/src/Models/Components/CreateCategoriesApiModelLanguageValue.php new file mode 100644 index 00000000..716508b5 --- /dev/null +++ b/src/Models/Components/CreateCategoriesApiModelLanguageValue.php @@ -0,0 +1,425 @@ +|null $sourceValue + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('source_value')] + #[\Speakeasy\Serializer\Annotation\Type('string|float|bool|\StackOne\client\Models\Components\CreateCategoriesApiModelSourceValueLanguage4|array')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public string|float|bool|CreateCategoriesApiModelSourceValueLanguage4|array|null $sourceValue = null; + + /** + * @param ?CreateCategoriesApiModelLanguageValue $value + * @param string|float|bool|CreateCategoriesApiModelSourceValueLanguage4|array|null $sourceValue + */ + public function __construct(?CreateCategoriesApiModelLanguageValue $value = null, string|float|bool|CreateCategoriesApiModelSourceValueLanguage4|array|null $sourceValue = null) + { + $this->value = $value; + $this->sourceValue = $sourceValue; + } +} \ No newline at end of file diff --git a/src/Models/Components/LmsUpsertContentRequestDto.php b/src/Models/Components/LmsUpsertContentRequestDto.php index 636ef4d1..3508b2f2 100644 --- a/src/Models/Components/LmsUpsertContentRequestDto.php +++ b/src/Models/Components/LmsUpsertContentRequestDto.php @@ -142,6 +142,15 @@ class LmsUpsertContentRequestDto #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?float $order = null; + /** + * The name of the content provider + * + * @var ?string $provider + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('provider')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?string $provider = null; + /** * The categories associated with this content * @@ -167,9 +176,10 @@ class LmsUpsertContentRequestDto * @param ?string $duration * @param ?array $skills * @param ?float $order + * @param ?string $provider * @param ?array $categories */ - public function __construct(?array $unifiedCustomFields = null, ?string $externalReference = null, ?array $courseIds = null, ?string $title = null, ?string $description = null, ?string $shortDescription = null, ?array $languages = null, ?string $contentUrl = null, ?LmsUpsertContentRequestDtoContentType $contentType = null, ?string $coverUrl = null, ?bool $active = null, ?string $duration = null, ?array $skills = null, ?float $order = null, ?array $categories = null) + public function __construct(?array $unifiedCustomFields = null, ?string $externalReference = null, ?array $courseIds = null, ?string $title = null, ?string $description = null, ?string $shortDescription = null, ?array $languages = null, ?string $contentUrl = null, ?LmsUpsertContentRequestDtoContentType $contentType = null, ?string $coverUrl = null, ?bool $active = null, ?string $duration = null, ?array $skills = null, ?float $order = null, ?string $provider = null, ?array $categories = null) { $this->unifiedCustomFields = $unifiedCustomFields; $this->externalReference = $externalReference; @@ -185,6 +195,7 @@ public function __construct(?array $unifiedCustomFields = null, ?string $externa $this->duration = $duration; $this->skills = $skills; $this->order = $order; + $this->provider = $provider; $this->categories = $categories; } } \ No newline at end of file diff --git a/src/Models/Components/LmsUpsertCourseRequestDto.php b/src/Models/Components/LmsUpsertCourseRequestDto.php index 2c1d6fe4..4a785377 100644 --- a/src/Models/Components/LmsUpsertCourseRequestDto.php +++ b/src/Models/Components/LmsUpsertCourseRequestDto.php @@ -104,6 +104,15 @@ class LmsUpsertCourseRequestDto #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?string $duration = null; + /** + * The name of the course provider + * + * @var ?string $provider + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('provider')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?string $provider = null; + /** * The categories associated with this content * @@ -145,11 +154,12 @@ class LmsUpsertCourseRequestDto * @param ?string $url * @param ?bool $active * @param ?string $duration + * @param ?string $provider * @param ?array $categories * @param ?array $skills * @param ?array $content */ - public function __construct(?array $unifiedCustomFields = null, ?string $externalReference = null, ?array $contentIds = null, ?string $title = null, ?string $description = null, ?array $languages = null, ?string $coverUrl = null, ?string $url = null, ?bool $active = null, ?string $duration = null, ?array $categories = null, ?array $skills = null, ?array $content = null) + public function __construct(?array $unifiedCustomFields = null, ?string $externalReference = null, ?array $contentIds = null, ?string $title = null, ?string $description = null, ?array $languages = null, ?string $coverUrl = null, ?string $url = null, ?bool $active = null, ?string $duration = null, ?string $provider = null, ?array $categories = null, ?array $skills = null, ?array $content = null) { $this->unifiedCustomFields = $unifiedCustomFields; $this->externalReference = $externalReference; @@ -161,6 +171,7 @@ public function __construct(?array $unifiedCustomFields = null, ?string $externa $this->url = $url; $this->active = $active; $this->duration = $duration; + $this->provider = $provider; $this->categories = $categories; $this->skills = $skills; $this->content = $content; diff --git a/src/Models/Components/UnifiedWarningApiModel.php b/src/Models/Components/UnifiedWarningApiModel.php new file mode 100644 index 00000000..6d89c44d --- /dev/null +++ b/src/Models/Components/UnifiedWarningApiModel.php @@ -0,0 +1,29 @@ +message = $message; + } +} \ No newline at end of file diff --git a/src/Models/Components/WriteResultApiModel.php b/src/Models/Components/WriteResultApiModel.php index 64ae9b8d..8b9be4b1 100644 --- a/src/Models/Components/WriteResultApiModel.php +++ b/src/Models/Components/WriteResultApiModel.php @@ -45,17 +45,29 @@ class WriteResultApiModel #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $providerErrors = null; + /** + * $unifiedWarnings + * + * @var ?array $unifiedWarnings + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('unified_warnings')] + #[\Speakeasy\Serializer\Annotation\Type('array<\StackOne\client\Models\Components\UnifiedWarningApiModel>|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?array $unifiedWarnings = null; + /** * @param ?float $statusCode * @param ?string $message * @param ?\DateTime $timestamp * @param ?array $providerErrors + * @param ?array $unifiedWarnings */ - public function __construct(?float $statusCode = null, ?string $message = null, ?\DateTime $timestamp = null, ?array $providerErrors = null) + public function __construct(?float $statusCode = null, ?string $message = null, ?\DateTime $timestamp = null, ?array $providerErrors = null, ?array $unifiedWarnings = null) { $this->statusCode = $statusCode; $this->message = $message; $this->timestamp = $timestamp; $this->providerErrors = $providerErrors; + $this->unifiedWarnings = $unifiedWarnings; } } \ No newline at end of file diff --git a/src/Models/Operations/AtsCreateApplicationNoteRequest.php b/src/Models/Operations/AtsCreateApplicationNoteRequest.php new file mode 100644 index 00000000..1e803570 --- /dev/null +++ b/src/Models/Operations/AtsCreateApplicationNoteRequest.php @@ -0,0 +1,48 @@ +xAccountId = $xAccountId; + $this->id = $id; + $this->atsCreateNotesRequestDto = $atsCreateNotesRequestDto; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsCreateApplicationNoteResponse.php b/src/Models/Operations/AtsCreateApplicationNoteResponse.php new file mode 100644 index 00000000..209b69fe --- /dev/null +++ b/src/Models/Operations/AtsCreateApplicationNoteResponse.php @@ -0,0 +1,64 @@ +> $headers + */ + public array $headers; + + /** + * Record created successfully. + * + * @var ?Components\CreateResult $createResult + */ + public ?Components\CreateResult $createResult = null; + + /** + * @param string $contentType + * @param int $statusCode + * @param \Psr\Http\Message\ResponseInterface $rawResponse + * @param array> $headers + * @param ?Components\CreateResult $createResult + */ + public function __construct(string $contentType, int $statusCode, \Psr\Http\Message\ResponseInterface $rawResponse, ?Components\CreateResult $createResult = null, ?array $headers = []) + { + $this->contentType = $contentType; + $this->statusCode = $statusCode; + $this->rawResponse = $rawResponse; + $this->headers = $headers; + $this->createResult = $createResult; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsGetApplicationNoteRequest.php b/src/Models/Operations/AtsGetApplicationNoteRequest.php new file mode 100644 index 00000000..5b76371d --- /dev/null +++ b/src/Models/Operations/AtsGetApplicationNoteRequest.php @@ -0,0 +1,77 @@ + $proxy + */ + #[SpeakeasyMetadata('queryParam:style=deepObject,explode=true,name=proxy')] + public ?array $proxy = null; + + /** + * The comma separated list of fields that will be returned in the response (if empty, all fields are returned) + * + * @var ?string $fields + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=fields')] + public ?string $fields = null; + + /** + * Indicates that the raw request result is returned + * + * @var ?bool $raw + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=raw')] + public ?bool $raw = null; + + /** + * @param string $xAccountId + * @param string $id + * @param string $subResourceId + * @param ?bool $raw + * @param ?array $proxy + * @param ?string $fields + */ + public function __construct(string $xAccountId, string $id, string $subResourceId, ?array $proxy = null, ?string $fields = null, ?bool $raw = false) + { + $this->xAccountId = $xAccountId; + $this->id = $id; + $this->subResourceId = $subResourceId; + $this->proxy = $proxy; + $this->fields = $fields; + $this->raw = $raw; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsGetApplicationNoteResponse.php b/src/Models/Operations/AtsGetApplicationNoteResponse.php new file mode 100644 index 00000000..eb3118e2 --- /dev/null +++ b/src/Models/Operations/AtsGetApplicationNoteResponse.php @@ -0,0 +1,64 @@ +> $headers + */ + public array $headers; + + /** + * The note with the given identifier related to the application with the given identifier was retrieved. + * + * @var ?Components\NoteResult $noteResult + */ + public ?Components\NoteResult $noteResult = null; + + /** + * @param string $contentType + * @param int $statusCode + * @param \Psr\Http\Message\ResponseInterface $rawResponse + * @param array> $headers + * @param ?Components\NoteResult $noteResult + */ + public function __construct(string $contentType, int $statusCode, \Psr\Http\Message\ResponseInterface $rawResponse, ?Components\NoteResult $noteResult = null, ?array $headers = []) + { + $this->contentType = $contentType; + $this->statusCode = $statusCode; + $this->rawResponse = $rawResponse; + $this->headers = $headers; + $this->noteResult = $noteResult; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsListApplicationNotesQueryParamFilter.php b/src/Models/Operations/AtsListApplicationNotesQueryParamFilter.php new file mode 100644 index 00000000..f3d9d22d --- /dev/null +++ b/src/Models/Operations/AtsListApplicationNotesQueryParamFilter.php @@ -0,0 +1,30 @@ +updatedAfter = $updatedAfter; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsListApplicationNotesRequest.php b/src/Models/Operations/AtsListApplicationNotesRequest.php new file mode 100644 index 00000000..73257394 --- /dev/null +++ b/src/Models/Operations/AtsListApplicationNotesRequest.php @@ -0,0 +1,131 @@ + $proxy + */ + #[SpeakeasyMetadata('queryParam:style=deepObject,explode=true,name=proxy')] + public ?array $proxy = null; + + /** + * The comma separated list of fields that will be returned in the response (if empty, all fields are returned) + * + * @var ?string $fields + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=fields')] + public ?string $fields = null; + + /** + * Filter parameters that allow greater customisation of the list response + * + * @var ?AtsListApplicationNotesQueryParamFilter $filter + */ + #[SpeakeasyMetadata('queryParam:style=deepObject,explode=true,name=filter')] + public ?AtsListApplicationNotesQueryParamFilter $filter = null; + + /** + * The page number of the results to fetch + * + * @var ?string $page + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=page')] + public ?string $page = null; + + /** + * The unified cursor + * + * @var ?string $next + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=next')] + public ?string $next = null; + + /** + * Use a string with a date to only select results updated after that given date + * + * @var ?string $updatedAfter + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=updated_after')] + public ?string $updatedAfter = null; + + /** + * The sync token to select the only updated results + * + * @var ?string $syncToken + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=sync_token')] + public ?string $syncToken = null; + + /** + * Indicates that the raw request result is returned + * + * @var ?bool $raw + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=raw')] + public ?bool $raw = null; + + /** + * The number of results per page + * + * @var ?string $pageSize + */ + #[SpeakeasyMetadata('queryParam:style=form,explode=true,name=page_size')] + public ?string $pageSize = null; + + /** + * @param string $xAccountId + * @param string $id + * @param ?bool $raw + * @param ?array $proxy + * @param ?string $fields + * @param ?AtsListApplicationNotesQueryParamFilter $filter + * @param ?string $page + * @param ?string $pageSize + * @param ?string $next + * @param ?string $updatedAfter + * @param ?string $syncToken + */ + public function __construct(string $xAccountId, string $id, ?array $proxy = null, ?string $fields = null, ?AtsListApplicationNotesQueryParamFilter $filter = null, ?string $page = null, ?string $next = null, ?string $updatedAfter = null, ?string $syncToken = null, ?bool $raw = false, ?string $pageSize = '25') + { + $this->xAccountId = $xAccountId; + $this->id = $id; + $this->proxy = $proxy; + $this->fields = $fields; + $this->filter = $filter; + $this->page = $page; + $this->next = $next; + $this->updatedAfter = $updatedAfter; + $this->syncToken = $syncToken; + $this->raw = $raw; + $this->pageSize = $pageSize; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsListApplicationNotesResponse.php b/src/Models/Operations/AtsListApplicationNotesResponse.php new file mode 100644 index 00000000..a96ce5e4 --- /dev/null +++ b/src/Models/Operations/AtsListApplicationNotesResponse.php @@ -0,0 +1,64 @@ +> $headers + */ + public array $headers; + + /** + * The notes related to the application with the given identifier was retrieved. + * + * @var ?Components\NotesPaginated $notesPaginated + */ + public ?Components\NotesPaginated $notesPaginated = null; + + /** + * @param string $contentType + * @param int $statusCode + * @param \Psr\Http\Message\ResponseInterface $rawResponse + * @param array> $headers + * @param ?Components\NotesPaginated $notesPaginated + */ + public function __construct(string $contentType, int $statusCode, \Psr\Http\Message\ResponseInterface $rawResponse, ?Components\NotesPaginated $notesPaginated = null, ?array $headers = []) + { + $this->contentType = $contentType; + $this->statusCode = $statusCode; + $this->rawResponse = $rawResponse; + $this->headers = $headers; + $this->notesPaginated = $notesPaginated; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsListApplicationsQueryParamFilter.php b/src/Models/Operations/AtsListApplicationsQueryParamFilter.php index 39768865..c59f6e8e 100644 --- a/src/Models/Operations/AtsListApplicationsQueryParamFilter.php +++ b/src/Models/Operations/AtsListApplicationsQueryParamFilter.php @@ -20,6 +20,14 @@ class AtsListApplicationsQueryParamFilter #[SpeakeasyMetadata('queryParam:name=updated_after')] public ?string $updatedAfter = null; + /** + * Use a string with a date to only select results created after that given date + * + * @var ?string $createdAfter + */ + #[SpeakeasyMetadata('queryParam:name=created_after')] + public ?string $createdAfter = null; + /** * Filter to select applications by job_id * @@ -38,12 +46,14 @@ class AtsListApplicationsQueryParamFilter /** * @param ?string $updatedAfter + * @param ?string $createdAfter * @param ?string $jobId * @param ?string $stage */ - public function __construct(?string $updatedAfter = null, ?string $jobId = null, ?string $stage = null) + public function __construct(?string $updatedAfter = null, ?string $createdAfter = null, ?string $jobId = null, ?string $stage = null) { $this->updatedAfter = $updatedAfter; + $this->createdAfter = $createdAfter; $this->jobId = $jobId; $this->stage = $stage; } diff --git a/src/Models/Operations/AtsListCandidatesQueryParamFilter.php b/src/Models/Operations/AtsListCandidatesQueryParamFilter.php index 326dcd4e..518db911 100644 --- a/src/Models/Operations/AtsListCandidatesQueryParamFilter.php +++ b/src/Models/Operations/AtsListCandidatesQueryParamFilter.php @@ -20,6 +20,14 @@ class AtsListCandidatesQueryParamFilter #[SpeakeasyMetadata('queryParam:name=updated_after')] public ?string $updatedAfter = null; + /** + * Use a string with a date to only select results created after that given date + * + * @var ?string $createdAfter + */ + #[SpeakeasyMetadata('queryParam:name=created_after')] + public ?string $createdAfter = null; + /** * Filter to select candidates by email * @@ -30,11 +38,13 @@ class AtsListCandidatesQueryParamFilter /** * @param ?string $updatedAfter + * @param ?string $createdAfter * @param ?string $email */ - public function __construct(?string $updatedAfter = null, ?string $email = null) + public function __construct(?string $updatedAfter = null, ?string $createdAfter = null, ?string $email = null) { $this->updatedAfter = $updatedAfter; + $this->createdAfter = $createdAfter; $this->email = $email; } } \ No newline at end of file diff --git a/src/Models/Operations/AtsListInterviewsQueryParamFilter.php b/src/Models/Operations/AtsListInterviewsQueryParamFilter.php index 0396452f..b884ce43 100644 --- a/src/Models/Operations/AtsListInterviewsQueryParamFilter.php +++ b/src/Models/Operations/AtsListInterviewsQueryParamFilter.php @@ -9,7 +9,7 @@ namespace StackOne\client\Models\Operations; use StackOne\client\Utils\SpeakeasyMetadata; -/** AtsListInterviewsQueryParamFilter - Filter parameters that allow greater customisation of the list response */ +/** AtsListInterviewsQueryParamFilter - ATS Interviews Filter */ class AtsListInterviewsQueryParamFilter { /** @@ -20,11 +20,21 @@ class AtsListInterviewsQueryParamFilter #[SpeakeasyMetadata('queryParam:name=updated_after')] public ?string $updatedAfter = null; + /** + * Use a string with a date to only select results created after that given date + * + * @var ?string $createdAfter + */ + #[SpeakeasyMetadata('queryParam:name=created_after')] + public ?string $createdAfter = null; + /** * @param ?string $updatedAfter + * @param ?string $createdAfter */ - public function __construct(?string $updatedAfter = null) + public function __construct(?string $updatedAfter = null, ?string $createdAfter = null) { $this->updatedAfter = $updatedAfter; + $this->createdAfter = $createdAfter; } } \ No newline at end of file diff --git a/src/Models/Operations/AtsListInterviewsRequest.php b/src/Models/Operations/AtsListInterviewsRequest.php index b5c06cdc..56841605 100644 --- a/src/Models/Operations/AtsListInterviewsRequest.php +++ b/src/Models/Operations/AtsListInterviewsRequest.php @@ -36,7 +36,7 @@ class AtsListInterviewsRequest public ?string $fields = null; /** - * Filter parameters that allow greater customisation of the list response + * ATS Interviews Filter * * @var ?AtsListInterviewsQueryParamFilter $filter */ diff --git a/src/Models/Operations/AtsListJobPostingsQueryParamFilter.php b/src/Models/Operations/AtsListJobPostingsQueryParamFilter.php index ee4f7282..779b8b6b 100644 --- a/src/Models/Operations/AtsListJobPostingsQueryParamFilter.php +++ b/src/Models/Operations/AtsListJobPostingsQueryParamFilter.php @@ -9,7 +9,7 @@ namespace StackOne\client\Models\Operations; use StackOne\client\Utils\SpeakeasyMetadata; -/** AtsListJobPostingsQueryParamFilter - Filter parameters that allow greater customisation of the list response */ +/** AtsListJobPostingsQueryParamFilter - ATS Job Postings Filter */ class AtsListJobPostingsQueryParamFilter { /** @@ -20,11 +20,21 @@ class AtsListJobPostingsQueryParamFilter #[SpeakeasyMetadata('queryParam:name=updated_after')] public ?string $updatedAfter = null; + /** + * Use a string with a date to only select results created after that given date + * + * @var ?string $createdAfter + */ + #[SpeakeasyMetadata('queryParam:name=created_after')] + public ?string $createdAfter = null; + /** * @param ?string $updatedAfter + * @param ?string $createdAfter */ - public function __construct(?string $updatedAfter = null) + public function __construct(?string $updatedAfter = null, ?string $createdAfter = null) { $this->updatedAfter = $updatedAfter; + $this->createdAfter = $createdAfter; } } \ No newline at end of file diff --git a/src/Models/Operations/AtsListJobPostingsRequest.php b/src/Models/Operations/AtsListJobPostingsRequest.php index d11dadd6..10e8bfc6 100644 --- a/src/Models/Operations/AtsListJobPostingsRequest.php +++ b/src/Models/Operations/AtsListJobPostingsRequest.php @@ -36,7 +36,7 @@ class AtsListJobPostingsRequest public ?string $fields = null; /** - * Filter parameters that allow greater customisation of the list response + * ATS Job Postings Filter * * @var ?AtsListJobPostingsQueryParamFilter $filter */ diff --git a/src/Models/Operations/AtsListJobsQueryParamFilter.php b/src/Models/Operations/AtsListJobsQueryParamFilter.php index d8814394..3b5f994f 100644 --- a/src/Models/Operations/AtsListJobsQueryParamFilter.php +++ b/src/Models/Operations/AtsListJobsQueryParamFilter.php @@ -20,21 +20,42 @@ class AtsListJobsQueryParamFilter #[SpeakeasyMetadata('queryParam:name=updated_after')] public ?string $updatedAfter = null; + /** + * Use a string with a date to only select results created after that given date + * + * @var ?string $createdAfter + */ + #[SpeakeasyMetadata('queryParam:name=created_after')] + public ?string $createdAfter = null; + /** * The status of the job * * @var ?Status $status + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ #[SpeakeasyMetadata('queryParam:name=status')] public ?Status $status = null; + /** + * The job_status of the job + * + * @var ?JobStatus $jobStatus + */ + #[SpeakeasyMetadata('queryParam:name=job_status')] + public ?JobStatus $jobStatus = null; + /** * @param ?string $updatedAfter + * @param ?string $createdAfter * @param ?Status $status + * @param ?JobStatus $jobStatus */ - public function __construct(?string $updatedAfter = null, ?Status $status = null) + public function __construct(?string $updatedAfter = null, ?string $createdAfter = null, ?Status $status = null, ?JobStatus $jobStatus = null) { $this->updatedAfter = $updatedAfter; + $this->createdAfter = $createdAfter; $this->status = $status; + $this->jobStatus = $jobStatus; } } \ No newline at end of file diff --git a/src/Models/Operations/AtsUpdateApplicationNoteRequest.php b/src/Models/Operations/AtsUpdateApplicationNoteRequest.php new file mode 100644 index 00000000..9b45dbc1 --- /dev/null +++ b/src/Models/Operations/AtsUpdateApplicationNoteRequest.php @@ -0,0 +1,57 @@ +xAccountId = $xAccountId; + $this->id = $id; + $this->subResourceId = $subResourceId; + $this->atsUpdateNotesRequestDto = $atsUpdateNotesRequestDto; + } +} \ No newline at end of file diff --git a/src/Models/Operations/AtsUpdateApplicationNoteResponse.php b/src/Models/Operations/AtsUpdateApplicationNoteResponse.php new file mode 100644 index 00000000..ba3a465c --- /dev/null +++ b/src/Models/Operations/AtsUpdateApplicationNoteResponse.php @@ -0,0 +1,64 @@ +> $headers + */ + public array $headers; + + /** + * Record updated successfully. + * + * @var ?Components\UpdateResult $updateResult + */ + public ?Components\UpdateResult $updateResult = null; + + /** + * @param string $contentType + * @param int $statusCode + * @param \Psr\Http\Message\ResponseInterface $rawResponse + * @param array> $headers + * @param ?Components\UpdateResult $updateResult + */ + public function __construct(string $contentType, int $statusCode, \Psr\Http\Message\ResponseInterface $rawResponse, ?Components\UpdateResult $updateResult = null, ?array $headers = []) + { + $this->contentType = $contentType; + $this->statusCode = $statusCode; + $this->rawResponse = $rawResponse; + $this->headers = $headers; + $this->updateResult = $updateResult; + } +} \ No newline at end of file diff --git a/src/Models/Operations/JobStatus.php b/src/Models/Operations/JobStatus.php new file mode 100644 index 00000000..21b1660f --- /dev/null +++ b/src/Models/Operations/JobStatus.php @@ -0,0 +1,17 @@ +