From 04cdce5a1654d6dca93ef3d5abef1151bea7eb84 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 5 Aug 2024 18:44:43 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.352.2 --- .speakeasy/gen.lock | 143 +- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +- README.md | 130 +- RELEASES.md | 12 +- USAGE.md | 2 +- codeSamples.yaml | 2515 ++++++++++------- docs/models/components/accessrole.md | 14 + docs/models/components/activitytype.md | 12 + docs/models/components/address.md | 2 +- docs/models/components/addresstype.md | 11 + docs/models/components/attachmenttype.md | 13 + docs/models/components/collectiontype.md | 11 + docs/models/components/comment.md | 20 +- .../components/createbatchlinkeduserdto.md | 8 +- docs/models/components/createlinkeduserdto.md | 8 +- docs/models/components/creatortype.md | 11 + .../models/components/customfieldcreatedto.md | 18 +- .../customfieldcreatedtodatatype.md | 11 + .../customfieldcreatedtoobjecttypeowner.md | 16 + docs/models/components/customfieldresponse.md | 32 +- .../components/customfieldresponsedatatype.md | 11 + docs/models/components/datatype.md | 11 + .../models/components/definetargetfielddto.md | 12 +- docs/models/components/direction.md | 11 + docs/models/components/disabilitystatus.md | 12 + docs/models/components/email.md | 10 +- docs/models/components/emailaddresstype.md | 11 + docs/models/components/gender.md | 14 + docs/models/components/industry.md | 156 + docs/models/components/linkeduserresponse.md | 12 +- .../components/mapfieldtoproviderdto.md | 12 +- docs/models/components/objecttypeowner.md | 16 + .../components/overallrecommendation.md | 14 + docs/models/components/ownertype.md | 11 + .../components/passthroughrequestdto.md | 4 +- docs/models/components/phone.md | 2 +- docs/models/components/phonetype.md | 11 + docs/models/components/priority.md | 12 + docs/models/components/race.md | 17 + docs/models/components/status.md | 11 + docs/models/components/type.md | 13 + .../components/unifiedatsactivityinput.md | 18 +- .../unifiedatsactivityinputactivitytype.md | 12 + .../unifiedatsactivityinputvisibility.md | 12 + .../components/unifiedatsactivityoutput.md | 28 +- .../components/unifiedatsapplicationinput.md | 24 +- .../components/unifiedatsapplicationoutput.md | 38 +- .../components/unifiedatsattachmentinput.md | 18 +- ...unifiedatsattachmentinputattachmenttype.md | 13 + .../components/unifiedatsattachmentoutput.md | 28 +- .../components/unifiedatscandidateinput.md | 38 +- .../components/unifiedatscandidateoutput.md | 48 +- .../components/unifiedatsdepartmentoutput.md | 18 +- .../components/unifiedatseeocsoutput.md | 28 +- .../components/unifiedatsinterviewinput.md | 26 +- .../unifiedatsinterviewinputstatus.md | 12 + .../components/unifiedatsinterviewoutput.md | 36 +- .../unifiedatsinterviewoutputstatus.md | 12 + .../unifiedatsjobinterviewstageoutput.md | 22 +- docs/models/components/unifiedatsjoboutput.md | 40 +- .../components/unifiedatsjoboutputstatus.md | 14 + .../components/unifiedatsjoboutputtype.md | 12 + .../components/unifiedatsofferoutput.md | 30 +- .../components/unifiedatsofferoutputstatus.md | 18 + .../components/unifiedatsofficeoutput.md | 20 +- .../unifiedatsrejectreasonoutput.md | 18 +- .../components/unifiedatsscorecardoutput.md | 26 +- docs/models/components/unifiedatstagoutput.md | 20 +- .../models/components/unifiedatsuseroutput.md | 30 +- .../components/unifiedcrmcompanyinput.md | 20 +- .../unifiedcrmcompanyinputindustry.md | 156 + .../components/unifiedcrmcompanyoutput.md | 30 +- .../components/unifiedcrmcontactinput.md | 18 +- .../components/unifiedcrmcontactoutput.md | 28 +- docs/models/components/unifiedcrmdealinput.md | 18 +- .../models/components/unifiedcrmdealoutput.md | 28 +- .../components/unifiedcrmengagementinput.md | 24 +- .../unifiedcrmengagementinputdirection.md | 11 + .../unifiedcrmengagementinputtype.md | 12 + .../components/unifiedcrmengagementoutput.md | 34 +- .../unifiedcrmengagementoutputtype.md | 12 + docs/models/components/unifiedcrmnoteinput.md | 16 +- .../models/components/unifiedcrmnoteoutput.md | 26 +- .../components/unifiedcrmstageoutput.md | 18 +- docs/models/components/unifiedcrmtaskinput.md | 22 +- .../components/unifiedcrmtaskinputstatus.md | 11 + .../models/components/unifiedcrmtaskoutput.md | 32 +- .../unifiedcrmtaskoutputcreatedat.md | 9 - .../unifiedcrmtaskoutputmodifiedat.md | 9 - .../components/unifiedcrmtaskoutputstatus.md | 11 + .../models/components/unifiedcrmuseroutput.md | 20 +- .../unifiedfilestoragedriveoutput.md | 22 +- .../components/unifiedfilestoragefileinput.md | 20 +- .../unifiedfilestoragefileoutput.md | 30 +- .../unifiedfilestoragefolderinput.md | 22 +- .../unifiedfilestoragefolderoutput.md | 32 +- .../unifiedfilestoragegroupoutput.md | 22 +- ...put.md => unifiedfilestorageuseroutput.md} | 24 +- ...ifiedmarketingautomationcampaignoutput.md} | 2 +- .../unifiedticketingaccountoutput.md | 20 +- .../unifiedticketingattachmentinput.md | 16 +- .../unifiedticketingattachmentoutput.md | 26 +- .../unifiedticketingcollectionoutput.md | 20 +- .../unifiedticketingcommentinput.md | 20 +- ...unifiedticketingcommentinputcreatortype.md | 11 + .../unifiedticketingcommentoutput.md | 30 +- .../unifiedticketingcontactoutput.md | 24 +- .../components/unifiedticketingtagoutput.md | 18 +- .../components/unifiedticketingteamoutput.md | 20 +- .../components/unifiedticketingticketinput.md | 36 +- .../unifiedticketingticketinputcomment.md | 20 +- .../unifiedticketingticketinputcreatortype.md | 11 + .../unifiedticketingticketinputpriority.md | 12 + .../unifiedticketingticketinputstatus.md | 11 + .../unifiedticketingticketinputtype.md | 13 + .../unifiedticketingticketoutput.md | 46 +- ...unifiedticketingticketoutputcreatortype.md | 11 + .../components/unifiedticketinguseroutput.md | 24 +- docs/models/components/veteranstatus.md | 12 + docs/models/components/visibility.md | 12 + docs/models/components/webhookdto.md | 10 +- docs/models/components/webhookresponse.md | 22 +- .../createaccountingaccountrequest.md | 10 +- .../createaccountingattachmentrequest.md | 10 +- .../createaccountingcontactrequest.md | 10 +- .../createaccountingexpenserequest.md | 10 +- .../createaccountinginvoicerequest.md | 10 +- .../createaccountingjournalentryrequest.md | 10 +- .../createaccountingpaymentrequest.md | 10 +- .../createaccountingpurchaseorderrequest.md | 10 +- .../operations/createatsactivityrequest.md | 10 +- .../operations/createatsapplicationrequest.md | 10 +- .../operations/createatsattachmentrequest.md | 10 +- .../operations/createatscandidaterequest.md | 10 +- .../operations/createatsinterviewrequest.md | 10 +- .../operations/createcrmcompanyrequest.md | 10 +- .../operations/createcrmcontactrequest.md | 10 +- .../operations/createcrmengagementrequest.md | 10 +- .../models/operations/createcrmnoterequest.md | 10 +- .../createmarketingautomationactionrequest.md | 10 +- ...atemarketingautomationautomationrequest.md | 10 +- ...reatemarketingautomationcampaignrequest.md | 10 +- ...createmarketingautomationcontactrequest.md | 10 +- .../createticketingticketrequest.md | 10 +- docs/models/operations/deleterequest.md | 6 +- .../listfilestorageusersresponsebody.md | 10 +- .../operations/listhrisbankinforequest.md | 2 +- .../listhrisbankinforesponsebody.md | 2 +- ...trequest.md => listhrisbenefitsrequest.md} | 2 +- ...ody.md => listhrisbenefitsresponsebody.md} | 2 +- ...request.md => listhriscompaniesrequest.md} | 2 +- ...dy.md => listhriscompaniesresponsebody.md} | 2 +- ...request.md => listhrisemployeesrequest.md} | 2 +- ...dy.md => listhrisemployeesresponsebody.md} | 2 +- .../listhrisemployerbenefitsrequest.md | 11 + ...> listhrisemployerbenefitsresponsebody.md} | 2 +- ...quest.md => listhrisemploymentsrequest.md} | 2 +- ....md => listhrisemploymentsresponsebody.md} | 2 +- ...ouprequest.md => listhrisgroupsrequest.md} | 2 +- ...ebody.md => listhrisgroupsresponsebody.md} | 2 +- .../operations/listhrislocationrequest.md | 11 - .../operations/listhrislocationsrequest.md | 11 + ...dy.md => listhrislocationsresponsebody.md} | 2 +- .../operations/listhrispaygrouprequest.md | 11 - .../operations/listhrispaygroupsrequest.md | 11 + ...dy.md => listhrispaygroupsresponsebody.md} | 2 +- .../listhristimeoffbalancerequest.md | 11 - ...t.md => listhristimeoffbalancesrequest.md} | 2 +- ...=> listhristimeoffbalancesresponsebody.md} | 2 +- ...istmarketingautomationautomationrequest.md | 11 - ...stmarketingautomationautomationsrequest.md | 11 + ...etingautomationautomationsresponsebody.md} | 2 +- .../listmarketingautomationcampaignrequest.md | 11 - ...marketingautomationcampaignresponsebody.md | 10 - ...listmarketingautomationcampaignsrequest.md | 11 + ...arketingautomationcampaignsresponsebody.md | 10 + docs/models/operations/remoteidrequest.md | 6 +- .../retrieveaccountingaccountrequest.md | 10 +- .../retrieveaccountingaddressrequest.md | 10 +- .../retrieveaccountingattachmentrequest.md | 10 +- .../retrieveaccountingbalancesheetrequest.md | 10 +- ...rieveaccountingcashflowstatementrequest.md | 10 +- .../retrieveaccountingcompanyinforequest.md | 10 +- .../retrieveaccountingcontactrequest.md | 10 +- .../retrieveaccountingcreditnoterequest.md | 10 +- .../retrieveaccountingexpenserequest.md | 10 +- ...etrieveaccountingincomestatementrequest.md | 10 +- .../retrieveaccountinginvoicerequest.md | 10 +- .../retrieveaccountingitemrequest.md | 10 +- .../retrieveaccountingjournalentryrequest.md | 10 +- .../retrieveaccountingpaymentrequest.md | 10 +- .../retrieveaccountingphonenumberrequest.md | 10 +- .../retrieveaccountingpurchaseorderrequest.md | 10 +- .../retrieveaccountingtaxraterequest.md | 10 +- ...trieveaccountingtrackingcategoryrequest.md | 10 +- .../retrieveaccountingtransactionrequest.md | 10 +- .../retrieveaccountingvendorcreditrequest.md | 10 +- .../operations/retrieveatsactivityrequest.md | 10 +- .../retrieveatsapplicationrequest.md | 10 +- .../retrieveatsattachmentrequest.md | 10 +- .../operations/retrieveatscandidaterequest.md | 10 +- .../retrieveatsdepartmentrequest.md | 10 +- .../operations/retrieveatsinterviewrequest.md | 10 +- .../retrieveatsjobinterviewstagerequest.md | 10 +- .../operations/retrieveatsjobrequest.md | 10 +- .../operations/retrieveatsofferrequest.md | 10 +- .../operations/retrieveatsofficerequest.md | 10 +- .../retrieveatsrejectreasonrequest.md | 10 +- .../operations/retrieveatsscorecardrequest.md | 10 +- .../operations/retrieveatstagrequest.md | 10 +- .../operations/retrieveatsuserrequest.md | 10 +- .../operations/retrievecollectionrequest.md | 10 +- .../operations/retrievecrmcompanyrequest.md | 10 +- .../operations/retrievecrmcontactrequest.md | 10 +- .../operations/retrievecrmdealrequest.md | 10 +- .../retrievecrmengagementrequest.md | 10 +- .../operations/retrievecrmnoterequest.md | 10 +- .../operations/retrievecrmstagerequest.md | 10 +- .../operations/retrievecrmtaskrequest.md | 10 +- .../operations/retrievecrmuserrequest.md | 10 +- .../retrievefilestoragedriverequest.md | 10 +- .../retrievefilestoragefilerequest.md | 10 +- .../retrievefilestoragefolderrequest.md | 10 +- .../retrievefilestoragegrouprequest.md | 10 +- .../retrievefilestorageuserrequest.md | 10 +- .../operations/retrievehrisbankinforequest.md | 12 +- .../operations/retrievehrisbenefitrequest.md | 10 +- .../operations/retrievehriscompanyrequest.md | 10 + .../retrievehrisdependentrequest.md | 10 +- .../retrievehrisemployeepayrollrunrequest.md | 10 +- .../operations/retrievehrisemployeerequest.md | 10 +- .../retrievehrisemployerbenefitrequest.md | 10 +- .../retrievehrisemploymentrequest.md | 10 +- .../operations/retrievehrisgrouprequest.md | 10 +- .../operations/retrievehrislocationrequest.md | 10 +- .../operations/retrievehrispaygrouprequest.md | 10 +- .../retrievehrispayrollrunrequest.md | 10 + .../retrievehristimeoffbalancerequest.md | 10 +- .../operations/retrievehristimeoffrequest.md | 10 +- .../operations/retrievelinkeduserrequest.md | 6 +- ...etrievemarketingautomationactionrequest.md | 10 +- ...evemarketingautomationautomationrequest.md | 10 +- ...rievemarketingautomationcampaignrequest.md | 10 +- ...trievemarketingautomationcontactrequest.md | 10 +- ...retrievemarketingautomationemailrequest.md | 10 +- ...retrievemarketingautomationeventrequest.md | 10 +- .../retrievemarketingautomationlistrequest.md | 10 +- ...trievemarketingautomationmessagerequest.md | 10 +- ...rievemarketingautomationtemplaterequest.md | 10 +- .../retrievemarketingautomationuserrequest.md | 10 +- .../retrieveticketingattachmentrequest.md | 10 +- .../operations/retrieveticketingtagrequest.md | 10 +- .../retrieveticketingteamrequest.md | 10 +- .../retrieveticketingticketrequest.md | 10 +- .../retrieveticketinguserrequest.md | 10 +- docs/models/operations/statusrequest.md | 6 +- docs/models/operations/updatestatusrequest.md | 6 +- docs/models/operations/vertical.md | 15 + docs/sdks/accounts/README.md | 4 +- docs/sdks/actions/README.md | 14 +- docs/sdks/activities/README.md | 24 +- docs/sdks/addresses/README.md | 7 +- docs/sdks/applications/README.md | 29 +- docs/sdks/attachments/README.md | 24 +- docs/sdks/automations/README.md | 22 +- docs/sdks/balancesheets/README.md | 7 +- docs/sdks/bankinfos/README.md | 21 +- docs/sdks/batch/README.md | 6 +- docs/sdks/benefits/README.md | 19 +- docs/sdks/campaigns/README.md | 26 +- docs/sdks/candidates/README.md | 56 +- docs/sdks/cashflowstatements/README.md | 7 +- docs/sdks/collections/README.md | 11 +- docs/sdks/comments/README.md | 26 +- docs/sdks/companies/README.md | 44 +- docs/sdks/companyinfos/README.md | 7 +- docs/sdks/contacts/README.md | 12 +- docs/sdks/creditnotes/README.md | 7 +- docs/sdks/deals/README.md | 26 +- docs/sdks/define/README.md | 11 +- docs/sdks/departments/README.md | 7 +- docs/sdks/dependents/README.md | 15 +- docs/sdks/drives/README.md | 15 +- docs/sdks/eeocs/README.md | 4 +- docs/sdks/emails/README.md | 15 +- docs/sdks/employeepayrollruns/README.md | 15 +- docs/sdks/employees/README.md | 21 +- docs/sdks/employerbenefits/README.md | 19 +- docs/sdks/employments/README.md | 19 +- docs/sdks/engagements/README.md | 31 +- docs/sdks/events/README.md | 15 +- docs/sdks/expenses/README.md | 10 +- docs/sdks/fieldmappings/README.md | 17 +- docs/sdks/files/README.md | 27 +- docs/sdks/folders/README.md | 29 +- docs/sdks/fromremoteid/README.md | 4 +- docs/sdks/groups/README.md | 19 +- docs/sdks/{single => id}/README.md | 15 +- docs/sdks/incomestatements/README.md | 7 +- docs/sdks/interviews/README.md | 30 +- docs/sdks/invoices/README.md | 10 +- docs/sdks/items/README.md | 7 +- docs/sdks/jobinterviewstages/README.md | 7 +- docs/sdks/jobs/README.md | 7 +- docs/sdks/journalentries/README.md | 10 +- docs/sdks/linkedusers/README.md | 8 +- docs/sdks/lists/README.md | 17 +- docs/sdks/locations/README.md | 19 +- docs/sdks/map/README.md | 10 +- docs/sdks/messages/README.md | 11 +- docs/sdks/notes/README.md | 24 +- docs/sdks/offers/README.md | 7 +- docs/sdks/offices/README.md | 7 +- docs/sdks/panora/README.md | 4 +- docs/sdks/panoraaccountingcontacts/README.md | 10 +- docs/sdks/panoraaccounts/README.md | 10 +- docs/sdks/panoraatsusers/README.md | 7 +- docs/sdks/panoraattachments/README.md | 10 +- docs/sdks/panoracompanies/README.md | 57 +- docs/sdks/panoracontacts/README.md | 44 +- docs/sdks/panorafilestorageusers/README.md | 13 +- docs/sdks/panoragroups/README.md | 7 +- .../README.md | 10 +- .../panoramarketingautomationusers/README.md | 7 +- docs/sdks/panoratags/README.md | 7 +- .../sdks/panoraticketingattachments/README.md | 20 +- docs/sdks/panorausers/README.md | 7 +- docs/sdks/passthrough/README.md | 8 +- docs/sdks/paygroups/README.md | 19 +- docs/sdks/payments/README.md | 10 +- docs/sdks/payrollruns/README.md | 53 +- docs/sdks/phonenumbers/README.md | 7 +- docs/sdks/purchaseorders/README.md | 10 +- docs/sdks/rejectreasons/README.md | 7 +- docs/sdks/scorecards/README.md | 7 +- docs/sdks/stages/README.md | 7 +- docs/sdks/sync/README.md | 7 +- docs/sdks/tags/README.md | 15 +- docs/sdks/tasks/README.md | 29 +- docs/sdks/taxrates/README.md | 7 +- docs/sdks/teams/README.md | 7 +- docs/sdks/templates/README.md | 17 +- docs/sdks/tickets/README.md | 55 +- docs/sdks/timeoffbalances/README.md | 11 +- docs/sdks/timeoffs/README.md | 17 +- docs/sdks/trackingcategories/README.md | 7 +- docs/sdks/transactions/README.md | 7 +- docs/sdks/users/README.md | 15 +- docs/sdks/vendorcredits/README.md | 7 +- docs/sdks/webhooks/README.md | 19 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/lib/config.ts | 6 +- src/models/components/address.ts | 33 +- .../components/createbatchlinkeduserdto.ts | 6 + src/models/components/createlinkeduserdto.ts | 14 +- src/models/components/customfieldcreatedto.ts | 92 +- src/models/components/customfieldresponse.ts | 41 +- src/models/components/definetargetfielddto.ts | 77 +- src/models/components/email.ts | 64 +- src/models/components/index.ts | 4 +- .../components/mapfieldtoproviderdto.ts | 8 +- .../components/passthroughrequestdto.ts | 16 +- src/models/components/phone.ts | 31 +- .../components/unifiedatsactivityinput.ts | 72 +- .../components/unifiedatsactivityoutput.ts | 68 +- .../components/unifiedatsattachmentinput.ts | 41 +- .../components/unifiedatsattachmentoutput.ts | 35 +- .../components/unifiedatseeocsoutput.ts | 139 +- .../components/unifiedatsinterviewinput.ts | 36 +- .../components/unifiedatsinterviewoutput.ts | 36 +- src/models/components/unifiedatsjoboutput.ts | 74 +- .../components/unifiedatsofferoutput.ts | 42 +- .../components/unifiedatsscorecardoutput.ts | 62 +- src/models/components/unifiedatsuseroutput.ts | 36 +- .../components/unifiedcampaignoutput.ts | 37 - .../components/unifiedcrmcompanyinput.ts | 180 +- .../components/unifiedcrmcompanyoutput.ts | 176 +- .../components/unifiedcrmengagementinput.ts | 71 +- .../components/unifiedcrmengagementoutput.ts | 67 +- src/models/components/unifiedcrmnoteinput.ts | 4 +- src/models/components/unifiedcrmnoteoutput.ts | 6 +- .../components/unifiedcrmstageoutput.ts | 2 +- src/models/components/unifiedcrmtaskinput.ts | 61 +- src/models/components/unifiedcrmtaskoutput.ts | 131 +- .../unifiedfilestoragefolderoutput.ts | 6 +- ...put.ts => unifiedfilestorageuseroutput.ts} | 99 +- ...nifiedmarketingautomationcampaignoutput.ts | 37 + .../unifiedticketingaccountoutput.ts | 6 +- .../unifiedticketingattachmentinput.ts | 8 +- .../unifiedticketingcollectionoutput.ts | 33 +- .../unifiedticketingcommentinput.ts | 35 +- .../unifiedticketingcommentoutput.ts | 33 +- .../unifiedticketingcontactoutput.ts | 2 +- .../components/unifiedticketingtagoutput.ts | 6 +- .../components/unifiedticketingticketinput.ts | 145 +- .../unifiedticketingticketoutput.ts | 133 +- .../components/unifiedticketinguseroutput.ts | 8 +- src/models/components/webhookdto.ts | 8 +- src/models/components/webhookresponse.ts | 10 +- src/models/operations/delete.ts | 3 + src/models/operations/index.ts | 24 +- .../operations/listaccountingaccounts.ts | 6 +- .../operations/listaccountingaddress.ts | 6 +- .../operations/listaccountingattachments.ts | 6 +- .../operations/listaccountingbalancesheets.ts | 6 +- .../listaccountingcashflowstatement.ts | 6 +- .../operations/listaccountingcompanyinfos.ts | 6 +- .../operations/listaccountingcontacts.ts | 6 +- .../operations/listaccountingcreditnote.ts | 6 +- .../operations/listaccountingexpense.ts | 6 +- .../listaccountingincomestatement.ts | 6 +- .../operations/listaccountinginvoice.ts | 6 +- src/models/operations/listaccountingitem.ts | 6 +- .../operations/listaccountingjournalentry.ts | 6 +- .../operations/listaccountingpayment.ts | 6 +- .../operations/listaccountingphonenumber.ts | 6 +- .../operations/listaccountingpurchaseorder.ts | 6 +- .../operations/listaccountingtaxrate.ts | 6 +- .../listaccountingtrackingcategorys.ts | 6 +- .../operations/listaccountingtransaction.ts | 6 +- .../operations/listaccountingvendorcredit.ts | 6 +- src/models/operations/listatsactivity.ts | 6 +- src/models/operations/listatsapplication.ts | 6 +- src/models/operations/listatsattachment.ts | 6 +- src/models/operations/listatscandidate.ts | 6 +- src/models/operations/listatsdepartments.ts | 6 +- src/models/operations/listatseeocs.ts | 6 +- src/models/operations/listatsinterview.ts | 6 +- src/models/operations/listatsjob.ts | 6 +- .../operations/listatsjobinterviewstage.ts | 6 +- src/models/operations/listatsoffer.ts | 6 +- src/models/operations/listatsoffice.ts | 6 +- src/models/operations/listatsrejectreasons.ts | 6 +- src/models/operations/listatsscorecard.ts | 6 +- src/models/operations/listatstags.ts | 6 +- src/models/operations/listatsusers.ts | 6 +- src/models/operations/listcrmcompany.ts | 6 +- src/models/operations/listcrmcontacts.ts | 6 +- src/models/operations/listcrmdeals.ts | 6 +- src/models/operations/listcrmengagements.ts | 6 +- src/models/operations/listcrmnote.ts | 6 +- src/models/operations/listcrmstages.ts | 6 +- src/models/operations/listcrmtask.ts | 6 +- src/models/operations/listcrmusers.ts | 6 +- .../operations/listfilestoragedrives.ts | 6 +- src/models/operations/listfilestoragefile.ts | 6 +- .../operations/listfilestoragefolder.ts | 6 +- src/models/operations/listfilestoragegroup.ts | 6 +- src/models/operations/listfilestorageusers.ts | 14 +- src/models/operations/listhrisbankinfo.ts | 62 +- ...listhrisbenefit.ts => listhrisbenefits.ts} | 62 +- ...sthriscompanys.ts => listhriscompanies.ts} | 62 +- src/models/operations/listhrisdependents.ts | 6 +- .../operations/listhrisemployeepayrollrun.ts | 6 +- ...sthrisemployee.ts => listhrisemployees.ts} | 62 +- ...benefit.ts => listhrisemployerbenefits.ts} | 62 +- ...isemployment.ts => listhrisemployments.ts} | 62 +- .../{listhrisgroup.ts => listhrisgroups.ts} | 62 +- ...sthrislocation.ts => listhrislocations.ts} | 62 +- ...sthrispaygroup.ts => listhrispaygroups.ts} | 62 +- src/models/operations/listhrispayrollruns.ts | 6 +- ...fbalance.ts => listhristimeoffbalances.ts} | 62 +- src/models/operations/listhristimeoffs.ts | 6 +- .../listmarketingautomationaction.ts | 6 +- ... => listmarketingautomationautomations.ts} | 62 +- ...ts => listmarketingautomationcampaigns.ts} | 70 +- .../listmarketingautomationcontacts.ts | 6 +- .../listmarketingautomationemails.ts | 6 +- .../listmarketingautomationevents.ts | 6 +- .../listmarketingautomationlists.ts | 6 +- .../listmarketingautomationmessages.ts | 6 +- .../listmarketingautomationtemplates.ts | 6 +- .../listmarketingautomationusers.ts | 6 +- src/models/operations/listticketingaccount.ts | 6 +- .../operations/listticketingattachments.ts | 6 +- .../operations/listticketingcollections.ts | 6 +- .../operations/listticketingcomments.ts | 6 +- .../operations/listticketingcontacts.ts | 6 +- src/models/operations/listticketingtags.ts | 6 +- src/models/operations/listticketingteams.ts | 6 +- src/models/operations/listticketingticket.ts | 6 +- src/models/operations/listticketingusers.ts | 6 +- .../operations/retrievefilestoragedrive.ts | 2 +- src/models/operations/retrievehrisbankinfo.ts | 30 +- src/models/operations/retrievehriscompany.ts | 77 + .../operations/retrievehrisemployerbenefit.ts | 2 +- .../operations/retrievehrispayrollrun.ts | 77 + src/models/operations/retrievehristimeoff.ts | 2 +- src/models/operations/status.ts | 34 +- src/models/operations/updatestatus.ts | 3 + src/sdk/actions.ts | 2 +- src/sdk/automations.ts | 18 +- src/sdk/bankinfos.ts | 24 +- src/sdk/benefits.ts | 18 +- src/sdk/campaigns.ts | 30 +- src/sdk/collections.ts | 2 +- src/sdk/comments.ts | 6 +- src/sdk/contacts.ts | 6 +- src/sdk/deals.ts | 2 +- src/sdk/dependents.ts | 6 +- src/sdk/drives.ts | 6 +- src/sdk/emails.ts | 6 +- src/sdk/employeepayrollruns.ts | 6 +- src/sdk/employees.ts | 18 +- src/sdk/employerbenefits.ts | 18 +- src/sdk/employments.ts | 18 +- src/sdk/engagements.ts | 2 +- src/sdk/events.ts | 6 +- src/sdk/groups.ts | 18 +- src/sdk/{single.ts => id.ts} | 26 +- src/sdk/linkedusers.ts | 8 +- src/sdk/lists.ts | 6 +- src/sdk/locations.ts | 18 +- src/sdk/messages.ts | 2 +- src/sdk/notes.ts | 2 +- src/sdk/panoracompanies.ts | 97 +- src/sdk/panorafilestorageusers.ts | 8 +- src/sdk/paygroups.ts | 18 +- src/sdk/payrollruns.ts | 85 +- src/sdk/tags.ts | 6 +- src/sdk/tasks.ts | 2 +- src/sdk/templates.ts | 6 +- src/sdk/timeoffbalances.ts | 12 +- src/sdk/timeoffs.ts | 6 +- src/sdk/users.ts | 6 +- src/sdk/webhooks.ts | 27 +- 529 files changed, 7948 insertions(+), 4263 deletions(-) create mode 100644 docs/models/components/accessrole.md create mode 100644 docs/models/components/activitytype.md create mode 100644 docs/models/components/addresstype.md create mode 100644 docs/models/components/attachmenttype.md create mode 100644 docs/models/components/collectiontype.md create mode 100644 docs/models/components/creatortype.md create mode 100644 docs/models/components/customfieldcreatedtodatatype.md create mode 100644 docs/models/components/customfieldcreatedtoobjecttypeowner.md create mode 100644 docs/models/components/customfieldresponsedatatype.md create mode 100644 docs/models/components/datatype.md create mode 100644 docs/models/components/direction.md create mode 100644 docs/models/components/disabilitystatus.md create mode 100644 docs/models/components/emailaddresstype.md create mode 100644 docs/models/components/gender.md create mode 100644 docs/models/components/industry.md create mode 100644 docs/models/components/objecttypeowner.md create mode 100644 docs/models/components/overallrecommendation.md create mode 100644 docs/models/components/ownertype.md create mode 100644 docs/models/components/phonetype.md create mode 100644 docs/models/components/priority.md create mode 100644 docs/models/components/race.md create mode 100644 docs/models/components/status.md create mode 100644 docs/models/components/type.md create mode 100644 docs/models/components/unifiedatsactivityinputactivitytype.md create mode 100644 docs/models/components/unifiedatsactivityinputvisibility.md create mode 100644 docs/models/components/unifiedatsattachmentinputattachmenttype.md create mode 100644 docs/models/components/unifiedatsinterviewinputstatus.md create mode 100644 docs/models/components/unifiedatsinterviewoutputstatus.md create mode 100644 docs/models/components/unifiedatsjoboutputstatus.md create mode 100644 docs/models/components/unifiedatsjoboutputtype.md create mode 100644 docs/models/components/unifiedatsofferoutputstatus.md create mode 100644 docs/models/components/unifiedcrmcompanyinputindustry.md create mode 100644 docs/models/components/unifiedcrmengagementinputdirection.md create mode 100644 docs/models/components/unifiedcrmengagementinputtype.md create mode 100644 docs/models/components/unifiedcrmengagementoutputtype.md create mode 100644 docs/models/components/unifiedcrmtaskinputstatus.md delete mode 100644 docs/models/components/unifiedcrmtaskoutputcreatedat.md delete mode 100644 docs/models/components/unifiedcrmtaskoutputmodifiedat.md create mode 100644 docs/models/components/unifiedcrmtaskoutputstatus.md rename docs/models/components/{unifieduseroutput.md => unifiedfilestorageuseroutput.md} (79%) rename docs/models/components/{unifiedcampaignoutput.md => unifiedmarketingautomationcampaignoutput.md} (74%) create mode 100644 docs/models/components/unifiedticketingcommentinputcreatortype.md create mode 100644 docs/models/components/unifiedticketingticketinputcreatortype.md create mode 100644 docs/models/components/unifiedticketingticketinputpriority.md create mode 100644 docs/models/components/unifiedticketingticketinputstatus.md create mode 100644 docs/models/components/unifiedticketingticketinputtype.md create mode 100644 docs/models/components/unifiedticketingticketoutputcreatortype.md create mode 100644 docs/models/components/veteranstatus.md create mode 100644 docs/models/components/visibility.md rename docs/models/operations/{listhrisbenefitrequest.md => listhrisbenefitsrequest.md} (98%) rename docs/models/operations/{listhrisbenefitresponsebody.md => listhrisbenefitsresponsebody.md} (98%) rename docs/models/operations/{listhrisemployeerequest.md => listhriscompaniesrequest.md} (98%) rename docs/models/operations/{listhriscompanysresponsebody.md => listhriscompaniesresponsebody.md} (98%) rename docs/models/operations/{listhriscompanysrequest.md => listhrisemployeesrequest.md} (98%) rename docs/models/operations/{listhrisemployeeresponsebody.md => listhrisemployeesresponsebody.md} (98%) create mode 100644 docs/models/operations/listhrisemployerbenefitsrequest.md rename docs/models/operations/{listhrisemployerbenefitresponsebody.md => listhrisemployerbenefitsresponsebody.md} (98%) rename docs/models/operations/{listhrisemploymentrequest.md => listhrisemploymentsrequest.md} (97%) rename docs/models/operations/{listhrisemploymentresponsebody.md => listhrisemploymentsresponsebody.md} (98%) rename docs/models/operations/{listhrisgrouprequest.md => listhrisgroupsrequest.md} (98%) rename docs/models/operations/{listhrisgroupresponsebody.md => listhrisgroupsresponsebody.md} (98%) delete mode 100644 docs/models/operations/listhrislocationrequest.md create mode 100644 docs/models/operations/listhrislocationsrequest.md rename docs/models/operations/{listhrislocationresponsebody.md => listhrislocationsresponsebody.md} (98%) delete mode 100644 docs/models/operations/listhrispaygrouprequest.md create mode 100644 docs/models/operations/listhrispaygroupsrequest.md rename docs/models/operations/{listhrispaygroupresponsebody.md => listhrispaygroupsresponsebody.md} (98%) delete mode 100644 docs/models/operations/listhristimeoffbalancerequest.md rename docs/models/operations/{listhrisemployerbenefitrequest.md => listhristimeoffbalancesrequest.md} (97%) rename docs/models/operations/{listhristimeoffbalanceresponsebody.md => listhristimeoffbalancesresponsebody.md} (98%) delete mode 100644 docs/models/operations/listmarketingautomationautomationrequest.md create mode 100644 docs/models/operations/listmarketingautomationautomationsrequest.md rename docs/models/operations/{listmarketingautomationautomationresponsebody.md => listmarketingautomationautomationsresponsebody.md} (98%) delete mode 100644 docs/models/operations/listmarketingautomationcampaignrequest.md delete mode 100644 docs/models/operations/listmarketingautomationcampaignresponsebody.md create mode 100644 docs/models/operations/listmarketingautomationcampaignsrequest.md create mode 100644 docs/models/operations/listmarketingautomationcampaignsresponsebody.md create mode 100644 docs/models/operations/retrievehriscompanyrequest.md create mode 100644 docs/models/operations/retrievehrispayrollrunrequest.md create mode 100644 docs/models/operations/vertical.md rename docs/sdks/{single => id}/README.md (94%) delete mode 100644 src/models/components/unifiedcampaignoutput.ts rename src/models/components/{unifieduseroutput.ts => unifiedfilestorageuseroutput.ts} (56%) create mode 100644 src/models/components/unifiedmarketingautomationcampaignoutput.ts rename src/models/operations/{listhrisbenefit.ts => listhrisbenefits.ts} (62%) rename src/models/operations/{listhriscompanys.ts => listhriscompanies.ts} (61%) rename src/models/operations/{listhrisemployee.ts => listhrisemployees.ts} (61%) rename src/models/operations/{listhrisemployerbenefit.ts => listhrisemployerbenefits.ts} (60%) rename src/models/operations/{listhrisemployment.ts => listhrisemployments.ts} (61%) rename src/models/operations/{listhrisgroup.ts => listhrisgroups.ts} (62%) rename src/models/operations/{listhrislocation.ts => listhrislocations.ts} (61%) rename src/models/operations/{listhrispaygroup.ts => listhrispaygroups.ts} (61%) rename src/models/operations/{listhristimeoffbalance.ts => listhristimeoffbalances.ts} (60%) rename src/models/operations/{listmarketingautomationautomation.ts => listmarketingautomationautomations.ts} (61%) rename src/models/operations/{listmarketingautomationcampaign.ts => listmarketingautomationcampaigns.ts} (55%) create mode 100644 src/models/operations/retrievehriscompany.ts create mode 100644 src/models/operations/retrievehrispayrollrun.ts rename src/sdk/{single.ts => id.ts} (78%) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index f61ce630..938f8c77 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,23 +1,22 @@ lockVersion: 2.0.0 id: caaaa8c3-6dd7-43a5-841e-c3193e68cc73 management: - docChecksum: 60112bba1ada46f22ab482e42dd98db2 + docChecksum: 5318f76de9f42523396aae8e51f30ca5 docVersion: "1.0" - speakeasyVersion: 1.352.1 - generationVersion: 2.385.1 - releaseVersion: 0.4.2 - configChecksum: 764e671a86cc92de8e4f4b291070ac63 + speakeasyVersion: 1.352.2 + generationVersion: 2.385.2 + releaseVersion: 0.5.0 + configChecksum: 471661da6f31f24888f2d7cb584b97cd repoURL: https://github.com/panoratech/typescript-sdk.git installationURL: https://github.com/panoratech/typescript-sdk published: true features: typescript: additionalDependencies: 0.1.0 - constsAndDefaults: 0.1.5 core: 3.11.13 defaultEnabledRetries: 0.1.0 envVarSecurityUsage: 0.1.1 - globalSecurity: 2.82.9 + globalSecurity: 2.82.10 globalSecurityCallbacks: 0.1.0 globalSecurityFlattening: 0.1.0 globalServerURLs: 2.82.4 @@ -51,7 +50,7 @@ generatedFiles: - src/sdk/panorausers.ts - src/sdk/crm.ts - src/sdk/batch.ts - - src/sdk/single.ts + - src/sdk/id.ts - src/sdk/fromremoteid.ts - src/sdk/linkedusers.ts - src/sdk/define.ts @@ -220,7 +219,7 @@ generatedFiles: - src/models/components/unifiedmarketingautomationactioninput.ts - src/models/components/unifiedmarketingautomationautomationoutput.ts - src/models/components/unifiedmarketingautomationautomationinput.ts - - src/models/components/unifiedcampaignoutput.ts + - src/models/components/unifiedmarketingautomationcampaignoutput.ts - src/models/components/unifiedmarketingautomationcampaigninput.ts - src/models/components/unifiedmarketingautomationcontactoutput.ts - src/models/components/unifiedmarketingautomationcontactinput.ts @@ -287,7 +286,7 @@ generatedFiles: - src/models/components/unifiedfilestoragefolderoutput.ts - src/models/components/unifiedfilestoragefolderinput.ts - src/models/components/unifiedfilestoragegroupoutput.ts - - src/models/components/unifieduseroutput.ts + - src/models/components/unifiedfilestorageuseroutput.ts - src/models/components/security.ts - src/models/operations/delete.ts - src/models/operations/updatestatus.ts @@ -341,39 +340,41 @@ generatedFiles: - src/models/operations/request.ts - src/models/operations/listhrisbankinfo.ts - src/models/operations/retrievehrisbankinfo.ts - - src/models/operations/listhrisbenefit.ts + - src/models/operations/listhrisbenefits.ts - src/models/operations/retrievehrisbenefit.ts - - src/models/operations/listhriscompanys.ts + - src/models/operations/listhriscompanies.ts + - src/models/operations/retrievehriscompany.ts - src/models/operations/listhrisdependents.ts - src/models/operations/retrievehrisdependent.ts - src/models/operations/listhrisemployeepayrollrun.ts - src/models/operations/retrievehrisemployeepayrollrun.ts - - src/models/operations/listhrisemployee.ts + - src/models/operations/listhrisemployees.ts - src/models/operations/createhrisemployee.ts - src/models/operations/retrievehrisemployee.ts - - src/models/operations/listhrisemployerbenefit.ts + - src/models/operations/listhrisemployerbenefits.ts - src/models/operations/retrievehrisemployerbenefit.ts - - src/models/operations/listhrisemployment.ts + - src/models/operations/listhrisemployments.ts - src/models/operations/retrievehrisemployment.ts - - src/models/operations/listhrisgroup.ts + - src/models/operations/listhrisgroups.ts - src/models/operations/retrievehrisgroup.ts - - src/models/operations/listhrislocation.ts + - src/models/operations/listhrislocations.ts - src/models/operations/retrievehrislocation.ts - - src/models/operations/listhrispaygroup.ts + - src/models/operations/listhrispaygroups.ts - src/models/operations/retrievehrispaygroup.ts - src/models/operations/listhrispayrollruns.ts + - src/models/operations/retrievehrispayrollrun.ts - src/models/operations/listhristimeoffs.ts - src/models/operations/createhristimeoff.ts - src/models/operations/retrievehristimeoff.ts - - src/models/operations/listhristimeoffbalance.ts + - src/models/operations/listhristimeoffbalances.ts - src/models/operations/retrievehristimeoffbalance.ts - src/models/operations/listmarketingautomationaction.ts - src/models/operations/createmarketingautomationaction.ts - src/models/operations/retrievemarketingautomationaction.ts - - src/models/operations/listmarketingautomationautomation.ts + - src/models/operations/listmarketingautomationautomations.ts - src/models/operations/createmarketingautomationautomation.ts - src/models/operations/retrievemarketingautomationautomation.ts - - src/models/operations/listmarketingautomationcampaign.ts + - src/models/operations/listmarketingautomationcampaigns.ts - src/models/operations/createmarketingautomationcampaign.ts - src/models/operations/retrievemarketingautomationcampaign.ts - src/models/operations/listmarketingautomationcontacts.ts @@ -494,49 +495,75 @@ generatedFiles: - docs/models/components/webhookresponse.md - docs/models/components/webhookdto.md - docs/models/components/signatureverificationdto.md + - docs/models/components/status.md + - docs/models/components/type.md + - docs/models/components/priority.md + - docs/models/components/unifiedticketingticketoutputcreatortype.md - docs/models/components/comment.md - docs/models/components/unifiedticketingticketoutput.md + - docs/models/components/unifiedticketingticketinputstatus.md + - docs/models/components/unifiedticketingticketinputtype.md + - docs/models/components/unifiedticketingticketinputpriority.md + - docs/models/components/unifiedticketingticketinputcreatortype.md - docs/models/components/unifiedticketingticketinputcomment.md - docs/models/components/unifiedticketingticketinput.md - docs/models/components/unifiedticketinguseroutput.md - docs/models/components/unifiedticketingaccountoutput.md - docs/models/components/unifiedticketingcontactoutput.md + - docs/models/components/collectiontype.md - docs/models/components/unifiedticketingcollectionoutput.md + - docs/models/components/creatortype.md - docs/models/components/unifiedticketingcommentoutput.md + - docs/models/components/unifiedticketingcommentinputcreatortype.md - docs/models/components/unifiedticketingcommentinput.md - docs/models/components/unifiedticketingtagoutput.md - docs/models/components/unifiedticketingteamoutput.md - docs/models/components/unifiedticketingattachmentoutput.md - docs/models/components/unifiedticketingattachmentinput.md - docs/models/components/resyncstatusdto.md + - docs/models/components/industry.md - docs/models/components/createdat.md - docs/models/components/modifiedat.md - docs/models/components/unifiedcrmcompanyoutput.md + - docs/models/components/phonetype.md - docs/models/components/phone.md + - docs/models/components/addresstype.md - docs/models/components/address.md + - docs/models/components/emailaddresstype.md + - docs/models/components/ownertype.md - docs/models/components/email.md + - docs/models/components/unifiedcrmcompanyinputindustry.md - docs/models/components/unifiedcrmcompanyinput.md - docs/models/components/unifiedcrmcontactoutput.md - docs/models/components/unifiedcrmcontactinput.md - docs/models/components/unifiedcrmdealoutput.md - docs/models/components/unifiedcrmdealinput.md + - docs/models/components/direction.md + - docs/models/components/unifiedcrmengagementoutputtype.md - docs/models/components/unifiedcrmengagementoutput.md + - docs/models/components/unifiedcrmengagementinputdirection.md + - docs/models/components/unifiedcrmengagementinputtype.md - docs/models/components/unifiedcrmengagementinput.md - docs/models/components/unifiedcrmnoteoutput.md - docs/models/components/unifiedcrmnoteinput.md - docs/models/components/unifiedcrmstageoutputcreatedat.md - docs/models/components/unifiedcrmstageoutputmodifiedat.md - docs/models/components/unifiedcrmstageoutput.md - - docs/models/components/unifiedcrmtaskoutputcreatedat.md - - docs/models/components/unifiedcrmtaskoutputmodifiedat.md + - docs/models/components/unifiedcrmtaskoutputstatus.md - docs/models/components/unifiedcrmtaskoutput.md + - docs/models/components/unifiedcrmtaskinputstatus.md - docs/models/components/unifiedcrmtaskinput.md - docs/models/components/unifiedcrmuseroutput.md - docs/models/components/linkeduserresponse.md - docs/models/components/createlinkeduserdto.md - docs/models/components/createbatchlinkeduserdto.md + - docs/models/components/customfieldresponsedatatype.md - docs/models/components/customfieldresponse.md + - docs/models/components/customfieldcreatedtoobjecttypeowner.md + - docs/models/components/customfieldcreatedtodatatype.md - docs/models/components/customfieldcreatedto.md + - docs/models/components/objecttypeowner.md + - docs/models/components/datatype.md - docs/models/components/definetargetfielddto.md - docs/models/components/mapfieldtoproviderdto.md - docs/models/components/passthroughresponsedata.md @@ -564,7 +591,7 @@ generatedFiles: - docs/models/components/unifiedmarketingautomationactioninput.md - docs/models/components/unifiedmarketingautomationautomationoutput.md - docs/models/components/unifiedmarketingautomationautomationinput.md - - docs/models/components/unifiedcampaignoutput.md + - docs/models/components/unifiedmarketingautomationcampaignoutput.md - docs/models/components/unifiedmarketingautomationcampaigninput.md - docs/models/components/unifiedmarketingautomationcontactoutput.md - docs/models/components/unifiedmarketingautomationcontactinput.md @@ -576,28 +603,45 @@ generatedFiles: - docs/models/components/unifiedmarketingautomationtemplateoutput.md - docs/models/components/unifiedmarketingautomationtemplateinput.md - docs/models/components/unifiedmarketingautomationuseroutput.md + - docs/models/components/activitytype.md + - docs/models/components/visibility.md - docs/models/components/unifiedatsactivityoutput.md + - docs/models/components/unifiedatsactivityinputactivitytype.md + - docs/models/components/unifiedatsactivityinputvisibility.md - docs/models/components/unifiedatsactivityinput.md - docs/models/components/unifiedatsapplicationoutput.md - docs/models/components/unifiedatsapplicationinput.md + - docs/models/components/attachmenttype.md - docs/models/components/unifiedatsattachmentoutput.md + - docs/models/components/unifiedatsattachmentinputattachmenttype.md - docs/models/components/unifiedatsattachmentinput.md - docs/models/components/unifiedatscandidateoutput.md - docs/models/components/url.md - docs/models/components/unifiedatscandidateinput.md - docs/models/components/unifiedatsdepartmentoutput.md + - docs/models/components/unifiedatsinterviewoutputstatus.md - docs/models/components/unifiedatsinterviewoutput.md + - docs/models/components/unifiedatsinterviewinputstatus.md - docs/models/components/unifiedatsinterviewinput.md - docs/models/components/unifiedatsjobinterviewstageoutput.md + - docs/models/components/unifiedatsjoboutputstatus.md + - docs/models/components/unifiedatsjoboutputtype.md - docs/models/components/unifiedatsjoboutput.md + - docs/models/components/unifiedatsofferoutputstatus.md - docs/models/components/unifiedatsofferoutputcreatedat.md - docs/models/components/unifiedatsofferoutputmodifiedat.md - docs/models/components/unifiedatsofferoutput.md - docs/models/components/unifiedatsofficeoutput.md - docs/models/components/unifiedatsrejectreasonoutput.md + - docs/models/components/overallrecommendation.md - docs/models/components/unifiedatsscorecardoutput.md - docs/models/components/unifiedatstagoutput.md + - docs/models/components/accessrole.md - docs/models/components/unifiedatsuseroutput.md + - docs/models/components/race.md + - docs/models/components/gender.md + - docs/models/components/veteranstatus.md + - docs/models/components/disabilitystatus.md - docs/models/components/unifiedatseeocsoutput.md - docs/models/components/unifiedaccountingaccountoutput.md - docs/models/components/unifiedaccountingaccountinput.md @@ -633,7 +677,7 @@ generatedFiles: - docs/models/components/unifiedfilestoragefolderoutput.md - docs/models/components/unifiedfilestoragefolderinput.md - docs/models/components/unifiedfilestoragegroupoutput.md - - docs/models/components/unifieduseroutput.md + - docs/models/components/unifiedfilestorageuseroutput.md - docs/models/components/security.md - docs/models/operations/deleterequest.md - docs/models/operations/updatestatusrequest.md @@ -670,6 +714,7 @@ generatedFiles: - docs/models/operations/listticketingattachmentsresponsebody.md - docs/models/operations/createticketingattachmentrequest.md - docs/models/operations/retrieveticketingattachmentrequest.md + - docs/models/operations/vertical.md - docs/models/operations/statusrequest.md - docs/models/operations/listcrmcompanyrequest.md - docs/models/operations/listcrmcompanyresponsebody.md @@ -707,55 +752,57 @@ generatedFiles: - docs/models/operations/listhrisbankinforequest.md - docs/models/operations/listhrisbankinforesponsebody.md - docs/models/operations/retrievehrisbankinforequest.md - - docs/models/operations/listhrisbenefitrequest.md - - docs/models/operations/listhrisbenefitresponsebody.md + - docs/models/operations/listhrisbenefitsrequest.md + - docs/models/operations/listhrisbenefitsresponsebody.md - docs/models/operations/retrievehrisbenefitrequest.md - - docs/models/operations/listhriscompanysrequest.md - - docs/models/operations/listhriscompanysresponsebody.md + - docs/models/operations/listhriscompaniesrequest.md + - docs/models/operations/listhriscompaniesresponsebody.md + - docs/models/operations/retrievehriscompanyrequest.md - docs/models/operations/listhrisdependentsrequest.md - docs/models/operations/listhrisdependentsresponsebody.md - docs/models/operations/retrievehrisdependentrequest.md - docs/models/operations/listhrisemployeepayrollrunrequest.md - docs/models/operations/listhrisemployeepayrollrunresponsebody.md - docs/models/operations/retrievehrisemployeepayrollrunrequest.md - - docs/models/operations/listhrisemployeerequest.md - - docs/models/operations/listhrisemployeeresponsebody.md + - docs/models/operations/listhrisemployeesrequest.md + - docs/models/operations/listhrisemployeesresponsebody.md - docs/models/operations/createhrisemployeerequest.md - docs/models/operations/retrievehrisemployeerequest.md - - docs/models/operations/listhrisemployerbenefitrequest.md - - docs/models/operations/listhrisemployerbenefitresponsebody.md + - docs/models/operations/listhrisemployerbenefitsrequest.md + - docs/models/operations/listhrisemployerbenefitsresponsebody.md - docs/models/operations/retrievehrisemployerbenefitrequest.md - - docs/models/operations/listhrisemploymentrequest.md - - docs/models/operations/listhrisemploymentresponsebody.md + - docs/models/operations/listhrisemploymentsrequest.md + - docs/models/operations/listhrisemploymentsresponsebody.md - docs/models/operations/retrievehrisemploymentrequest.md - - docs/models/operations/listhrisgrouprequest.md - - docs/models/operations/listhrisgroupresponsebody.md + - docs/models/operations/listhrisgroupsrequest.md + - docs/models/operations/listhrisgroupsresponsebody.md - docs/models/operations/retrievehrisgrouprequest.md - - docs/models/operations/listhrislocationrequest.md - - docs/models/operations/listhrislocationresponsebody.md + - docs/models/operations/listhrislocationsrequest.md + - docs/models/operations/listhrislocationsresponsebody.md - docs/models/operations/retrievehrislocationrequest.md - - docs/models/operations/listhrispaygrouprequest.md - - docs/models/operations/listhrispaygroupresponsebody.md + - docs/models/operations/listhrispaygroupsrequest.md + - docs/models/operations/listhrispaygroupsresponsebody.md - docs/models/operations/retrievehrispaygrouprequest.md - docs/models/operations/listhrispayrollrunsrequest.md - docs/models/operations/listhrispayrollrunsresponsebody.md + - docs/models/operations/retrievehrispayrollrunrequest.md - docs/models/operations/listhristimeoffsrequest.md - docs/models/operations/listhristimeoffsresponsebody.md - docs/models/operations/createhristimeoffrequest.md - docs/models/operations/retrievehristimeoffrequest.md - - docs/models/operations/listhristimeoffbalancerequest.md - - docs/models/operations/listhristimeoffbalanceresponsebody.md + - docs/models/operations/listhristimeoffbalancesrequest.md + - docs/models/operations/listhristimeoffbalancesresponsebody.md - docs/models/operations/retrievehristimeoffbalancerequest.md - docs/models/operations/listmarketingautomationactionrequest.md - docs/models/operations/listmarketingautomationactionresponsebody.md - docs/models/operations/createmarketingautomationactionrequest.md - docs/models/operations/retrievemarketingautomationactionrequest.md - - docs/models/operations/listmarketingautomationautomationrequest.md - - docs/models/operations/listmarketingautomationautomationresponsebody.md + - docs/models/operations/listmarketingautomationautomationsrequest.md + - docs/models/operations/listmarketingautomationautomationsresponsebody.md - docs/models/operations/createmarketingautomationautomationrequest.md - docs/models/operations/retrievemarketingautomationautomationrequest.md - - docs/models/operations/listmarketingautomationcampaignrequest.md - - docs/models/operations/listmarketingautomationcampaignresponsebody.md + - docs/models/operations/listmarketingautomationcampaignsrequest.md + - docs/models/operations/listmarketingautomationcampaignsresponsebody.md - docs/models/operations/createmarketingautomationcampaignrequest.md - docs/models/operations/retrievemarketingautomationcampaignrequest.md - docs/models/operations/listmarketingautomationcontactsrequest.md @@ -942,7 +989,7 @@ generatedFiles: - docs/sdks/panorausers/README.md - docs/sdks/linkedusers/README.md - docs/sdks/batch/README.md - - docs/sdks/single/README.md + - docs/sdks/id/README.md - docs/sdks/fromremoteid/README.md - docs/sdks/fieldmappings/README.md - docs/sdks/define/README.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index d58c62aa..5000dbac 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false typescript: - version: 0.4.2 + version: 0.5.0 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index b611101a..5943e4fb 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.352.1 +speakeasyVersion: 1.352.2 sources: panora-open-api-swagger: sourceNamespace: panora-open-api-swagger - sourceRevisionDigest: sha256:8174039ddb04010d0946738af22aa8ba1729ccef182cd7ffc2def526fed56be1 - sourceBlobDigest: sha256:6044d83fd5d0be8e89ea525b1a13257c84dffe81930191268d3eb8f3f12aacca + sourceRevisionDigest: sha256:eab5d07be6bed17a6a6372416eb9dd1870010f9045198f961755aedcac42856a + sourceBlobDigest: sha256:b45101c8420335cad01e5687e19bdd0389a19091cc03d035be4eadefc0e3665b tags: - latest - main @@ -11,10 +11,10 @@ targets: my-first-target: source: panora-open-api-swagger sourceNamespace: panora-open-api-swagger - sourceRevisionDigest: sha256:8174039ddb04010d0946738af22aa8ba1729ccef182cd7ffc2def526fed56be1 - sourceBlobDigest: sha256:6044d83fd5d0be8e89ea525b1a13257c84dffe81930191268d3eb8f3f12aacca + sourceRevisionDigest: sha256:eab5d07be6bed17a6a6372416eb9dd1870010f9045198f961755aedcac42856a + sourceBlobDigest: sha256:b45101c8420335cad01e5687e19bdd0389a19091cc03d035be4eadefc0e3665b codeSamplesNamespace: code-samples-typescript-my-first-target - codeSamplesRevisionDigest: sha256:e47be1438ffd8c90d29c42920fdc88056369186283a6884fd6dcd5ba117b9b9b + codeSamplesRevisionDigest: sha256:879e26caa60697469fef7d54ba290c1f054f3ef534509e1ce45f6ca8c42cda3e outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 diff --git a/README.md b/README.md index 868d8545..3d52dee8 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -102,8 +102,8 @@ run(); ### [ticketing.users](docs/sdks/users/README.md) -* [list](docs/sdks/users/README.md#list) - List Users -* [retrieve](docs/sdks/users/README.md#retrieve) - Retrieve Users +* [list](docs/sdks/users/README.md#list) - List Users +* [retrieve](docs/sdks/users/README.md#retrieve) - Retrieve User ### [ticketing.accounts](docs/sdks/accounts/README.md) @@ -112,24 +112,24 @@ run(); ### [ticketing.contacts](docs/sdks/contacts/README.md) -* [list](docs/sdks/contacts/README.md#list) - List all Contacts -* [retrieve](docs/sdks/contacts/README.md#retrieve) - Retrieve Contacts +* [list](docs/sdks/contacts/README.md#list) - List Contacts +* [retrieve](docs/sdks/contacts/README.md#retrieve) - Retrieve Contact ### [ticketing.collections](docs/sdks/collections/README.md) -* [list](docs/sdks/collections/README.md#list) - List Collections +* [list](docs/sdks/collections/README.md#list) - List Collections * [retrieve](docs/sdks/collections/README.md#retrieve) - Retrieve Collections ### [ticketing.comments](docs/sdks/comments/README.md) -* [list](docs/sdks/comments/README.md#list) - List Comments +* [list](docs/sdks/comments/README.md#list) - List Comments * [create](docs/sdks/comments/README.md#create) - Create Comments -* [retrieve](docs/sdks/comments/README.md#retrieve) - Retrieve Comments +* [retrieve](docs/sdks/comments/README.md#retrieve) - Retrieve Comment ### [ticketing.tags](docs/sdks/tags/README.md) -* [list](docs/sdks/tags/README.md#list) - List Tags -* [retrieve](docs/sdks/tags/README.md#retrieve) - Retrieve Tags +* [list](docs/sdks/tags/README.md#list) - List Tags +* [retrieve](docs/sdks/tags/README.md#retrieve) - Retrieve Tag ### [ticketing.teams](docs/sdks/teams/README.md) @@ -162,19 +162,19 @@ run(); ### [crm.deals](docs/sdks/deals/README.md) -* [list](docs/sdks/deals/README.md#list) - List Deals +* [list](docs/sdks/deals/README.md#list) - List Deals * [create](docs/sdks/deals/README.md#create) - Create Deals * [retrieve](docs/sdks/deals/README.md#retrieve) - Retrieve Deals ### [crm.engagements](docs/sdks/engagements/README.md) -* [list](docs/sdks/engagements/README.md#list) - List Engagements +* [list](docs/sdks/engagements/README.md#list) - List Engagements * [create](docs/sdks/engagements/README.md#create) - Create Engagements * [retrieve](docs/sdks/engagements/README.md#retrieve) - Retrieve Engagements ### [crm.notes](docs/sdks/notes/README.md) -* [list](docs/sdks/notes/README.md#list) - List Notes +* [list](docs/sdks/notes/README.md#list) - List Notes * [create](docs/sdks/notes/README.md#create) - Create Notes * [retrieve](docs/sdks/notes/README.md#retrieve) - Retrieve Notes @@ -185,7 +185,7 @@ run(); ### [crm.tasks](docs/sdks/tasks/README.md) -* [list](docs/sdks/tasks/README.md#list) - List Tasks +* [list](docs/sdks/tasks/README.md#list) - List Tasks * [create](docs/sdks/tasks/README.md#create) - Create Tasks * [retrieve](docs/sdks/tasks/README.md#retrieve) - Retrieve Tasks @@ -203,9 +203,9 @@ run(); * [importBatch](docs/sdks/batch/README.md#importbatch) - Add Batch Linked Users -### [linkedUsers.single](docs/sdks/single/README.md) +### [linkedUsers.id](docs/sdks/id/README.md) -* [retrieve](docs/sdks/single/README.md#retrieve) - Retrieve Linked Users +* [retrieve](docs/sdks/id/README.md#retrieve) - Retrieve Linked Users ### [linkedUsers.fromremoteid](docs/sdks/fromremoteid/README.md) @@ -230,68 +230,70 @@ run(); ### [hris.bankinfos](docs/sdks/bankinfos/README.md) -* [list](docs/sdks/bankinfos/README.md#list) - List Bankinfos -* [retrieve](docs/sdks/bankinfos/README.md#retrieve) - Retrieve Bank Infos +* [list](docs/sdks/bankinfos/README.md#list) - List Bank Info +* [retrieve](docs/sdks/bankinfos/README.md#retrieve) - Retrieve Bank Info ### [hris.benefits](docs/sdks/benefits/README.md) -* [list](docs/sdks/benefits/README.md#list) - List Benefits -* [retrieve](docs/sdks/benefits/README.md#retrieve) - Retrieve Benefits +* [list](docs/sdks/benefits/README.md#list) - List Benefits +* [retrieve](docs/sdks/benefits/README.md#retrieve) - Retrieve Benefit ### [hris.companies](docs/sdks/panoracompanies/README.md) -* [list](docs/sdks/panoracompanies/README.md#list) - List Companys +* [list](docs/sdks/panoracompanies/README.md#list) - List Companies +* [retrieve](docs/sdks/panoracompanies/README.md#retrieve) - Retrieve Company ### [hris.dependents](docs/sdks/dependents/README.md) -* [list](docs/sdks/dependents/README.md#list) - List Dependents -* [retrieve](docs/sdks/dependents/README.md#retrieve) - Retrieve Dependents +* [list](docs/sdks/dependents/README.md#list) - List Dependents +* [retrieve](docs/sdks/dependents/README.md#retrieve) - Retrieve Dependent ### [hris.employeepayrollruns](docs/sdks/employeepayrollruns/README.md) -* [list](docs/sdks/employeepayrollruns/README.md#list) - List EmployeePayrollRuns -* [retrieve](docs/sdks/employeepayrollruns/README.md#retrieve) - Retrieve Employee Payroll Runs +* [list](docs/sdks/employeepayrollruns/README.md#list) - List Employee Payroll Runs +* [retrieve](docs/sdks/employeepayrollruns/README.md#retrieve) - Retrieve Employee Payroll Run ### [hris.employees](docs/sdks/employees/README.md) -* [list](docs/sdks/employees/README.md#list) - List Employees +* [list](docs/sdks/employees/README.md#list) - List Employees * [create](docs/sdks/employees/README.md#create) - Create Employees -* [retrieve](docs/sdks/employees/README.md#retrieve) - Retrieven Employees +* [retrieve](docs/sdks/employees/README.md#retrieve) - Retrieve Employee ### [hris.employerbenefits](docs/sdks/employerbenefits/README.md) -* [list](docs/sdks/employerbenefits/README.md#list) - List EmployerBenefits -* [retrieve](docs/sdks/employerbenefits/README.md#retrieve) - Retrieve Employer Benefits +* [list](docs/sdks/employerbenefits/README.md#list) - List Employer Benefits +* [retrieve](docs/sdks/employerbenefits/README.md#retrieve) - Retrieve Employer Benefit ### [hris.employments](docs/sdks/employments/README.md) -* [list](docs/sdks/employments/README.md#list) - List Employments -* [retrieve](docs/sdks/employments/README.md#retrieve) - Retrieve Employments +* [list](docs/sdks/employments/README.md#list) - List Employments +* [retrieve](docs/sdks/employments/README.md#retrieve) - Retrieve Employment ### [hris.groups](docs/sdks/groups/README.md) -* [list](docs/sdks/groups/README.md#list) - List Groups -* [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve Groups +* [list](docs/sdks/groups/README.md#list) - List Groups +* [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve Group ### [hris.locations](docs/sdks/locations/README.md) -* [list](docs/sdks/locations/README.md#list) - List Locations -* [retrieve](docs/sdks/locations/README.md#retrieve) - Retrieve Locations +* [list](docs/sdks/locations/README.md#list) - List Locations +* [retrieve](docs/sdks/locations/README.md#retrieve) - Retrieve Location ### [hris.paygroups](docs/sdks/paygroups/README.md) -* [list](docs/sdks/paygroups/README.md#list) - List PayGroups -* [retrieve](docs/sdks/paygroups/README.md#retrieve) - Retrieve Pay Groups +* [list](docs/sdks/paygroups/README.md#list) - List Pay Groups +* [retrieve](docs/sdks/paygroups/README.md#retrieve) - Retrieve Pay Group ### [hris.payrollruns](docs/sdks/payrollruns/README.md) -* [list](docs/sdks/payrollruns/README.md#list) - List PayrollRuns +* [list](docs/sdks/payrollruns/README.md#list) - List Payroll Runs +* [retrieve](docs/sdks/payrollruns/README.md#retrieve) - Retrieve Payroll Run ### [hris.timeoffs](docs/sdks/timeoffs/README.md) -* [list](docs/sdks/timeoffs/README.md#list) - List Timeoffs +* [list](docs/sdks/timeoffs/README.md#list) - List Time Offs * [create](docs/sdks/timeoffs/README.md#create) - Create Timeoffs -* [retrieve](docs/sdks/timeoffs/README.md#retrieve) - Retrieve Timeoffs +* [retrieve](docs/sdks/timeoffs/README.md#retrieve) - Retrieve Time Off ### [hris.timeoffbalances](docs/sdks/timeoffbalances/README.md) @@ -301,21 +303,21 @@ run(); ### [marketingautomation.actions](docs/sdks/actions/README.md) -* [list](docs/sdks/actions/README.md#list) - List Actions +* [list](docs/sdks/actions/README.md#list) - List Actions * [create](docs/sdks/actions/README.md#create) - Create Action * [retrieve](docs/sdks/actions/README.md#retrieve) - Retrieve Actions ### [marketingautomation.automations](docs/sdks/automations/README.md) -* [list](docs/sdks/automations/README.md#list) - List Automations +* [list](docs/sdks/automations/README.md#list) - List Automations * [create](docs/sdks/automations/README.md#create) - Create Automation -* [retrieve](docs/sdks/automations/README.md#retrieve) - Retrieve Automations +* [retrieve](docs/sdks/automations/README.md#retrieve) - Retrieve Automation ### [marketingautomation.campaigns](docs/sdks/campaigns/README.md) -* [list](docs/sdks/campaigns/README.md#list) - List Campaigns +* [list](docs/sdks/campaigns/README.md#list) - List Campaigns * [create](docs/sdks/campaigns/README.md#create) - Create Campaign -* [retrieve](docs/sdks/campaigns/README.md#retrieve) - Retrieve Campaigns +* [retrieve](docs/sdks/campaigns/README.md#retrieve) - Retrieve Campaign ### [marketingautomation.contacts](docs/sdks/panoramarketingautomationcontacts/README.md) @@ -325,30 +327,30 @@ run(); ### [marketingautomation.emails](docs/sdks/emails/README.md) -* [list](docs/sdks/emails/README.md#list) - List Emails -* [retrieve](docs/sdks/emails/README.md#retrieve) - Retrieve Emails +* [list](docs/sdks/emails/README.md#list) - List Emails +* [retrieve](docs/sdks/emails/README.md#retrieve) - Retrieve Email ### [marketingautomation.events](docs/sdks/events/README.md) -* [list](docs/sdks/events/README.md#list) - List Events -* [retrieve](docs/sdks/events/README.md#retrieve) - Retrieve Events +* [list](docs/sdks/events/README.md#list) - List Events +* [retrieve](docs/sdks/events/README.md#retrieve) - Retrieve Event ### [marketingautomation.lists](docs/sdks/lists/README.md) -* [list](docs/sdks/lists/README.md#list) - List Lists +* [list](docs/sdks/lists/README.md#list) - List Lists * [create](docs/sdks/lists/README.md#create) - Create Lists -* [retrieve](docs/sdks/lists/README.md#retrieve) - Retrieve Lists +* [retrieve](docs/sdks/lists/README.md#retrieve) - Retrieve List ### [marketingautomation.messages](docs/sdks/messages/README.md) -* [list](docs/sdks/messages/README.md#list) - List Messages +* [list](docs/sdks/messages/README.md#list) - List Messages * [retrieve](docs/sdks/messages/README.md#retrieve) - Retrieve Messages ### [marketingautomation.templates](docs/sdks/templates/README.md) -* [list](docs/sdks/templates/README.md#list) - List Templates +* [list](docs/sdks/templates/README.md#list) - List Templates * [create](docs/sdks/templates/README.md#create) - Create Template -* [retrieve](docs/sdks/templates/README.md#retrieve) - Retrieve Templates +* [retrieve](docs/sdks/templates/README.md#retrieve) - Retrieve Template ### [marketingautomation.users](docs/sdks/panoramarketingautomationusers/README.md) @@ -548,8 +550,8 @@ run(); ### [filestorage.drives](docs/sdks/drives/README.md) -* [list](docs/sdks/drives/README.md#list) - List Drives -* [retrieve](docs/sdks/drives/README.md#retrieve) - Retrieve Drives +* [list](docs/sdks/drives/README.md#list) - List Drives +* [retrieve](docs/sdks/drives/README.md#retrieve) - Retrieve Drive ### [filestorage.files](docs/sdks/files/README.md) @@ -570,7 +572,7 @@ run(); ### [filestorage.users](docs/sdks/panorafilestorageusers/README.md) -* [list](docs/sdks/panorafilestorageusers/README.md#list) - List Users +* [list](docs/sdks/panorafilestorageusers/README.md#list) - List Users * [retrieve](docs/sdks/panorafilestorageusers/README.md#retrieve) - Retrieve Users @@ -591,7 +593,7 @@ import { Panora } from "@panora/sdk"; import { SDKValidationError } from "@panora/sdk/models/errors"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -640,7 +642,7 @@ import { Panora } from "@panora/sdk"; const panora = new Panora({ serverIdx: 2, - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -664,7 +666,7 @@ import { Panora } from "@panora/sdk"; const panora = new Panora({ serverURL: "https://api.panora.dev", - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -738,7 +740,7 @@ To change the default retry strategy for a single API call, simply provide a ret import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -778,7 +780,7 @@ const panora = new Panora({ }, retryConnectionErrors: false, }, - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -804,12 +806,12 @@ This SDK supports the following security scheme globally: | -------- | -------- | -------- | | `apiKey` | apiKey | API key | -To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example: +To authenticate with the API the `nullT` parameter must be set when initializing the SDK client instance. For example: ```typescript import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/RELEASES.md b/RELEASES.md index b35e3067..7de296b1 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -98,4 +98,14 @@ Based on: ### Generated - [typescript v0.4.2] . ### Releases -- [NPM v0.4.2] https://www.npmjs.com/package/@panora/sdk/v/0.4.2 - . \ No newline at end of file +- [NPM v0.4.2] https://www.npmjs.com/package/@panora/sdk/v/0.4.2 - . + +## 2024-08-05 18:42:16 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.352.2 (2.385.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.5.0] . +### Releases +- [NPM v0.5.0] https://www.npmjs.com/package/@panora/sdk/v/0.5.0 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 03e17a05..f12c22b4 100644 --- a/USAGE.md +++ b/USAGE.md @@ -3,7 +3,7 @@ import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/codeSamples.yaml b/codeSamples.yaml index 993eeb42..7ad8d576 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -3,24 +3,23 @@ info: title: CodeSamples overlay for typescript target version: 0.0.0 actions: - - target: $["paths"]["/linked_users/batch"]["post"] + - target: $["paths"]["/ats/tags/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: importBatch + label: retrieveAtsTag source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.linkedUsers.batch.importBatch({ - linkedUserOriginIds: [ - "", - ], - alias: "", + const result = await panora.ats.tags.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -28,21 +27,23 @@ actions: } run(); - - target: $["paths"]["/ats/eeocs"]["get"] + - target: $["paths"]["/accounting/invoices/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsEeocs + label: retrieveAccountingInvoice source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.eeocs.list({ + const result = await panora.accounting.invoices.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -50,22 +51,23 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts"]["post"] + - target: $["paths"]["/ticketing/teams/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingAccount + label: retrieveTicketingTeam source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.accounts.create({ + const result = await panora.ticketing.teams.retrieve({ xConnectionToken: "", - unifiedAccountingAccountInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -73,22 +75,21 @@ actions: } run(); - - target: $["paths"]["/ats/jobinterviewstages/{id}"]["get"] + - target: $["paths"]["/accounting/addresses"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsJobInterviewStage + label: listAccountingAddress source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.jobinterviewstages.retrieve({ + const result = await panora.accounting.addresses.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -96,21 +97,40 @@ actions: } run(); - - target: $["paths"]["/ats/users"]["get"] + - target: $["paths"]["/crm/engagements"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsUsers + label: createCrmEngagement source: |- import { Panora } from "@panora/sdk"; + import { UnifiedCrmEngagementInputDirection, UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.users.list({ + const result = await panora.crm.engagements.create({ xConnectionToken: "", + remoteData: false, + unifiedCrmEngagementInput: { + content: "Meeting call with CTO", + direction: UnifiedCrmEngagementInputDirection.Inbound, + subject: "Technical features planning", + startAt: new Date("2024-10-01T12:00:00Z"), + endTime: new Date("2024-10-01T22:00:00Z"), + type: UnifiedCrmEngagementInputType.Meeting, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contacts: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -118,21 +138,23 @@ actions: } run(); - - target: $["paths"]["/crm/tasks"]["get"] + - target: $["paths"]["/hris/locations/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmTask + label: retrieveHrisLocation source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.tasks.list({ + const result = await panora.hris.locations.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -140,20 +162,20 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/emails"]["get"] + - target: $["paths"]["/ats/users"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationEmails + label: listAtsUsers source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.emails.list({ + const result = await panora.ats.users.list({ xConnectionToken: "", }); @@ -162,22 +184,23 @@ actions: } run(); - - target: $["paths"]["/ats/applications/{id}"]["get"] + - target: $["paths"]["/accounting/companyinfos/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsApplication + label: retrieveAccountingCompanyInfo source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.applications.retrieve({ + const result = await panora.accounting.companyinfos.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -185,29 +208,21 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments"]["post"] + - target: $["paths"]["/accounting/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: createTicketingAttachment + label: listAccountingContacts source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.attachments.create({ + const result = await panora.accounting.contacts.list({ xConnectionToken: "", - unifiedTicketingAttachmentInput: { - fileName: "your_file_here", - fileUrl: "", - uploader: "", - fieldMappings: { - "key": "", - }, - }, }); // Handle the result @@ -215,21 +230,23 @@ actions: } run(); - - target: $["paths"]["/crm/contacts"]["get"] + - target: $["paths"]["/ats/offices/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmContacts + label: retrieveAtsOffice source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.contacts.list({ + const result = await panora.ats.offices.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -237,41 +254,81 @@ actions: } run(); - - target: $["paths"]["/webhooks"]["get"] + - target: $["paths"]["/accounting/cashflowstatements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listWebhooks + label: retrieveAccountingCashflowStatement source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.webhooks.list(); + const result = await panora.accounting.cashflowstatements.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ticketing/comments"]["get"] + - target: $["paths"]["/crm/companies"]["post"] update: x-codeSamples: - lang: typescript - label: listTicketingComments + label: createCrmCompany source: |- import { Panora } from "@panora/sdk"; + import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.comments.list({ + const result = await panora.crm.companies.create({ xConnectionToken: "", + remoteData: false, + unifiedCrmCompanyInput: { + name: "Acme", + industry: UnifiedCrmCompanyInputIndustry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "", + city: "New York", + state: "NY", + postalCode: "46842", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -279,21 +336,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns"]["get"] + - target: $["paths"]["/crm/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationCampaign + label: retrieveCrmContact source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.campaigns.list({ + const result = await panora.crm.contacts.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -301,24 +360,23 @@ actions: } run(); - - target: $["paths"]["/crm/notes"]["post"] + - target: $["paths"]["/marketingautomation/emails/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmNote + label: retrieveMarketingautomationEmail source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.notes.create({ + const result = await panora.marketingautomation.emails.retrieve({ xConnectionToken: "", - unifiedCrmNoteInput: { - content: "", - }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -326,41 +384,47 @@ actions: } run(); - - target: $["paths"]["/linked_users"]["get"] + - target: $["paths"]["/ats/jobinterviewstages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listLinkedUsers + label: retrieveAtsJobInterviewStage source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.linkedUsers.list(); + const result = await panora.ats.jobinterviewstages.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/filestorage/users"]["get"] + - target: $["paths"]["/ats/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageUsers + label: retrieveAtsUser source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.users.list({ + const result = await panora.ats.users.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -368,24 +432,21 @@ actions: } run(); - - target: $["paths"]["/field_mappings/map"]["post"] + - target: $["paths"]["/accounting/vendorcredits"]["get"] update: x-codeSamples: - lang: typescript - label: map + label: listAccountingVendorCredit source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.fieldMappings.map.map({ - attributeId: "", - sourceCustomFieldId: "", - sourceProvider: "", - linkedUserId: "", + const result = await panora.accounting.vendorcredits.list({ + xConnectionToken: "", }); // Handle the result @@ -393,22 +454,21 @@ actions: } run(); - - target: $["paths"]["/hris/paygroups/{id}"]["get"] + - target: $["paths"]["/hris/dependents"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisPaygroup + label: listHrisDependents source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.paygroups.retrieve({ + const result = await panora.hris.dependents.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -416,22 +476,23 @@ actions: } run(); - - target: $["paths"]["/accounting/taxrates/{id}"]["get"] + - target: $["paths"]["/accounting/invoices"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTaxRate + label: createAccountingInvoice source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.taxrates.retrieve({ + const result = await panora.accounting.invoices.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedAccountingInvoiceInput: {}, }); // Handle the result @@ -439,20 +500,20 @@ actions: } run(); - - target: $["paths"]["/accounting/transactions/{id}"]["get"] + - target: $["paths"]["/ticketing/accounts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTransaction + label: retrieveTicketingAccount source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.transactions.retrieve({ + const result = await panora.ticketing.accounts.retrieve({ xConnectionToken: "", id: "", }); @@ -462,22 +523,21 @@ actions: } run(); - - target: $["paths"]["/crm/tasks/{id}"]["get"] + - target: $["paths"]["/hris/benefits"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmTask + label: listHrisBenefits source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.tasks.retrieve({ + const result = await panora.hris.benefits.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -485,21 +545,23 @@ actions: } run(); - - target: $["paths"]["/ats/activities"]["get"] + - target: $["paths"]["/accounting/trackingcategories/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsActivity + label: retrieveAccountingTrackingCategory source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.activities.list({ + const result = await panora.accounting.trackingcategories.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -507,21 +569,31 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/contacts"]["get"] + - target: $["paths"]["/sync/status/{vertical}"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationContacts + label: status + source: "import { Panora } from \"@panora/sdk\";\nimport { Vertical } from \"@panora/sdk/models/operations\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.sync.status({\n vertical: Vertical.Ticketing,\n });\n\n \n}\n\nrun();" + - target: $["paths"]["/field_mappings/define"]["post"] + update: + x-codeSamples: + - lang: typescript + label: definitions source: |- import { Panora } from "@panora/sdk"; + import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.contacts.list({ - xConnectionToken: "", + const result = await panora.fieldMappings.define.definitions({ + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, }); // Handle the result @@ -529,22 +601,23 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders"]["post"] + - target: $["paths"]["/ats/offers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingPurchaseOrder + label: retrieveAtsOffer source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.purchaseorders.create({ + const result = await panora.ats.offers.retrieve({ xConnectionToken: "", - unifiedAccountingPurchaseorderInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -552,22 +625,21 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions"]["post"] + - target: $["paths"]["/accounting/items"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationAction + label: listAccountingItem source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.actions.create({ + const result = await panora.accounting.items.list({ xConnectionToken: "", - unifiedMarketingautomationActionInput: {}, }); // Handle the result @@ -575,21 +647,22 @@ actions: } run(); - - target: $["paths"]["/hris/payrollruns"]["get"] + - target: $["paths"]["/marketingautomation/templates"]["post"] update: x-codeSamples: - lang: typescript - label: listHrisPayrollRuns + label: createMarketingautomationTemplate source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.payrollruns.list({ + const result = await panora.marketingautomation.templates.create({ xConnectionToken: "", + unifiedMarketingautomationTemplateInput: {}, }); // Handle the result @@ -597,21 +670,25 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/users"]["get"] + - target: $["paths"]["/webhooks"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationUsers + label: createWebhookPublic source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.users.list({ - xConnectionToken: "", + const result = await panora.webhooks.create({ + url: "https://acme.com/webhook_receiver", + description: "Webhook to receive connection events", + scope: [ + "connection.created", + ], }); // Handle the result @@ -619,21 +696,23 @@ actions: } run(); - - target: $["paths"]["/accounting/companyinfos"]["get"] + - target: $["paths"]["/ats/interviews/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCompanyInfos + label: retrieveAtsInterview source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.companyinfos.list({ + const result = await panora.ats.interviews.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -641,22 +720,24 @@ actions: } run(); - - target: $["paths"]["/ticketing/tags/{id}"]["get"] + - target: $["paths"]["/field_mappings/map"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTag + label: map source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.tags.retrieve({ - xConnectionToken: "", - id: "", + const result = await panora.fieldMappings.map.map({ + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -664,22 +745,23 @@ actions: } run(); - - target: $["paths"]["/ats/candidates"]["post"] + - target: $["paths"]["/accounting/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsCandidate + label: retrieveAccountingAttachment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.candidates.create({ + const result = await panora.accounting.attachments.retrieve({ xConnectionToken: "", - unifiedAtsCandidateInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -687,22 +769,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/contacts/{id}"]["get"] + - target: $["paths"]["/hris/companies/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingContact + label: retrieveHrisCompany source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.contacts.retrieve({ + const result = await panora.hris.companies.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -710,21 +793,23 @@ actions: } run(); - - target: $["paths"]["/hris/benefits"]["get"] + - target: $["paths"]["/accounting/expenses"]["post"] update: x-codeSamples: - lang: typescript - label: listHrisBenefit + label: createAccountingExpense source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.benefits.list({ + const result = await panora.accounting.expenses.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingExpenseInput: {}, }); // Handle the result @@ -732,21 +817,21 @@ actions: } run(); - - target: $["paths"]["/crm/notes"]["get"] + - target: $["paths"]["/linked_users/fromRemoteId"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmNote + label: remoteId source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.notes.list({ - xConnectionToken: "", + const result = await panora.linkedUsers.fromremoteid.remoteId({ + remoteId: "id_1", }); // Handle the result @@ -754,22 +839,23 @@ actions: } run(); - - target: $["paths"]["/accounting/companyinfos/{id}"]["get"] + - target: $["paths"]["/hris/paygroups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCompanyInfo + label: retrieveHrisPaygroup source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.companyinfos.retrieve({ + const result = await panora.hris.paygroups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -777,22 +863,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments/{id}"]["get"] + - target: $["paths"]["/ats/activities/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingComment + label: retrieveAtsActivity source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.comments.retrieve({ + const result = await panora.ats.activities.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -800,22 +887,21 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/users/{id}"]["get"] + - target: $["paths"]["/accounting/journalentries"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingAutomationUser + label: listAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.users.retrieve({ + const result = await panora.accounting.journalentries.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -823,25 +909,21 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets"]["post"] + - target: $["paths"]["/ticketing/users"]["get"] update: x-codeSamples: - lang: typescript - label: createTicketingTicket + label: listTicketingUsers source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.tickets.create({ + const result = await panora.ticketing.users.list({ xConnectionToken: "", - unifiedTicketingTicketInput: { - name: "", - description: "Multi-tiered human-resource model", - }, }); // Handle the result @@ -849,27 +931,66 @@ actions: } run(); - - target: $["paths"]["/passthrough"]["post"] + - target: $["paths"]["/ats/candidates"]["post"] update: x-codeSamples: - lang: typescript - label: request + label: createAtsCandidate source: |- import { Panora } from "@panora/sdk"; - import { Method } from "@panora/sdk/models/components"; + import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.passthrough.request({ - integrationId: "", - linkedUserId: "", - vertical: "", - passThroughRequestDto: { - method: Method.Get, - path: "/dev", + const result = await panora.ats.candidates.create({ + xConnectionToken: "", + remoteData: false, + unifiedAtsCandidateInput: { + firstName: "Joe", + lastName: "Doe", + company: "Acme", + title: "Analyst", + locations: "New York", + isPrivate: false, + emailReachable: true, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + lastInteractionAt: new Date("2024-10-01T12:00:00Z"), + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + applications: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + tags: [ + "tag_1", + "tag_2", + ], + urls: [ + { + url: "mywebsite.com", + urlType: "WEBSITE", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660688899", + phoneType: PhoneType.Work, + }, + ], + emailAddresses: [ + { + emailAddress: "joedoe@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -878,22 +999,21 @@ actions: } run(); - - target: $["paths"]["/ats/candidates/{id}"]["get"] + - target: $["paths"]["/ats/scorecards"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsCandidate + label: listAtsScorecard source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.candidates.retrieve({ + const result = await panora.ats.scorecards.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -901,22 +1021,23 @@ actions: } run(); - - target: $["paths"]["/ats/offices/{id}"]["get"] + - target: $["paths"]["/ats/scorecards/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsOffice + label: retrieveAtsScorecard source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.offices.retrieve({ + const result = await panora.ats.scorecards.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -924,22 +1045,23 @@ actions: } run(); - - target: $["paths"]["/ats/scorecards/{id}"]["get"] + - target: $["paths"]["/accounting/journalentries/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsScorecard + label: retrieveAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.scorecards.retrieve({ + const result = await panora.accounting.journalentries.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -947,22 +1069,56 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets/{id}"]["get"] + - target: $["paths"]["/crm/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTicket + label: createCrmContact source: |- import { Panora } from "@panora/sdk"; + import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.tickets.retrieve({ + const result = await panora.crm.contacts.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedCrmContactInput: { + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Jena.Nienow28@yahoo.com", + emailAddressType: EmailAddressType.Personal, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "", + street2: "", + city: "Anytown", + state: "CA", + postalCode: "97398", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -970,22 +1126,21 @@ actions: } run(); - - target: $["paths"]["/hris/employments/{id}"]["get"] + - target: $["paths"]["/crm/stages"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployment + label: listCrmStages source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employments.retrieve({ + const result = await panora.crm.stages.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -993,20 +1148,20 @@ actions: } run(); - - target: $["paths"]["/hris/locations"]["get"] + - target: $["paths"]["/ats/activities"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisLocation + label: listAtsActivity source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.locations.list({ + const result = await panora.ats.activities.list({ xConnectionToken: "", }); @@ -1015,21 +1170,23 @@ actions: } run(); - - target: $["paths"]["/ats/jobs"]["get"] + - target: $["paths"]["/ticketing/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsJob + label: retrieveTicketingUser source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.jobs.list({ + const result = await panora.ticketing.users.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1037,20 +1194,20 @@ actions: } run(); - - target: $["paths"]["/ticketing/contacts"]["get"] + - target: $["paths"]["/crm/deals"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingContacts + label: listCrmDeals source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.contacts.list({ + const result = await panora.crm.deals.list({ xConnectionToken: "", }); @@ -1059,21 +1216,23 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries"]["get"] + - target: $["paths"]["/ats/candidates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingJournalEntry + label: retrieveAtsCandidate source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.journalentries.list({ + const result = await panora.ats.candidates.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1081,21 +1240,23 @@ actions: } run(); - - target: $["paths"]["/webhooks/{id}"]["put"] + - target: $["paths"]["/accounting/creditnotes/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: updateStatus + label: retrieveAccountingCreditNote source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.webhooks.updateStatus({ - id: "", + const result = await panora.accounting.creditnotes.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1103,22 +1264,21 @@ actions: } run(); - - target: $["paths"]["/ticketing/teams/{id}"]["get"] + - target: $["paths"]["/accounting/trackingcategories"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingTeam + label: listAccountingTrackingCategorys source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.teams.retrieve({ + const result = await panora.accounting.trackingcategories.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -1126,43 +1286,46 @@ actions: } run(); - - target: $["paths"]["/crm/users/{id}"]["get"] + - target: $["paths"]["/linked_users"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmUser + label: listLinkedUsers source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.users.retrieve({ - xConnectionToken: "", - id: "", - }); + const result = await panora.linkedUsers.list(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/hris/employments"]["get"] + - target: $["paths"]["/linked_users/{id}"]["get"] + update: + x-codeSamples: + - lang: typescript + label: retrieveLinkedUser + source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: \"\",\n});\n\nasync function run() {\n await panora.linkedUsers.id.retrieve({\n id: \"801f9ede-c698-4e66-a7fc-48d19eebaa4f\",\n });\n\n \n}\n\nrun();" + - target: $["paths"]["/hris/employees"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployment + label: listHrisEmployees source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employments.list({ + const result = await panora.hris.employees.list({ xConnectionToken: "", }); @@ -1171,22 +1334,25 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffbalances/{id}"]["get"] + - target: $["paths"]["/webhooks/verifyEvent"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimeoffbalance + label: verifyEvent source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.timeoffbalances.retrieve({ - xConnectionToken: "", - id: "", + const result = await panora.webhooks.verifyEvent({ + payload: { + "key": "", + }, + signature: "", + secret: "", }); // Handle the result @@ -1194,24 +1360,21 @@ actions: } run(); - - target: $["paths"]["/field_mappings/define"]["post"] + - target: $["paths"]["/hris/bankinfos"]["get"] update: x-codeSamples: - lang: typescript - label: definitions + label: listHrisBankInfo source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.fieldMappings.define.definitions({ - objectTypeOwner: "", - name: "", - description: "Universal heuristic matrices", - dataType: "decimal", + const result = await panora.hris.bankinfos.list({ + xConnectionToken: "", }); // Handle the result @@ -1219,22 +1382,21 @@ actions: } run(); - - target: $["paths"]["/hris/groups/{id}"]["get"] + - target: $["paths"]["/hris/employeepayrollruns"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisGroup + label: listHrisEmployeePayrollRun source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.groups.retrieve({ + const result = await panora.hris.employeepayrollruns.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -1242,22 +1404,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates"]["post"] + - target: $["paths"]["/marketingautomation/campaigns"]["post"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationTemplate + label: createMarketingautomationCampaign source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.templates.create({ + const result = await panora.marketingautomation.campaigns.create({ xConnectionToken: "", - unifiedMarketingautomationTemplateInput: {}, + remoteData: false, + unifiedMarketingautomationCampaignInput: {}, }); // Handle the result @@ -1265,21 +1428,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/users"]["get"] + - target: $["paths"]["/marketingautomation/messages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingUsers + label: retrieveMarketingautomationMessage source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.users.list({ + const result = await panora.marketingautomation.messages.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1287,22 +1452,21 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists"]["post"] + - target: $["paths"]["/webhooks/{id}"]["delete"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationList + label: delete source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.lists.create({ - xConnectionToken: "", - unifiedMarketingautomationListInput: {}, + const result = await panora.webhooks.delete({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -1310,20 +1474,20 @@ actions: } run(); - - target: $["paths"]["/ats/departments"]["get"] + - target: $["paths"]["/ticketing/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsDepartments + label: listTicketingAttachments source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.departments.list({ + const result = await panora.ticketing.attachments.list({ xConnectionToken: "", }); @@ -1332,20 +1496,20 @@ actions: } run(); - - target: $["paths"]["/accounting/addresses"]["get"] + - target: $["paths"]["/accounting/accounts"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAddress + label: listAccountingAccounts source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.addresses.list({ + const result = await panora.accounting.accounts.list({ xConnectionToken: "", }); @@ -1354,22 +1518,21 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments"]["post"] + - target: $["paths"]["/ticketing/tags"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingAttachment + label: listTicketingTags source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.attachments.create({ + const result = await panora.ticketing.tags.list({ xConnectionToken: "", - unifiedAccountingAttachmentInput: {}, }); // Handle the result @@ -1377,24 +1540,23 @@ actions: } run(); - - target: $["paths"]["/crm/companies"]["post"] + - target: $["paths"]["/ats/applications/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmCompany + label: retrieveAtsApplication source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.companies.create({ + const result = await panora.ats.applications.retrieve({ xConnectionToken: "", - unifiedCrmCompanyInput: { - name: "", - }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1402,22 +1564,21 @@ actions: } run(); - - target: $["paths"]["/hris/employees/{id}"]["get"] + - target: $["paths"]["/crm/engagements"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployee + label: listCrmEngagements source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employees.retrieve({ + const result = await panora.crm.engagements.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -1425,20 +1586,20 @@ actions: } run(); - - target: $["paths"]["/crm/companies"]["get"] + - target: $["paths"]["/marketingautomation/events"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmCompany + label: listMarketingAutomationEvents source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.companies.list({ + const result = await panora.marketingautomation.events.list({ xConnectionToken: "", }); @@ -1447,22 +1608,22 @@ actions: } run(); - - target: $["paths"]["/linked_users"]["post"] + - target: $["paths"]["/ats/eeocs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createLinkedUser + label: retrieveAtsEeocs source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.linkedUsers.create({ - linkedUserOriginId: "", - alias: "", + const result = await panora.ats.eeocs.retrieve({ + xConnectionToken: "", + id: "", }); // Handle the result @@ -1470,22 +1631,21 @@ actions: } run(); - - target: $["paths"]["/ats/departments/{id}"]["get"] + - target: $["paths"]["/ticketing/teams"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsDepartment + label: listTicketingTeams source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.departments.retrieve({ + const result = await panora.ticketing.teams.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -1493,21 +1653,22 @@ actions: } run(); - - target: $["paths"]["/ats/jobinterviewstages"]["get"] + - target: $["paths"]["/marketingautomation/lists"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsJobInterviewStage + label: createMarketingautomationList source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.jobinterviewstages.list({ + const result = await panora.marketingautomation.lists.create({ xConnectionToken: "", + unifiedMarketingautomationListInput: {}, }); // Handle the result @@ -1515,22 +1676,21 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts/{id}"]["get"] + - target: $["paths"]["/ats/departments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAccount + label: listAtsDepartments source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.accounts.retrieve({ + const result = await panora.ats.departments.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -1538,21 +1698,23 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders"]["get"] + - target: $["paths"]["/crm/companies/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageFolder + label: retrieveCrmCompany source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.folders.list({ + const result = await panora.crm.companies.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1560,21 +1722,22 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions"]["get"] + - target: $["paths"]["/linked_users"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationAction + label: createLinkedUser source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.actions.list({ - xConnectionToken: "", + const result = await panora.linkedUsers.create({ + linkedUserOriginId: "id_1", + alias: "acme", }); // Handle the result @@ -1582,22 +1745,23 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses"]["post"] + - target: $["paths"]["/hris/payrollruns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingExpense + label: retrieveHrisPayrollRun source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.expenses.create({ + const result = await panora.hris.payrollruns.retrieve({ xConnectionToken: "", - unifiedAccountingExpenseInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1605,44 +1769,43 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders"]["get"] + - target: $["paths"]["/webhooks"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPurchaseOrder + label: listWebhooks source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.purchaseorders.list({ - xConnectionToken: "", - }); + const result = await panora.webhooks.list(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/filestorage/drives/{id}"]["get"] + - target: $["paths"]["/ats/rejectreasons/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageDrive + label: retrieveAtsRejectReason source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.drives.retrieve({ + const result = await panora.ats.rejectreasons.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1650,21 +1813,23 @@ actions: } run(); - - target: $["paths"]["/linked_users/fromRemoteId"]["get"] + - target: $["paths"]["/ats/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: remoteId + label: retrieveAtsAttachment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.linkedUsers.fromremoteid.remoteId({ - remoteId: "", + const result = await panora.ats.attachments.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1672,21 +1837,23 @@ actions: } run(); - - target: $["paths"]["/hris/companies"]["get"] + - target: $["paths"]["/marketingautomation/campaigns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisCompanys + label: retrieveMarketingautomationCampaign source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.companies.list({ + const result = await panora.marketingautomation.campaigns.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1694,20 +1861,20 @@ actions: } run(); - - target: $["paths"]["/ats/scorecards"]["get"] + - target: $["paths"]["/marketingautomation/users"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsScorecard + label: listMarketingAutomationUsers source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.scorecards.list({ + const result = await panora.marketingautomation.users.list({ xConnectionToken: "", }); @@ -1716,21 +1883,23 @@ actions: } run(); - - target: $["paths"]["/filestorage/files"]["get"] + - target: $["paths"]["/accounting/accounts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listFilestorageFile + label: retrieveAccountingAccount source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.files.list({ + const result = await panora.accounting.accounts.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1738,21 +1907,21 @@ actions: } run(); - - target: $["paths"]["/crm/users"]["get"] + - target: $["paths"]["/webhooks/{id}"]["put"] update: x-codeSamples: - lang: typescript - label: listCrmUsers + label: updateStatus source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.users.list({ - xConnectionToken: "", + const result = await panora.webhooks.updateStatus({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -1760,20 +1929,20 @@ actions: } run(); - - target: $["paths"]["/accounting/trackingcategories"]["get"] + - target: $["paths"]["/accounting/balancesheets"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingTrackingCategorys + label: listAccountingBalanceSheets source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.trackingcategories.list({ + const result = await panora.accounting.balancesheets.list({ xConnectionToken: "", }); @@ -1782,22 +1951,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/accounts/{id}"]["get"] + - target: $["paths"]["/hris/dependents/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingAccount + label: retrieveHrisDependent source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.accounts.retrieve({ + const result = await panora.hris.dependents.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1805,20 +1975,20 @@ actions: } run(); - - target: $["paths"]["/crm/stages"]["get"] + - target: $["paths"]["/hris/groups"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmStages + label: listHrisGroups source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.stages.list({ + const result = await panora.hris.groups.list({ xConnectionToken: "", }); @@ -1827,20 +1997,20 @@ actions: } run(); - - target: $["paths"]["/accounting/payments"]["get"] + - target: $["paths"]["/ats/interviews"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPayment + label: listAtsInterview source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.payments.list({ + const result = await panora.ats.interviews.list({ xConnectionToken: "", }); @@ -1849,67 +2019,63 @@ actions: } run(); - - target: $["paths"]["/ats/interviews"]["get"] + - target: $["paths"]["/"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsInterview + label: hello source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.interviews.list({ - xConnectionToken: "", - }); + const result = await panora.hello(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/hris/bankinfos/{id}"]["get"] + - target: $["paths"]["/sync/resync"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisBankinfo + label: resync source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.bankinfos.retrieve({ - xConnectionToken: "", - id: "", - }); + const result = await panora.sync.resync(); // Handle the result console.log(result) } run(); - - target: $["paths"]["/hris/dependents/{id}"]["get"] + - target: $["paths"]["/ticketing/tickets/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisDependent + label: retrieveTicketingTicket source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.dependents.retrieve({ + const result = await panora.ticketing.tickets.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1917,20 +2083,20 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/events"]["get"] + - target: $["paths"]["/ticketing/accounts"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingAutomationEvents + label: listTicketingAccount source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.events.list({ + const result = await panora.ticketing.accounts.list({ xConnectionToken: "", }); @@ -1939,21 +2105,23 @@ actions: } run(); - - target: $["paths"]["/accounting/phonenumbers"]["get"] + - target: $["paths"]["/filestorage/drives/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingPhonenumber + label: retrieveFilestorageDrive source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.phonenumbers.list({ + const result = await panora.filestorage.drives.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -1961,22 +2129,21 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders/{id}"]["get"] + - target: $["paths"]["/filestorage/files"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageFolder + label: listFilestorageFile source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.folders.retrieve({ + const result = await panora.filestorage.files.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -1984,22 +2151,33 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations"]["post"] + - target: $["paths"]["/crm/deals"]["post"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationAutomation + label: createCrmDeal source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.automations.create({ + const result = await panora.crm.deals.create({ xConnectionToken: "", - unifiedMarketingautomationAutomationInput: {}, + unifiedCrmDealInput: { + name: "Huge Contract with Acme", + description: "Contract with Sales Operations Team", + amount: 1000, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + stageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2007,24 +2185,21 @@ actions: } run(); - - target: $["paths"]["/crm/engagements"]["post"] + - target: $["paths"]["/ats/offers"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmEngagement + label: listAtsOffer source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.engagements.create({ + const result = await panora.ats.offers.list({ xConnectionToken: "", - unifiedCrmEngagementInput: { - type: "", - }, }); // Handle the result @@ -2032,22 +2207,23 @@ actions: } run(); - - target: $["paths"]["/crm/stages/{id}"]["get"] + - target: $["paths"]["/accounting/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCrmStage + label: createAccountingAttachment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.stages.retrieve({ + const result = await panora.accounting.attachments.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedAccountingAttachmentInput: {}, }); // Handle the result @@ -2055,20 +2231,20 @@ actions: } run(); - - target: $["paths"]["/ats/tags/{id}"]["get"] + - target: $["paths"]["/ticketing/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsTag + label: retrieveTicketingContact source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.tags.retrieve({ + const result = await panora.ticketing.contacts.retrieve({ xConnectionToken: "", id: "", }); @@ -2078,22 +2254,23 @@ actions: } run(); - - target: $["paths"]["/ats/activities"]["post"] + - target: $["paths"]["/ticketing/attachments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsActivity + label: retrieveTicketingAttachment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.activities.create({ + const result = await panora.ticketing.attachments.retrieve({ xConnectionToken: "", - unifiedAtsActivityInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2101,22 +2278,21 @@ actions: } run(); - - target: $["paths"]["/ats/users/{id}"]["get"] + - target: $["paths"]["/crm/tasks"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsUser + label: listCrmTask source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.users.retrieve({ + const result = await panora.crm.tasks.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2124,21 +2300,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/tags"]["get"] + - target: $["paths"]["/ticketing/collections/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTags + label: retrieveCollection source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.tags.list({ + const result = await panora.ticketing.collections.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2146,22 +2324,23 @@ actions: } run(); - - target: $["paths"]["/accounting/cashflowstatements/{id}"]["get"] + - target: $["paths"]["/marketingautomation/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCashflowStatement + label: retrieveMarketingAutomationContact source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.cashflowstatements.retrieve({ + const result = await panora.marketingautomation.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2169,20 +2348,20 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts"]["get"] + - target: $["paths"]["/marketingautomation/emails"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingContacts + label: listMarketingautomationEmails source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.contacts.list({ + const result = await panora.marketingautomation.emails.list({ xConnectionToken: "", }); @@ -2191,22 +2370,23 @@ actions: } run(); - - target: $["paths"]["/accounting/payments/{id}"]["get"] + - target: $["paths"]["/crm/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPayment + label: retrieveCrmUser source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.payments.retrieve({ + const result = await panora.crm.users.retrieve({ xConnectionToken: "", - id: "", + id: "b008e199-eda9-4629-bd41-a01b6195864a", + remoteData: true, }); // Handle the result @@ -2214,22 +2394,23 @@ actions: } run(); - - target: $["paths"]["/crm/deals/{id}"]["get"] + - target: $["paths"]["/filestorage/files/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmDeal + label: retrieveFilestorageFile source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.deals.retrieve({ + const result = await panora.filestorage.files.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2237,21 +2418,23 @@ actions: } run(); - - target: $["paths"]["/accounting/creditnotes"]["get"] + - target: $["paths"]["/crm/stages/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCreditNote + label: retrieveCrmStage source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.creditnotes.list({ + const result = await panora.crm.stages.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2259,21 +2442,23 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments"]["get"] + - target: $["paths"]["/hris/employments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAttachments + label: retrieveHrisEmployment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.attachments.list({ + const result = await panora.hris.employments.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2281,22 +2466,23 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices"]["post"] + - target: $["paths"]["/marketingautomation/templates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingInvoice + label: retrieveMarketingautomationTemplate source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.invoices.create({ + const result = await panora.marketingautomation.templates.retrieve({ xConnectionToken: "", - unifiedAccountingInvoiceInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2304,22 +2490,21 @@ actions: } run(); - - target: $["paths"]["/accounting/phonenumbers/{id}"]["get"] + - target: $["paths"]["/ticketing/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPhonenumber + label: listTicketingContacts source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.phonenumbers.retrieve({ + const result = await panora.ticketing.contacts.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2327,21 +2512,22 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments"]["get"] + - target: $["paths"]["/ticketing/comments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingAttachments + label: retrieveTicketingComment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.attachments.list({ + const result = await panora.ticketing.comments.retrieve({ xConnectionToken: "", + id: "", }); // Handle the result @@ -2349,26 +2535,20 @@ actions: } run(); - - target: $["paths"]["/sync/status/{vertical}"]["get"] - update: - x-codeSamples: - - lang: typescript - label: status - source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n apiKey: process.env.API_KEY,\n});\n\nasync function run() {\n await panora.sync.status({\n vertical: \"\",\n });\n\n \n}\n\nrun();" - - target: $["paths"]["/accounting/balancesheets"]["get"] + - target: $["paths"]["/hris/payrollruns"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingBalanceSheets + label: listHrisPayrollRuns source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.balancesheets.list({ + const result = await panora.hris.payrollruns.list({ xConnectionToken: "", }); @@ -2377,22 +2557,21 @@ actions: } run(); - - target: $["paths"]["/accounting/purchaseorders/{id}"]["get"] + - target: $["paths"]["/hris/timeoffs"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingPurchaseOrder + label: listHrisTimeoffs source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.purchaseorders.retrieve({ + const result = await panora.hris.timeoffs.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2400,21 +2579,23 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses"]["get"] + - target: $["paths"]["/accounting/purchaseorders"]["post"] update: x-codeSamples: - lang: typescript - label: listAccountingExpense + label: createAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.expenses.list({ + const result = await panora.accounting.purchaseorders.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingPurchaseorderInput: {}, }); // Handle the result @@ -2422,21 +2603,23 @@ actions: } run(); - - target: $["paths"]["/ats/attachments"]["get"] + - target: $["paths"]["/hris/employees/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsAttachment + label: retrieveHrisEmployee source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.attachments.list({ + const result = await panora.hris.employees.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2444,22 +2627,23 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts/{id}"]["get"] + - target: $["paths"]["/ats/jobs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingContact + label: retrieveAtsJob source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.contacts.retrieve({ + const result = await panora.ats.jobs.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2467,22 +2651,21 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries"]["post"] + - target: $["paths"]["/hris/companies"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingJournalEntry + label: listHrisCompanies source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.journalentries.create({ + const result = await panora.hris.companies.list({ xConnectionToken: "", - unifiedAccountingJournalentryInput: {}, }); // Handle the result @@ -2490,22 +2673,21 @@ actions: } run(); - - target: $["paths"]["/accounting/trackingcategories/{id}"]["get"] + - target: $["paths"]["/filestorage/users"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingTrackingCategory + label: listFilestorageUsers source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.trackingcategories.retrieve({ + const result = await panora.filestorage.users.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2513,22 +2695,21 @@ actions: } run(); - - target: $["paths"]["/hris/locations/{id}"]["get"] + - target: $["paths"]["/crm/users"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisLocation + label: listCrmUsers source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.locations.retrieve({ + const result = await panora.crm.users.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2536,22 +2717,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns/{id}"]["get"] + - target: $["paths"]["/marketingautomation/actions"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationCampaign + label: createMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.campaigns.retrieve({ + const result = await panora.marketingautomation.actions.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedMarketingautomationActionInput: {}, }); // Handle the result @@ -2559,22 +2741,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/emails/{id}"]["get"] + - target: $["paths"]["/filestorage/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationEmail + label: retrieveFilestorageUser source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.emails.retrieve({ + const result = await panora.filestorage.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2582,22 +2765,21 @@ actions: } run(); - - target: $["paths"]["/ats/interviews/{id}"]["get"] + - target: $["paths"]["/accounting/payments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsInterview + label: listAccountingPayment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.interviews.retrieve({ + const result = await panora.accounting.payments.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2605,20 +2787,20 @@ actions: } run(); - - target: $["paths"]["/accounting/taxrates"]["get"] + - target: $["paths"]["/filestorage/groups"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingTaxRate + label: listFilestorageGroup source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.taxrates.list({ + const result = await panora.filestorage.groups.list({ xConnectionToken: "", }); @@ -2627,31 +2809,34 @@ actions: } run(); - - target: $["paths"]["/filestorage/folders"]["post"] + - target: $["paths"]["/ats/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: createFilestorageFolder + label: createAtsAttachment source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.folders.create({ + const result = await panora.ats.attachments.create({ xConnectionToken: "", remoteData: false, - unifiedFilestorageFolderInput: { - name: "", - size: "", - folderUrl: "", - description: "Multi-tiered human-resource model", - driveId: "", - parentFolderId: "", - sharedLink: "", - permission: "", + unifiedAtsAttachmentInput: { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: UnifiedAtsAttachmentInputAttachmentType.Resume, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -2660,22 +2845,23 @@ actions: } run(); - - target: $["paths"]["/accounting/journalentries/{id}"]["get"] + - target: $["paths"]["/accounting/purchaseorders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingJournalEntry + label: retrieveAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.journalentries.retrieve({ + const result = await panora.accounting.purchaseorders.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2683,21 +2869,35 @@ actions: } run(); - - target: $["paths"]["/filestorage/drives"]["get"] + - target: $["paths"]["/filestorage/files"]["post"] update: x-codeSamples: - lang: typescript - label: listFilestorageDrives + label: createFilestorageFile source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.drives.list({ + const result = await panora.filestorage.files.create({ xConnectionToken: "", + remoteData: false, + unifiedFilestorageFileInput: { + name: "my_paris_photo.png", + fileUrl: "https://example.com/my_paris_photo.png", + mimeType: "application/pdf", + size: "1024", + folderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2705,22 +2905,21 @@ actions: } run(); - - target: $["paths"]["/ats/offers/{id}"]["get"] + - target: $["paths"]["/ats/eeocs"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsOffer + label: listAtsEeocs source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.offers.retrieve({ + const result = await panora.ats.eeocs.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2728,20 +2927,20 @@ actions: } run(); - - target: $["paths"]["/ats/offices"]["get"] + - target: $["paths"]["/accounting/creditnotes"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsOffice + label: listAccountingCreditNote source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.offices.list({ + const result = await panora.accounting.creditnotes.list({ xConnectionToken: "", }); @@ -2750,31 +2949,23 @@ actions: } run(); - - target: $["paths"]["/filestorage/files"]["post"] + - target: $["paths"]["/marketingautomation/lists/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createFilestorageFile + label: retrieveMarketingautomationList source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.files.create({ + const result = await panora.marketingautomation.lists.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", remoteData: false, - unifiedFilestorageFileInput: { - name: "", - fileUrl: "", - mimeType: "", - size: "", - folderId: "", - permission: "", - sharedLink: "", - }, }); // Handle the result @@ -2782,21 +2973,40 @@ actions: } run(); - - target: $["paths"]["/hris/employerbenefits"]["get"] + - target: $["paths"]["/ats/applications"]["post"] update: x-codeSamples: - lang: typescript - label: listHrisEmployerBenefit + label: createAtsApplication source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employerbenefits.list({ + const result = await panora.ats.applications.create({ xConnectionToken: "", + remoteData: false, + unifiedAtsApplicationInput: { + appliedAt: new Date("2024-10-01T12:00:00Z"), + rejectedAt: new Date("2024-10-01T12:00:00Z"), + offers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "12345678-1234-1234-1234-123456789012", + ], + source: "Source Name", + creditedTo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currentStage: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + rejectReason: "Candidate not experienced enough", + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -2804,26 +3014,23 @@ actions: } run(); - - target: $["paths"]["/crm/deals"]["post"] + - target: $["paths"]["/hris/employeepayrollruns/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmDeal + label: retrieveHrisEmployeePayrollRun source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.deals.create({ + const result = await panora.hris.employeepayrollruns.retrieve({ xConnectionToken: "", - unifiedCrmDealInput: { - name: "", - description: "Multi-tiered human-resource model", - amount: 8592.13, - }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2831,22 +3038,21 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations/{id}"]["get"] + - target: $["paths"]["/hris/employments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationAutomation + label: listHrisEmployments source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.automations.retrieve({ + const result = await panora.hris.employments.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2854,20 +3060,20 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists"]["get"] + - target: $["paths"]["/accounting/taxrates"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationLists + label: listAccountingTaxRate source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.lists.list({ + const result = await panora.accounting.taxrates.list({ xConnectionToken: "", }); @@ -2876,24 +3082,24 @@ actions: } run(); - - target: $["paths"]["/ticketing/comments"]["post"] + - target: $["paths"]["/linked_users/batch"]["post"] update: x-codeSamples: - lang: typescript - label: createTicketingComment + label: importBatch source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.comments.create({ - xConnectionToken: "", - unifiedTicketingCommentInput: { - body: "", - }, + const result = await panora.linkedUsers.batch.importBatch({ + linkedUserOriginIds: [ + "id_1", + ], + alias: "acme", }); // Handle the result @@ -2901,22 +3107,22 @@ actions: } run(); - - target: $["paths"]["/hris/benefits/{id}"]["get"] + - target: $["paths"]["/hris/timeoffs"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveHrisBenefit + label: createHrisTimeoff source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.benefits.retrieve({ + const result = await panora.hris.timeoffs.create({ xConnectionToken: "", - id: "", + unifiedHrisTimeoffInput: {}, }); // Handle the result @@ -2924,22 +3130,21 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates/{id}"]["get"] + - target: $["paths"]["/ats/jobinterviewstages"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationTemplate + label: listAtsJobInterviewStage source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.templates.retrieve({ + const result = await panora.ats.jobinterviewstages.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -2947,22 +3152,23 @@ actions: } run(); - - target: $["paths"]["/accounting/expenses/{id}"]["get"] + - target: $["paths"]["/accounting/balancesheets/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingExpense + label: retrieveAccountingBalanceSheet source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.expenses.retrieve({ + const result = await panora.accounting.balancesheets.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -2970,22 +3176,34 @@ actions: } run(); - - target: $["paths"]["/ticketing/collections/{id}"]["get"] + - target: $["paths"]["/ticketing/comments"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCollection + label: createTicketingComment source: |- import { Panora } from "@panora/sdk"; + import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.collections.retrieve({ + const result = await panora.ticketing.comments.create({ xConnectionToken: "", - id: "", + unifiedTicketingCommentInput: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingCommentInputCreatorType.User, + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + }, }); // Handle the result @@ -2993,22 +3211,21 @@ actions: } run(); - - target: $["paths"]["/accounting/balancesheets/{id}"]["get"] + - target: $["paths"]["/marketingautomation/messages"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingBalanceSheet + label: listMarketingautomationMessages source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.balancesheets.retrieve({ + const result = await panora.marketingautomation.messages.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -3016,22 +3233,23 @@ actions: } run(); - - target: $["paths"]["/accounting/contacts"]["post"] + - target: $["paths"]["/accounting/expenses/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAccountingContact + label: retrieveAccountingExpense source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.contacts.create({ + const result = await panora.accounting.expenses.retrieve({ xConnectionToken: "", - unifiedAccountingContactInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3039,22 +3257,23 @@ actions: } run(); - - target: $["paths"]["/accounting/items/{id}"]["get"] + - target: $["paths"]["/crm/tasks/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingItem + label: retrieveCrmTask source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.items.retrieve({ + const result = await panora.crm.tasks.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3062,21 +3281,21 @@ actions: } run(); - - target: $["paths"]["/webhooks/{id}"]["delete"] + - target: $["paths"]["/marketingautomation/lists"]["get"] update: x-codeSamples: - lang: typescript - label: delete + label: listMarketingautomationLists source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.webhooks.delete({ - id: "", + const result = await panora.marketingautomation.lists.list({ + xConnectionToken: "", }); // Handle the result @@ -3084,26 +3303,21 @@ actions: } run(); - - target: $["paths"]["/crm/tasks"]["post"] + - target: $["paths"]["/accounting/cashflowstatements"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmTask + label: listAccountingCashflowStatement source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.tasks.create({ + const result = await panora.accounting.cashflowstatements.list({ xConnectionToken: "", - unifiedCrmTaskInput: { - subject: "", - content: "", - status: "", - }, }); // Handle the result @@ -3111,22 +3325,23 @@ actions: } run(); - - target: $["paths"]["/ats/applications"]["post"] + - target: $["paths"]["/accounting/payments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsApplication + label: retrieveAccountingPayment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.applications.create({ + const result = await panora.accounting.payments.retrieve({ xConnectionToken: "", - unifiedAtsApplicationInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3134,22 +3349,36 @@ actions: } run(); - - target: $["paths"]["/accounting/payments"]["post"] + - target: $["paths"]["/crm/tasks"]["post"] update: x-codeSamples: - lang: typescript - label: createAccountingPayment + label: createCrmTask source: |- import { Panora } from "@panora/sdk"; + import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.payments.create({ + const result = await panora.crm.tasks.create({ xConnectionToken: "", - unifiedAccountingPaymentInput: {}, + unifiedCrmTaskInput: { + subject: "Answer customers", + content: "Prepare email campaign", + status: UnifiedCrmTaskInputStatus.Pending, + dueDate: "2024-10-01T12:00:00Z", + finishedDate: "2024-10-01T12:00:00Z", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -3157,20 +3386,20 @@ actions: } run(); - - target: $["paths"]["/accounting/transactions"]["get"] + - target: $["paths"]["/hris/timeoffbalances"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingTransaction + label: listHrisTimeoffbalances source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.transactions.list({ + const result = await panora.hris.timeoffbalances.list({ xConnectionToken: "", }); @@ -3179,21 +3408,23 @@ actions: } run(); - - target: $["paths"]["/hris/dependents"]["get"] + - target: $["paths"]["/marketingautomation/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: listHrisDependents + label: createMarketingAutomationContact source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.dependents.list({ + const result = await panora.marketingautomation.contacts.create({ xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationContactInput: {}, }); // Handle the result @@ -3201,22 +3432,21 @@ actions: } run(); - - target: $["paths"]["/ats/interviews"]["post"] + - target: $["paths"]["/crm/notes"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsInterview + label: listCrmNote source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.interviews.create({ + const result = await panora.crm.notes.list({ xConnectionToken: "", - unifiedAtsInterviewInput: {}, }); // Handle the result @@ -3224,22 +3454,41 @@ actions: } run(); - - target: $["paths"]["/accounting/addresses/{id}"]["get"] + - target: $["paths"]["/ats/interviews"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAddress + label: createAtsInterview source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.addresses.retrieve({ + const result = await panora.ats.interviews.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedAtsInterviewInput: { + status: UnifiedAtsInterviewInputStatus.Scheduled, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobInterviewStageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + organizedBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + interviewers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + location: "San Francisco", + startAt: new Date("2024-10-01T12:00:00Z"), + endAt: new Date("2024-10-01T12:00:00Z"), + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -3247,21 +3496,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/teams"]["get"] + - target: $["paths"]["/accounting/journalentries"]["post"] update: x-codeSamples: - lang: typescript - label: listTicketingTeams + label: createAccountingJournalEntry source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.teams.list({ + const result = await panora.accounting.journalentries.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingJournalentryInput: {}, }); // Handle the result @@ -3269,22 +3520,23 @@ actions: } run(); - - target: $["paths"]["/hris/employeepayrollruns/{id}"]["get"] + - target: $["paths"]["/accounting/vendorcredits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployeePayrollRun + label: retrieveAccountingVendorCredit source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employeepayrollruns.retrieve({ + const result = await panora.accounting.vendorcredits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3292,21 +3544,23 @@ actions: } run(); - - target: $["paths"]["/hris/employeepayrollruns"]["get"] + - target: $["paths"]["/filestorage/folders/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployeePayrollRun + label: retrieveFilestorageFolder source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employeepayrollruns.list({ + const result = await panora.filestorage.folders.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3314,22 +3568,21 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices/{id}"]["get"] + - target: $["paths"]["/crm/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingInvoice + label: listCrmContacts source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.invoices.retrieve({ + const result = await panora.crm.contacts.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -3337,27 +3590,23 @@ actions: } run(); - - target: $["paths"]["/field_mappings"]["post"] + - target: $["paths"]["/crm/deals/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: defineCustomField + label: retrieveCrmDeal source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.fieldMappings.defineCustomField({ - objectTypeOwner: "", - name: "", - description: "Balanced multimedia policy", - dataType: "point", - sourceCustomFieldId: "", - sourceProvider: "", - linkedUserId: "", + const result = await panora.crm.deals.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3365,22 +3614,21 @@ actions: } run(); - - target: $["paths"]["/accounting/attachments/{id}"]["get"] + - target: $["paths"]["/hris/paygroups"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingAttachment + label: listHrisPaygroups source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.attachments.retrieve({ + const result = await panora.hris.paygroups.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -3388,25 +3636,21 @@ actions: } run(); - - target: $["paths"]["/webhooks/verifyEvent"]["post"] + - target: $["paths"]["/marketingautomation/contacts"]["get"] update: x-codeSamples: - lang: typescript - label: verifyEvent + label: listMarketingAutomationContacts source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.webhooks.verifyEvent({ - payload: { - "key": "", - }, - signature: "", - secret: "", + const result = await panora.marketingautomation.contacts.list({ + xConnectionToken: "", }); // Handle the result @@ -3414,22 +3658,23 @@ actions: } run(); - - target: $["paths"]["/ats/rejectreasons/{id}"]["get"] + - target: $["paths"]["/accounting/contacts/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsRejectReason + label: retrieveAccountingContact source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.rejectreasons.retrieve({ + const result = await panora.accounting.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3437,21 +3682,23 @@ actions: } run(); - - target: $["paths"]["/hris/groups"]["get"] + - target: $["paths"]["/accounting/addresses/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisGroup + label: retrieveAccountingAddress source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.groups.list({ + const result = await panora.accounting.addresses.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3459,22 +3706,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/campaigns"]["post"] + - target: $["paths"]["/hris/benefits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingautomationCampaign + label: retrieveHrisBenefit source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.campaigns.create({ + const result = await panora.hris.benefits.retrieve({ xConnectionToken: "", - unifiedMarketingautomationCampaignInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3482,21 +3730,23 @@ actions: } run(); - - target: $["paths"]["/accounting/incomestatements"]["get"] + - target: $["paths"]["/hris/timeoffs/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingIncomeStatement + label: retrieveHrisTimeoff source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.incomestatements.list({ + const result = await panora.hris.timeoffs.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3504,20 +3754,20 @@ actions: } run(); - - target: $["paths"]["/ticketing/accounts"]["get"] + - target: $["paths"]["/ats/jobs"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingAccount + label: listAtsJob source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.accounts.list({ + const result = await panora.ats.jobs.list({ xConnectionToken: "", }); @@ -3526,20 +3776,20 @@ actions: } run(); - - target: $["paths"]["/ticketing/collections"]["get"] + - target: $["paths"]["/ats/rejectreasons"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingCollections + label: listAtsRejectReasons source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.collections.list({ + const result = await panora.ats.rejectreasons.list({ xConnectionToken: "", }); @@ -3548,21 +3798,23 @@ actions: } run(); - - target: $["paths"]["/crm/deals"]["get"] + - target: $["paths"]["/accounting/accounts"]["post"] update: x-codeSamples: - lang: typescript - label: listCrmDeals + label: createAccountingAccount source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.deals.list({ + const result = await panora.accounting.accounts.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingAccountInput: {}, }); // Handle the result @@ -3570,22 +3822,21 @@ actions: } run(); - - target: $["paths"]["/accounting/creditnotes/{id}"]["get"] + - target: $["paths"]["/ticketing/collections"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingCreditNote + label: listTicketingCollections source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.creditnotes.retrieve({ + const result = await panora.ticketing.collections.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -3593,24 +3844,34 @@ actions: } run(); - - target: $["paths"]["/webhooks"]["post"] + - target: $["paths"]["/passthrough"]["post"] update: x-codeSamples: - lang: typescript - label: createWebhookPublic + label: request source: |- import { Panora } from "@panora/sdk"; + import { Method } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.webhooks.create({ - url: "http://limp-pastry.org", - scope: [ - "", - ], + const result = await panora.passthrough.request({ + integrationId: "", + linkedUserId: "", + vertical: "", + passThroughRequestDto: { + method: Method.Get, + path: "/dev", + data: { + "key": "", + }, + headers: { + "key": "", + }, + }, }); // Handle the result @@ -3618,21 +3879,23 @@ actions: } run(); - - target: $["paths"]["/filestorage/groups"]["get"] + - target: $["paths"]["/marketingautomation/automations"]["post"] update: x-codeSamples: - lang: typescript - label: listFilestorageGroup + label: createMarketingautomationAutomation source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.groups.list({ + const result = await panora.marketingautomation.automations.create({ xConnectionToken: "", + remoteData: false, + unifiedMarketingautomationAutomationInput: {}, }); // Handle the result @@ -3640,22 +3903,23 @@ actions: } run(); - - target: $["paths"]["/filestorage/users/{id}"]["get"] + - target: $["paths"]["/marketingautomation/users/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageUser + label: retrieveMarketingAutomationUser source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.users.retrieve({ + const result = await panora.marketingautomation.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3663,25 +3927,23 @@ actions: } run(); - - target: $["paths"]["/crm/contacts"]["post"] + - target: $["paths"]["/ats/departments/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createCrmContact + label: retrieveAtsDepartment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.contacts.create({ + const result = await panora.ats.departments.retrieve({ xConnectionToken: "", - unifiedCrmContactInput: { - firstName: "Jed", - lastName: "Kuhn", - }, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3689,22 +3951,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/messages/{id}"]["get"] + - target: $["paths"]["/accounting/transactions/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationMessage + label: retrieveAccountingTransaction source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.messages.retrieve({ + const result = await panora.accounting.transactions.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3712,21 +3975,23 @@ actions: } run(); - - target: $["paths"]["/ats/applications"]["get"] + - target: $["paths"]["/hris/groups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsApplication + label: retrieveHrisGroup source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.applications.list({ + const result = await panora.hris.groups.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3734,21 +3999,36 @@ actions: } run(); - - target: $["paths"]["/ats/candidates"]["get"] + - target: $["paths"]["/filestorage/folders"]["post"] update: x-codeSamples: - lang: typescript - label: listAtsCandidate + label: createFilestorageFolder source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.candidates.list({ + const result = await panora.filestorage.folders.create({ xConnectionToken: "", + remoteData: false, + unifiedFilestorageFolderInput: { + name: "school", + size: "2048", + folderUrl: "https://example.com/school", + description: "All things school related", + driveId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + parentFolderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -3756,21 +4036,43 @@ actions: } run(); - - target: $["paths"]["/ats/tags"]["get"] + - target: $["paths"]["/health"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsTags + label: health source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.tags.list({ + const result = await panora.health(); + + // Handle the result + console.log(result) + } + + run(); + - target: $["paths"]["/marketingautomation/events/{id}"]["get"] + update: + x-codeSamples: + - lang: typescript + label: retrieveMarketingautomationEvent + source: |- + import { Panora } from "@panora/sdk"; + + const panora = new Panora({ + apiKey: "", + }); + + async function run() { + const result = await panora.marketingautomation.events.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3778,21 +4080,23 @@ actions: } run(); - - target: $["paths"]["/accounting/accounts"]["get"] + - target: $["paths"]["/accounting/phonenumbers/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingAccounts + label: retrieveAccountingPhonenumber source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.accounts.list({ + const result = await panora.accounting.phonenumbers.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3800,41 +4104,45 @@ actions: } run(); - - target: $["paths"]["/"]["get"] + - target: $["paths"]["/filestorage/folders"]["get"] update: x-codeSamples: - lang: typescript - label: hello + label: listFilestorageFolder source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hello(); + const result = await panora.filestorage.folders.list({ + xConnectionToken: "", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/accounting/items"]["get"] + - target: $["paths"]["/ticketing/tags/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingItem + label: retrieveTicketingTag source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.items.list({ + const result = await panora.ticketing.tags.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3842,22 +4150,23 @@ actions: } run(); - - target: $["paths"]["/ticketing/users/{id}"]["get"] + - target: $["paths"]["/marketingautomation/automations/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingUser + label: retrieveMarketingautomationAutomation source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.users.retrieve({ + const result = await panora.marketingautomation.automations.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3865,22 +4174,21 @@ actions: } run(); - - target: $["paths"]["/crm/engagements/{id}"]["get"] + - target: $["paths"]["/ats/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmEngagement + label: listAtsAttachment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.engagements.retrieve({ + const result = await panora.ats.attachments.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -3888,22 +4196,23 @@ actions: } run(); - - target: $["paths"]["/filestorage/groups/{id}"]["get"] + - target: $["paths"]["/accounting/items/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageGroup + label: retrieveAccountingItem source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.groups.retrieve({ + const result = await panora.accounting.items.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3911,21 +4220,23 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffbalances"]["get"] + - target: $["paths"]["/accounting/taxrates/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisTimeoffbalance + label: retrieveAccountingTaxRate source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.timeoffbalances.list({ + const result = await panora.accounting.taxrates.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3933,22 +4244,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/events/{id}"]["get"] + - target: $["paths"]["/crm/notes/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationEvent + label: retrieveCrmNote source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.events.retrieve({ + const result = await panora.crm.notes.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -3956,20 +4268,20 @@ actions: } run(); - - target: $["paths"]["/accounting/invoices"]["get"] + - target: $["paths"]["/hris/locations"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingInvoice + label: listHrisLocations source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.invoices.list({ + const result = await panora.hris.locations.list({ xConnectionToken: "", }); @@ -3978,21 +4290,33 @@ actions: } run(); - - target: $["paths"]["/linked_users/single"]["get"] + - target: $["paths"]["/crm/notes"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveLinkedUser + label: createCrmNote source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.linkedUsers.single.retrieve({ - id: "", + const result = await panora.crm.notes.create({ + xConnectionToken: "", + remoteData: false, + unifiedCrmNoteInput: { + content: "My notes taken during the meeting", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4000,21 +4324,23 @@ actions: } run(); - - target: $["paths"]["/hris/employees"]["get"] + - target: $["paths"]["/hris/bankinfos/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisEmployee + label: retrieveHrisBankInfo source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employees.list({ + const result = await panora.hris.bankinfos.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4022,20 +4348,20 @@ actions: } run(); - - target: $["paths"]["/ticketing/tickets"]["get"] + - target: $["paths"]["/ats/applications"]["get"] update: x-codeSamples: - lang: typescript - label: listTicketingTicket + label: listAtsApplication source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.tickets.list({ + const result = await panora.ats.applications.list({ xConnectionToken: "", }); @@ -4044,22 +4370,67 @@ actions: } run(); - - target: $["paths"]["/crm/companies/{id}"]["get"] + - target: $["paths"]["/ticketing/tickets"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveCrmCompany + label: createTicketingTicket source: |- import { Panora } from "@panora/sdk"; + import { + UnifiedTicketingTicketInputCreatorType, + UnifiedTicketingTicketInputPriority, + UnifiedTicketingTicketInputStatus, + UnifiedTicketingTicketInputType, + } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.companies.retrieve({ + const result = await panora.ticketing.tickets.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedTicketingTicketInput: { + name: "Customer Service Inquiry", + status: UnifiedTicketingTicketInputStatus.Open, + description: "Help customer", + dueDate: new Date("2024-10-01T12:00:00Z"), + type: UnifiedTicketingTicketInputType.Bug, + parentTicket: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + collections: "[\"801f9ede-c698-4e66-a7fc-48d19eebaa4f\"]", + tags: [ + "my_tag", + "urgent_tag", + ], + completedAt: new Date("2024-10-01T12:00:00Z"), + priority: UnifiedTicketingTicketInputPriority.High, + assignedTo: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + comment: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketInputCreatorType.User, + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + }, + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4067,20 +4438,20 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/automations"]["get"] + - target: $["paths"]["/ats/offices"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationAutomation + label: listAtsOffice source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.automations.list({ + const result = await panora.ats.offices.list({ xConnectionToken: "", }); @@ -4089,22 +4460,21 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/contacts/{id}"]["get"] + - target: $["paths"]["/accounting/companyinfos"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingAutomationContact + label: listAccountingCompanyInfos source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.contacts.retrieve({ + const result = await panora.accounting.companyinfos.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4112,20 +4482,20 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/templates"]["get"] + - target: $["paths"]["/ticketing/comments"]["get"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationTemplates + label: listTicketingComments source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.templates.list({ + const result = await panora.ticketing.comments.list({ xConnectionToken: "", }); @@ -4134,22 +4504,22 @@ actions: } run(); - - target: $["paths"]["/accounting/incomestatements/{id}"]["get"] + - target: $["paths"]["/hris/employees"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingIncomeStatement + label: createHrisEmployee source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.incomestatements.retrieve({ + const result = await panora.hris.employees.create({ xConnectionToken: "", - id: "", + unifiedHrisEmployeeInput: {}, }); // Handle the result @@ -4157,22 +4527,21 @@ actions: } run(); - - target: $["paths"]["/accounting/vendorcredits/{id}"]["get"] + - target: $["paths"]["/accounting/incomestatements"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAccountingVendorCredit + label: listAccountingIncomeStatement source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.vendorcredits.retrieve({ + const result = await panora.accounting.incomestatements.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4180,22 +4549,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/actions/{id}"]["get"] + - target: $["paths"]["/accounting/incomestatements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationAction + label: retrieveAccountingIncomeStatement source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.actions.retrieve({ + const result = await panora.accounting.incomestatements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4203,22 +4573,23 @@ actions: } run(); - - target: $["paths"]["/hris/employees"]["post"] + - target: $["paths"]["/filestorage/groups/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createHrisEmployee + label: retrieveFilestorageGroup source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employees.create({ + const result = await panora.filestorage.groups.retrieve({ xConnectionToken: "", - unifiedHrisEmployeeInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4226,22 +4597,21 @@ actions: } run(); - - target: $["paths"]["/filestorage/files/{id}"]["get"] + - target: $["paths"]["/crm/companies"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveFilestorageFile + label: listCrmCompany source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.filestorage.files.retrieve({ + const result = await panora.crm.companies.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4249,22 +4619,21 @@ actions: } run(); - - target: $["paths"]["/crm/contacts/{id}"]["get"] + - target: $["paths"]["/accounting/expenses"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmContact + label: listAccountingExpense source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.contacts.retrieve({ + const result = await panora.accounting.expenses.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4272,20 +4641,20 @@ actions: } run(); - - target: $["paths"]["/crm/engagements"]["get"] + - target: $["paths"]["/marketingautomation/actions"]["get"] update: x-codeSamples: - lang: typescript - label: listCrmEngagements + label: listMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.engagements.list({ + const result = await panora.marketingautomation.actions.list({ xConnectionToken: "", }); @@ -4294,20 +4663,20 @@ actions: } run(); - - target: $["paths"]["/hris/bankinfos"]["get"] + - target: $["paths"]["/marketingautomation/campaigns"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisBankinfo + label: listMarketingautomationCampaigns source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.bankinfos.list({ + const result = await panora.marketingautomation.campaigns.list({ xConnectionToken: "", }); @@ -4316,22 +4685,21 @@ actions: } run(); - - target: $["paths"]["/hris/employerbenefits/{id}"]["get"] + - target: $["paths"]["/ats/candidates"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisEmployerBenefit + label: listAtsCandidate source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.employerbenefits.retrieve({ + const result = await panora.ats.candidates.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4339,21 +4707,23 @@ actions: } run(); - - target: $["paths"]["/hris/paygroups"]["get"] + - target: $["paths"]["/hris/employerbenefits/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: listHrisPaygroup + label: retrieveHrisEmployerBenefit source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.paygroups.list({ + const result = await panora.hris.employerbenefits.retrieve({ xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4361,21 +4731,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/messages"]["get"] + - target: $["paths"]["/accounting/contacts"]["post"] update: x-codeSamples: - lang: typescript - label: listMarketingautomationMessages + label: createAccountingContact source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.messages.list({ + const result = await panora.accounting.contacts.create({ xConnectionToken: "", + remoteData: false, + unifiedAccountingContactInput: {}, }); // Handle the result @@ -4383,22 +4755,21 @@ actions: } run(); - - target: $["paths"]["/ats/activities/{id}"]["get"] + - target: $["paths"]["/accounting/invoices"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsActivity + label: listAccountingInvoice source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.activities.retrieve({ + const result = await panora.accounting.invoices.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4406,22 +4777,21 @@ actions: } run(); - - target: $["paths"]["/ats/attachments/{id}"]["get"] + - target: $["paths"]["/accounting/transactions"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsAttachment + label: listAccountingTransaction source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.attachments.retrieve({ + const result = await panora.accounting.transactions.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4429,22 +4799,23 @@ actions: } run(); - - target: $["paths"]["/ats/jobs/{id}"]["get"] + - target: $["paths"]["/crm/engagements/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveAtsJob + label: retrieveCrmEngagement source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.jobs.retrieve({ + const result = await panora.crm.engagements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4452,21 +4823,32 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs"]["get"] + - target: $["paths"]["/ticketing/attachments"]["post"] update: x-codeSamples: - lang: typescript - label: listHrisTimeoffs + label: createTicketingAttachment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.timeoffs.list({ + const result = await panora.ticketing.attachments.create({ xConnectionToken: "", + unifiedTicketingAttachmentInput: { + fileName: "features_planning.pdf", + fileUrl: "https://example.com/features_planning.pdf", + uploader: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + commentId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4474,22 +4856,21 @@ actions: } run(); - - target: $["paths"]["/hris/timeoffs"]["post"] + - target: $["paths"]["/hris/employerbenefits"]["get"] update: x-codeSamples: - lang: typescript - label: createHrisTimeoff + label: listHrisEmployerBenefits source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.timeoffs.create({ + const result = await panora.hris.employerbenefits.list({ xConnectionToken: "", - unifiedHrisTimeoffInput: {}, }); // Handle the result @@ -4497,22 +4878,23 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/contacts"]["post"] + - target: $["paths"]["/hris/timeoffbalances/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: createMarketingAutomationContact + label: retrieveHrisTimeoffbalance source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.contacts.create({ + const result = await panora.hris.timeoffbalances.retrieve({ xConnectionToken: "", - unifiedMarketingautomationContactInput: {}, + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4520,20 +4902,20 @@ actions: } run(); - - target: $["paths"]["/accounting/vendorcredits"]["get"] + - target: $["paths"]["/ats/tags"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingVendorCredit + label: listAtsTags source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.vendorcredits.list({ + const result = await panora.ats.tags.list({ xConnectionToken: "", }); @@ -4542,42 +4924,47 @@ actions: } run(); - - target: $["paths"]["/sync/resync"]["post"] + - target: $["paths"]["/accounting/payments"]["post"] update: x-codeSamples: - lang: typescript - label: resync + label: createAccountingPayment source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.sync.resync(); + const result = await panora.accounting.payments.create({ + xConnectionToken: "", + remoteData: false, + unifiedAccountingPaymentInput: {}, + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/hris/timeoffs/{id}"]["get"] + - target: $["paths"]["/marketingautomation/actions/{id}"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveHrisTimeoff + label: retrieveMarketingautomationAction source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.hris.timeoffs.retrieve({ + const result = await panora.marketingautomation.actions.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -4585,22 +4972,35 @@ actions: } run(); - - target: $["paths"]["/marketingautomation/lists/{id}"]["get"] + - target: $["paths"]["/ats/activities"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveMarketingautomationList + label: createAtsActivity source: |- import { Panora } from "@panora/sdk"; + import { UnifiedAtsActivityInputActivityType, UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.marketingautomation.lists.retrieve({ + const result = await panora.ats.activities.create({ xConnectionToken: "", - id: "", + remoteData: false, + unifiedAtsActivityInput: { + activityType: UnifiedAtsActivityInputActivityType.Note, + subject: "Email subject", + body: "Dear Diana, I love you", + visibility: UnifiedAtsActivityInputVisibility.Public, + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -4608,22 +5008,21 @@ actions: } run(); - - target: $["paths"]["/ats/attachments"]["post"] + - target: $["paths"]["/accounting/phonenumbers"]["get"] update: x-codeSamples: - lang: typescript - label: createAtsAttachment + label: listAccountingPhonenumber source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.attachments.create({ + const result = await panora.accounting.phonenumbers.list({ xConnectionToken: "", - unifiedAtsAttachmentInput: {}, }); // Handle the result @@ -4631,22 +5030,28 @@ actions: } run(); - - target: $["paths"]["/ats/eeocs/{id}"]["get"] + - target: $["paths"]["/field_mappings"]["post"] update: x-codeSamples: - lang: typescript - label: retrieveAtsEeocs + label: defineCustomField source: |- import { Panora } from "@panora/sdk"; + import { CustomFieldCreateDtoDataType, CustomFieldCreateDtoObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.eeocs.retrieve({ - xConnectionToken: "", - id: "", + const result = await panora.fieldMappings.defineCustomField({ + objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner.Company, + name: "my_favorite_dish", + description: "Favorite Dish", + dataType: CustomFieldCreateDtoDataType.String, + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -4654,22 +5059,21 @@ actions: } run(); - - target: $["paths"]["/ticketing/attachments/{id}"]["get"] + - target: $["paths"]["/marketingautomation/automations"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveTicketingAttachment + label: listMarketingautomationAutomations source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ticketing.attachments.retrieve({ + const result = await panora.marketingautomation.automations.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4677,22 +5081,21 @@ actions: } run(); - - target: $["paths"]["/crm/notes/{id}"]["get"] + - target: $["paths"]["/marketingautomation/templates"]["get"] update: x-codeSamples: - lang: typescript - label: retrieveCrmNote + label: listMarketingautomationTemplates source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.crm.notes.retrieve({ + const result = await panora.marketingautomation.templates.list({ xConnectionToken: "", - id: "", }); // Handle the result @@ -4700,20 +5103,20 @@ actions: } run(); - - target: $["paths"]["/ats/rejectreasons"]["get"] + - target: $["paths"]["/accounting/attachments"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsRejectReasons + label: listAccountingAttachments source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.rejectreasons.list({ + const result = await panora.accounting.attachments.list({ xConnectionToken: "", }); @@ -4722,20 +5125,20 @@ actions: } run(); - - target: $["paths"]["/accounting/cashflowstatements"]["get"] + - target: $["paths"]["/accounting/purchaseorders"]["get"] update: x-codeSamples: - lang: typescript - label: listAccountingCashflowStatement + label: listAccountingPurchaseOrder source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.accounting.cashflowstatements.list({ + const result = await panora.accounting.purchaseorders.list({ xConnectionToken: "", }); @@ -4744,40 +5147,42 @@ actions: } run(); - - target: $["paths"]["/health"]["get"] + - target: $["paths"]["/ticketing/tickets"]["get"] update: x-codeSamples: - lang: typescript - label: health + label: listTicketingTicket source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.health(); + const result = await panora.ticketing.tickets.list({ + xConnectionToken: "", + }); // Handle the result console.log(result) } run(); - - target: $["paths"]["/ats/offers"]["get"] + - target: $["paths"]["/filestorage/drives"]["get"] update: x-codeSamples: - lang: typescript - label: listAtsOffer + label: listFilestorageDrives source: |- import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.ats.offers.list({ + const result = await panora.filestorage.drives.list({ xConnectionToken: "", }); diff --git a/docs/models/components/accessrole.md b/docs/models/components/accessrole.md new file mode 100644 index 00000000..7bedfc35 --- /dev/null +++ b/docs/models/components/accessrole.md @@ -0,0 +1,14 @@ +# AccessRole + +The access role of the user + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `SuperAdmin` | SUPER_ADMIN | +| `Admin` | ADMIN | +| `TeamMember` | TEAM_MEMBER | +| `LimitedTeamMember` | LIMITED_TEAM_MEMBER | +| `Interviewer` | INTERVIEWER | \ No newline at end of file diff --git a/docs/models/components/activitytype.md b/docs/models/components/activitytype.md new file mode 100644 index 00000000..e08657fc --- /dev/null +++ b/docs/models/components/activitytype.md @@ -0,0 +1,12 @@ +# ActivityType + +The type of activity + + +## Values + +| Name | Value | +| ------- | ------- | +| `Note` | NOTE | +| `Email` | EMAIL | +| `Other` | OTHER | \ No newline at end of file diff --git a/docs/models/components/address.md b/docs/models/components/address.md index 3132a13c..5da68cd9 100644 --- a/docs/models/components/address.md +++ b/docs/models/components/address.md @@ -11,5 +11,5 @@ | `state` | *string* | :heavy_check_mark: | The state | | `postalCode` | *string* | :heavy_check_mark: | The postal code | | `country` | *string* | :heavy_check_mark: | The country | -| `addressType` | *string* | :heavy_check_mark: | The address type. Authorized values are either PERSONAL or WORK. | +| `addressType` | [components.AddressType](../../models/components/addresstype.md) | :heavy_check_mark: | The address type. Authorized values are either PERSONAL or WORK. | | `ownerType` | *string* | :heavy_check_mark: | The owner type of the address | \ No newline at end of file diff --git a/docs/models/components/addresstype.md b/docs/models/components/addresstype.md new file mode 100644 index 00000000..45079983 --- /dev/null +++ b/docs/models/components/addresstype.md @@ -0,0 +1,11 @@ +# AddressType + +The address type. Authorized values are either PERSONAL or WORK. + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Personal` | PERSONAL | +| `Work` | WORK | \ No newline at end of file diff --git a/docs/models/components/attachmenttype.md b/docs/models/components/attachmenttype.md new file mode 100644 index 00000000..9f3e64a2 --- /dev/null +++ b/docs/models/components/attachmenttype.md @@ -0,0 +1,13 @@ +# AttachmentType + +The type of the file + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Resume` | RESUME | +| `CoverLetter` | COVER_LETTER | +| `OfferLetter` | OFFER_LETTER | +| `Other` | OTHER | \ No newline at end of file diff --git a/docs/models/components/collectiontype.md b/docs/models/components/collectiontype.md new file mode 100644 index 00000000..252021b5 --- /dev/null +++ b/docs/models/components/collectiontype.md @@ -0,0 +1,11 @@ +# CollectionType + +The type of the collection. Authorized values are either PROJECT or LIST + + +## Values + +| Name | Value | +| --------- | --------- | +| `Project` | PROJECT | +| `List` | LIST | \ No newline at end of file diff --git a/docs/models/components/comment.md b/docs/models/components/comment.md index 80bf935a..457d8cdc 100644 --- a/docs/models/components/comment.md +++ b/docs/models/components/comment.md @@ -5,13 +5,13 @@ The comment of the ticket ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `body` | *string* | :heavy_check_mark: | The body of the comment | -| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment | -| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | -| `creatorType` | *string* | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | -| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | -| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `body` | *string* | :heavy_check_mark: | The body of the comment | Assigned to Eric ! | +| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment |

Assigned to Eric !

| +| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | false | +| `creatorType` | [components.UnifiedTicketingTicketOutputCreatorType](../../models/components/unifiedticketingticketoutputcreatortype.md) | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | USER | +| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | \ No newline at end of file diff --git a/docs/models/components/createbatchlinkeduserdto.md b/docs/models/components/createbatchlinkeduserdto.md index 0545c65d..8473e593 100644 --- a/docs/models/components/createbatchlinkeduserdto.md +++ b/docs/models/components/createbatchlinkeduserdto.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `linkedUserOriginIds` | *string*[] | :heavy_check_mark: | N/A | -| `alias` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `linkedUserOriginIds` | *string*[] | :heavy_check_mark: | The ids of the users in the context of your own software | [
"id_1"
] | +| `alias` | *string* | :heavy_check_mark: | Your company alias | acme | \ No newline at end of file diff --git a/docs/models/components/createlinkeduserdto.md b/docs/models/components/createlinkeduserdto.md index df5b6998..3d964298 100644 --- a/docs/models/components/createlinkeduserdto.md +++ b/docs/models/components/createlinkeduserdto.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `linkedUserOriginId` | *string* | :heavy_check_mark: | N/A | -| `alias` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `linkedUserOriginId` | *string* | :heavy_check_mark: | The id of the user in the context of your own software | id_1 | +| `alias` | *string* | :heavy_check_mark: | Your company alias | acme | \ No newline at end of file diff --git a/docs/models/components/creatortype.md b/docs/models/components/creatortype.md new file mode 100644 index 00000000..902451e1 --- /dev/null +++ b/docs/models/components/creatortype.md @@ -0,0 +1,11 @@ +# CreatorType + +The creator type of the comment. Authorized values are either USER or CONTACT + + +## Values + +| Name | Value | +| --------- | --------- | +| `User` | USER | +| `Contact` | CONTACT | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatedto.md b/docs/models/components/customfieldcreatedto.md index deb43f7c..3b9de0ee 100644 --- a/docs/models/components/customfieldcreatedto.md +++ b/docs/models/components/customfieldcreatedto.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `objectTypeOwner` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_check_mark: | N/A | -| `dataType` | *string* | :heavy_check_mark: | N/A | -| `sourceCustomFieldId` | *string* | :heavy_check_mark: | N/A | -| `sourceProvider` | *string* | :heavy_check_mark: | N/A | -| `linkedUserId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `objectTypeOwner` | [components.CustomFieldCreateDtoObjectTypeOwner](../../models/components/customfieldcreatedtoobjecttypeowner.md) | :heavy_check_mark: | N/A | company | +| `name` | *string* | :heavy_check_mark: | The name of the custom field | my_favorite_dish | +| `description` | *string* | :heavy_check_mark: | The description of the custom field | Favorite Dish | +| `dataType` | [components.CustomFieldCreateDtoDataType](../../models/components/customfieldcreatedtodatatype.md) | :heavy_check_mark: | The data type of the custom field | string | +| `sourceCustomFieldId` | *string* | :heavy_check_mark: | The source custom field ID | id_1 | +| `sourceProvider` | *string* | :heavy_check_mark: | The name of the source software/provider | hubspot | +| `linkedUserId` | *string* | :heavy_check_mark: | The linked user ID | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatedtodatatype.md b/docs/models/components/customfieldcreatedtodatatype.md new file mode 100644 index 00000000..add79a6b --- /dev/null +++ b/docs/models/components/customfieldcreatedtodatatype.md @@ -0,0 +1,11 @@ +# CustomFieldCreateDtoDataType + +The data type of the custom field + + +## Values + +| Name | Value | +| -------- | -------- | +| `String` | string | +| `Number` | number | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatedtoobjecttypeowner.md b/docs/models/components/customfieldcreatedtoobjecttypeowner.md new file mode 100644 index 00000000..f363a1a1 --- /dev/null +++ b/docs/models/components/customfieldcreatedtoobjecttypeowner.md @@ -0,0 +1,16 @@ +# CustomFieldCreateDtoObjectTypeOwner + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `Company` | company | +| `Contact` | contact | +| `Deal` | deal | +| `Lead` | lead | +| `Note` | note | +| `Task` | task | +| `Engagement` | engagement | +| `Stage` | stage | +| `User` | user | \ No newline at end of file diff --git a/docs/models/components/customfieldresponse.md b/docs/models/components/customfieldresponse.md index 74a25358..5a449d51 100644 --- a/docs/models/components/customfieldresponse.md +++ b/docs/models/components/customfieldresponse.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `idAttribute` | *string* | :heavy_check_mark: | Attribute Id | -| `status` | *string* | :heavy_check_mark: | Attribute Status | -| `ressourceOwnerType` | *string* | :heavy_check_mark: | Attribute Ressource Owner Type | -| `slug` | *string* | :heavy_check_mark: | Attribute Slug | -| `description` | *string* | :heavy_check_mark: | Attribute Description | -| `dataType` | *string* | :heavy_check_mark: | Attribute Data Type | -| `remoteId` | *string* | :heavy_check_mark: | Attribute Remote Id | -| `source` | *string* | :heavy_check_mark: | Attribute Source | -| `idEntity` | *string* | :heavy_check_mark: | Attribute Id Entity | -| `idProject` | *string* | :heavy_check_mark: | Attribute Id Project | -| `scope` | *string* | :heavy_check_mark: | Attribute Scope | -| `idConsumer` | *string* | :heavy_check_mark: | Attribute Id Consumer | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Attribute Created Date | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Attribute Modified Date | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `idAttribute` | *string* | :heavy_check_mark: | Attribute Id | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `status` | *string* | :heavy_check_mark: | Attribute Status | | +| `ressourceOwnerType` | *string* | :heavy_check_mark: | Attribute Ressource Owner Type | | +| `slug` | *string* | :heavy_check_mark: | Attribute Slug | fav_dish | +| `description` | *string* | :heavy_check_mark: | Attribute Description | My favorite dish | +| `dataType` | [components.CustomFieldResponseDataType](../../models/components/customfieldresponsedatatype.md) | :heavy_check_mark: | Attribute Data Type | string | +| `remoteId` | *string* | :heavy_check_mark: | Attribute Remote Id | id_1 | +| `source` | *string* | :heavy_check_mark: | Attribute Source | hubspot | +| `idEntity` | *string* | :heavy_check_mark: | Attribute Entity Id | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `idProject` | *string* | :heavy_check_mark: | Attribute Project Id | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `scope` | *string* | :heavy_check_mark: | Attribute Scope | | +| `idConsumer` | *string* | :heavy_check_mark: | Attribute Consumer Id | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Attribute Created Date | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Attribute Modified Date | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/customfieldresponsedatatype.md b/docs/models/components/customfieldresponsedatatype.md new file mode 100644 index 00000000..6d7bbe5a --- /dev/null +++ b/docs/models/components/customfieldresponsedatatype.md @@ -0,0 +1,11 @@ +# CustomFieldResponseDataType + +Attribute Data Type + + +## Values + +| Name | Value | +| -------- | -------- | +| `String` | string | +| `Number` | number | \ No newline at end of file diff --git a/docs/models/components/datatype.md b/docs/models/components/datatype.md new file mode 100644 index 00000000..b7c7b888 --- /dev/null +++ b/docs/models/components/datatype.md @@ -0,0 +1,11 @@ +# DataType + +The data type of the target field + + +## Values + +| Name | Value | +| -------- | -------- | +| `String` | string | +| `Number` | number | \ No newline at end of file diff --git a/docs/models/components/definetargetfielddto.md b/docs/models/components/definetargetfielddto.md index 73cea96b..ec3aeaed 100644 --- a/docs/models/components/definetargetfielddto.md +++ b/docs/models/components/definetargetfielddto.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `objectTypeOwner` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_check_mark: | N/A | -| `dataType` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `objectTypeOwner` | [components.ObjectTypeOwner](../../models/components/objecttypeowner.md) | :heavy_check_mark: | N/A | company | +| `name` | *string* | :heavy_check_mark: | The name of the target field | fav_dish | +| `description` | *string* | :heavy_check_mark: | The description of the target field | My favorite dish | +| `dataType` | [components.DataType](../../models/components/datatype.md) | :heavy_check_mark: | The data type of the target field | string | \ No newline at end of file diff --git a/docs/models/components/direction.md b/docs/models/components/direction.md new file mode 100644 index 00000000..10d598e6 --- /dev/null +++ b/docs/models/components/direction.md @@ -0,0 +1,11 @@ +# Direction + +The direction of the engagement. Authorized values are INBOUND or OUTBOUND + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Inbound` | INBOUND | +| `Outbound` | OUTBOUND | \ No newline at end of file diff --git a/docs/models/components/disabilitystatus.md b/docs/models/components/disabilitystatus.md new file mode 100644 index 00000000..dd2746f6 --- /dev/null +++ b/docs/models/components/disabilitystatus.md @@ -0,0 +1,12 @@ +# DisabilityStatus + +The disability status of the candidate + + +## Values + +| Name | Value | +| ------------------------------------------------------ | ------------------------------------------------------ | +| `YesIHaveADisabilityOrPreviouslyHadADisability` | YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY | +| `NoIDontHaveADisability` | NO_I_DONT_HAVE_A_DISABILITY | +| `IDontWishToAnswer` | I_DONT_WISH_TO_ANSWER | \ No newline at end of file diff --git a/docs/models/components/email.md b/docs/models/components/email.md index f12e35c6..351f3e5d 100644 --- a/docs/models/components/email.md +++ b/docs/models/components/email.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `emailAddress` | *string* | :heavy_check_mark: | The email address | -| `emailAddressType` | *string* | :heavy_check_mark: | The email address type. Authorized values are either PERSONAL or WORK. | -| `ownerType` | *string* | :heavy_minus_sign: | The owner type of an email | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `emailAddress` | *string* | :heavy_check_mark: | The email address | +| `emailAddressType` | [components.EmailAddressType](../../models/components/emailaddresstype.md) | :heavy_check_mark: | The email address type. Authorized values are either PERSONAL or WORK. | +| `ownerType` | [components.OwnerType](../../models/components/ownertype.md) | :heavy_minus_sign: | The owner type of an email | \ No newline at end of file diff --git a/docs/models/components/emailaddresstype.md b/docs/models/components/emailaddresstype.md new file mode 100644 index 00000000..174bcaf3 --- /dev/null +++ b/docs/models/components/emailaddresstype.md @@ -0,0 +1,11 @@ +# EmailAddressType + +The email address type. Authorized values are either PERSONAL or WORK. + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Personal` | PERSONAL | +| `Work` | WORK | \ No newline at end of file diff --git a/docs/models/components/gender.md b/docs/models/components/gender.md new file mode 100644 index 00000000..acf69ebb --- /dev/null +++ b/docs/models/components/gender.md @@ -0,0 +1,14 @@ +# Gender + +The gender of the candidate + + +## Values + +| Name | Value | +| ------------------------ | ------------------------ | +| `Male` | MALE | +| `Female` | FEMALE | +| `NonBinary` | NON_BINARY | +| `Other` | OTHER | +| `DeclineToSelfIdentify` | DECLINE_TO_SELF_IDENTIFY | \ No newline at end of file diff --git a/docs/models/components/industry.md b/docs/models/components/industry.md new file mode 100644 index 00000000..245f4509 --- /dev/null +++ b/docs/models/components/industry.md @@ -0,0 +1,156 @@ +# Industry + +The industry of the company. Authorized values can be found in the Industry enum. + + +## Values + +| Name | Value | +| ------------------------------------ | ------------------------------------ | +| `Accounting` | ACCOUNTING | +| `AirlinesAviation` | AIRLINES_AVIATION | +| `AlternativeDisputeResolution` | ALTERNATIVE_DISPUTE_RESOLUTION | +| `AlternativeMedicine` | ALTERNATIVE_MEDICINE | +| `Animation` | ANIMATION | +| `ApparelFashion` | APPAREL_FASHION | +| `ArchitecturePlanning` | ARCHITECTURE_PLANNING | +| `ArtsAndCrafts` | ARTS_AND_CRAFTS | +| `Automotive` | AUTOMOTIVE | +| `AviationAerospace` | AVIATION_AEROSPACE | +| `Banking` | BANKING | +| `Biotechnology` | BIOTECHNOLOGY | +| `BroadcastMedia` | BROADCAST_MEDIA | +| `BuildingMaterials` | BUILDING_MATERIALS | +| `BusinessSuppliesAndEquipment` | BUSINESS_SUPPLIES_AND_EQUIPMENT | +| `CapitalMarkets` | CAPITAL_MARKETS | +| `Chemicals` | CHEMICALS | +| `CivicSocialOrganization` | CIVIC_SOCIAL_ORGANIZATION | +| `CivilEngineering` | CIVIL_ENGINEERING | +| `CommercialRealEstate` | COMMERCIAL_REAL_ESTATE | +| `ComputerNetworkSecurity` | COMPUTER_NETWORK_SECURITY | +| `ComputerGames` | COMPUTER_GAMES | +| `ComputerHardware` | COMPUTER_HARDWARE | +| `ComputerNetworking` | COMPUTER_NETWORKING | +| `ComputerSoftware` | COMPUTER_SOFTWARE | +| `Internet` | INTERNET | +| `Construction` | CONSTRUCTION | +| `ConsumerElectronics` | CONSUMER_ELECTRONICS | +| `ConsumerGoods` | CONSUMER_GOODS | +| `ConsumerServices` | CONSUMER_SERVICES | +| `Cosmetics` | COSMETICS | +| `Dairy` | DAIRY | +| `DefenseSpace` | DEFENSE_SPACE | +| `Design` | DESIGN | +| `EducationManagement` | EDUCATION_MANAGEMENT | +| `ELearning` | E_LEARNING | +| `ElectricalElectronicManufacturing` | ELECTRICAL_ELECTRONIC_MANUFACTURING | +| `Entertainment` | ENTERTAINMENT | +| `EnvironmentalServices` | ENVIRONMENTAL_SERVICES | +| `EventsServices` | EVENTS_SERVICES | +| `ExecutiveOffice` | EXECUTIVE_OFFICE | +| `FacilitiesServices` | FACILITIES_SERVICES | +| `Farming` | FARMING | +| `FinancialServices` | FINANCIAL_SERVICES | +| `FineArt` | FINE_ART | +| `Fishery` | FISHERY | +| `FoodBeverages` | FOOD_BEVERAGES | +| `FoodProduction` | FOOD_PRODUCTION | +| `FundRaising` | FUND_RAISING | +| `Furniture` | FURNITURE | +| `GamblingCasinos` | GAMBLING_CASINOS | +| `GlassCeramicsConcrete` | GLASS_CERAMICS_CONCRETE | +| `GovernmentAdministration` | GOVERNMENT_ADMINISTRATION | +| `GovernmentRelations` | GOVERNMENT_RELATIONS | +| `GraphicDesign` | GRAPHIC_DESIGN | +| `HealthWellnessAndFitness` | HEALTH_WELLNESS_AND_FITNESS | +| `HigherEducation` | HIGHER_EDUCATION | +| `HospitalHealthCare` | HOSPITAL_HEALTH_CARE | +| `Hospitality` | HOSPITALITY | +| `HumanResources` | HUMAN_RESOURCES | +| `ImportAndExport` | IMPORT_AND_EXPORT | +| `IndividualFamilyServices` | INDIVIDUAL_FAMILY_SERVICES | +| `IndustrialAutomation` | INDUSTRIAL_AUTOMATION | +| `InformationServices` | INFORMATION_SERVICES | +| `InformationTechnologyAndServices` | INFORMATION_TECHNOLOGY_AND_SERVICES | +| `Insurance` | INSURANCE | +| `InternationalAffairs` | INTERNATIONAL_AFFAIRS | +| `InternationalTradeAndDevelopment` | INTERNATIONAL_TRADE_AND_DEVELOPMENT | +| `InvestmentBanking` | INVESTMENT_BANKING | +| `InvestmentManagement` | INVESTMENT_MANAGEMENT | +| `Judiciary` | JUDICIARY | +| `LawEnforcement` | LAW_ENFORCEMENT | +| `LawPractice` | LAW_PRACTICE | +| `LegalServices` | LEGAL_SERVICES | +| `LegislativeOffice` | LEGISLATIVE_OFFICE | +| `LeisureTravelTourism` | LEISURE_TRAVEL_TOURISM | +| `Libraries` | LIBRARIES | +| `LogisticsAndSupplyChain` | LOGISTICS_AND_SUPPLY_CHAIN | +| `LuxuryGoodsJewelry` | LUXURY_GOODS_JEWELRY | +| `Machinery` | MACHINERY | +| `ManagementConsulting` | MANAGEMENT_CONSULTING | +| `Maritime` | MARITIME | +| `MarketResearch` | MARKET_RESEARCH | +| `MarketingAndAdvertising` | MARKETING_AND_ADVERTISING | +| `MechanicalOrIndustrialEngineering` | MECHANICAL_OR_INDUSTRIAL_ENGINEERING | +| `MediaProduction` | MEDIA_PRODUCTION | +| `MedicalDevices` | MEDICAL_DEVICES | +| `MedicalPractice` | MEDICAL_PRACTICE | +| `MentalHealthCare` | MENTAL_HEALTH_CARE | +| `Military` | MILITARY | +| `MiningMetals` | MINING_METALS | +| `MotionPicturesAndFilm` | MOTION_PICTURES_AND_FILM | +| `MuseumsAndInstitutions` | MUSEUMS_AND_INSTITUTIONS | +| `Music` | MUSIC | +| `Nanotechnology` | NANOTECHNOLOGY | +| `Newspapers` | NEWSPAPERS | +| `NonProfitOrganizationManagement` | NON_PROFIT_ORGANIZATION_MANAGEMENT | +| `OilEnergy` | OIL_ENERGY | +| `OnlineMedia` | ONLINE_MEDIA | +| `OutsourcingOffshoring` | OUTSOURCING_OFFSHORING | +| `PackageFreightDelivery` | PACKAGE_FREIGHT_DELIVERY | +| `PackagingAndContainers` | PACKAGING_AND_CONTAINERS | +| `PaperForestProducts` | PAPER_FOREST_PRODUCTS | +| `PerformingArts` | PERFORMING_ARTS | +| `Pharmaceuticals` | PHARMACEUTICALS | +| `Philanthropy` | PHILANTHROPY | +| `Photography` | PHOTOGRAPHY | +| `Plastics` | PLASTICS | +| `PoliticalOrganization` | POLITICAL_ORGANIZATION | +| `PrimarySecondaryEducation` | PRIMARY_SECONDARY_EDUCATION | +| `Printing` | PRINTING | +| `ProfessionalTrainingCoaching` | PROFESSIONAL_TRAINING_COACHING | +| `ProgramDevelopment` | PROGRAM_DEVELOPMENT | +| `PublicPolicy` | PUBLIC_POLICY | +| `PublicRelationsAndCommunications` | PUBLIC_RELATIONS_AND_COMMUNICATIONS | +| `PublicSafety` | PUBLIC_SAFETY | +| `Publishing` | PUBLISHING | +| `RailroadManufacture` | RAILROAD_MANUFACTURE | +| `Ranching` | RANCHING | +| `RealEstate` | REAL_ESTATE | +| `RecreationalFacilitiesAndServices` | RECREATIONAL_FACILITIES_AND_SERVICES | +| `ReligiousInstitutions` | RELIGIOUS_INSTITUTIONS | +| `RenewablesEnvironment` | RENEWABLES_ENVIRONMENT | +| `Research` | RESEARCH | +| `Restaurants` | RESTAURANTS | +| `Retail` | RETAIL | +| `SecurityAndInvestigations` | SECURITY_AND_INVESTIGATIONS | +| `Semiconductors` | SEMICONDUCTORS | +| `Shipbuilding` | SHIPBUILDING | +| `SportingGoods` | SPORTING_GOODS | +| `Sports` | SPORTS | +| `StaffingAndRecruiting` | STAFFING_AND_RECRUITING | +| `Supermarkets` | SUPERMARKETS | +| `Telecommunications` | TELECOMMUNICATIONS | +| `Textiles` | TEXTILES | +| `ThinkTanks` | THINK_TANKS | +| `Tobacco` | TOBACCO | +| `TranslationAndLocalization` | TRANSLATION_AND_LOCALIZATION | +| `TransportationTruckingRailroad` | TRANSPORTATION_TRUCKING_RAILROAD | +| `Utilities` | UTILITIES | +| `VentureCapitalPrivateEquity` | VENTURE_CAPITAL_PRIVATE_EQUITY | +| `Veterinary` | VETERINARY | +| `Warehousing` | WAREHOUSING | +| `Wholesale` | WHOLESALE | +| `WineAndSpirits` | WINE_AND_SPIRITS | +| `Wireless` | WIRELESS | +| `WritingAndEditing` | WRITING_AND_EDITING | \ No newline at end of file diff --git a/docs/models/components/linkeduserresponse.md b/docs/models/components/linkeduserresponse.md index e5256a6d..aba0fa87 100644 --- a/docs/models/components/linkeduserresponse.md +++ b/docs/models/components/linkeduserresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `idLinkedUser` | *string* | :heavy_check_mark: | N/A | -| `linkedUserOriginId` | *string* | :heavy_check_mark: | N/A | -| `alias` | *string* | :heavy_check_mark: | N/A | -| `idProject` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `idLinkedUser` | *string* | :heavy_check_mark: | N/A | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `linkedUserOriginId` | *string* | :heavy_check_mark: | N/A | id_1 | +| `alias` | *string* | :heavy_check_mark: | N/A | acme | +| `idProject` | *string* | :heavy_check_mark: | N/A | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | \ No newline at end of file diff --git a/docs/models/components/mapfieldtoproviderdto.md b/docs/models/components/mapfieldtoproviderdto.md index a840f2d9..3d7a6929 100644 --- a/docs/models/components/mapfieldtoproviderdto.md +++ b/docs/models/components/mapfieldtoproviderdto.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `attributeId` | *string* | :heavy_check_mark: | Attribute Id | -| `sourceCustomFieldId` | *string* | :heavy_check_mark: | Attribute Id | -| `sourceProvider` | *string* | :heavy_check_mark: | Attribute Id | -| `linkedUserId` | *string* | :heavy_check_mark: | Attribute Id | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `attributeId` | *string* | :heavy_check_mark: | The attribute ID | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `sourceCustomFieldId` | *string* | :heavy_check_mark: | The source custom field ID | id_1 | +| `sourceProvider` | *string* | :heavy_check_mark: | The source provider | hubspot | +| `linkedUserId` | *string* | :heavy_check_mark: | The linked user ID | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | \ No newline at end of file diff --git a/docs/models/components/objecttypeowner.md b/docs/models/components/objecttypeowner.md new file mode 100644 index 00000000..ea826951 --- /dev/null +++ b/docs/models/components/objecttypeowner.md @@ -0,0 +1,16 @@ +# ObjectTypeOwner + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `Company` | company | +| `Contact` | contact | +| `Deal` | deal | +| `Lead` | lead | +| `Note` | note | +| `Task` | task | +| `Engagement` | engagement | +| `Stage` | stage | +| `User` | user | \ No newline at end of file diff --git a/docs/models/components/overallrecommendation.md b/docs/models/components/overallrecommendation.md new file mode 100644 index 00000000..1935fe82 --- /dev/null +++ b/docs/models/components/overallrecommendation.md @@ -0,0 +1,14 @@ +# OverallRecommendation + +The overall recommendation + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `DefinitelyNo` | DEFINITELY_NO | +| `No` | NO | +| `Yes` | YES | +| `StrongYes` | STRONG_YES | +| `NoDecision` | NO_DECISION | \ No newline at end of file diff --git a/docs/models/components/ownertype.md b/docs/models/components/ownertype.md new file mode 100644 index 00000000..b01441e5 --- /dev/null +++ b/docs/models/components/ownertype.md @@ -0,0 +1,11 @@ +# OwnerType + +The owner type of an email + + +## Values + +| Name | Value | +| --------- | --------- | +| `Company` | COMPANY | +| `Contact` | CONTACT | \ No newline at end of file diff --git a/docs/models/components/passthroughrequestdto.md b/docs/models/components/passthroughrequestdto.md index 8af070f4..9484e6a0 100644 --- a/docs/models/components/passthroughrequestdto.md +++ b/docs/models/components/passthroughrequestdto.md @@ -7,5 +7,5 @@ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | | `method` | [components.Method](../../models/components/method.md) | :heavy_check_mark: | N/A | | `path` | *string* | :heavy_check_mark: | N/A | -| `data` | *components.Data* | :heavy_minus_sign: | N/A | -| `headers` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file +| `data` | *components.Data* | :heavy_check_mark: | N/A | +| `headers` | Record | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/phone.md b/docs/models/components/phone.md index a244bfc0..8f82e919 100644 --- a/docs/models/components/phone.md +++ b/docs/models/components/phone.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `phoneNumber` | *string* | :heavy_check_mark: | The phone number starting with a plus (+) followed by the country code (e.g +336676778890 for France) | -| `phoneType` | *string* | :heavy_check_mark: | The phone type. Authorized values are either MOBILE or WORK | +| `phoneType` | [components.PhoneType](../../models/components/phonetype.md) | :heavy_check_mark: | The phone type. Authorized values are either MOBILE or WORK | | `ownerType` | *string* | :heavy_minus_sign: | The owner type of a phone number | \ No newline at end of file diff --git a/docs/models/components/phonetype.md b/docs/models/components/phonetype.md new file mode 100644 index 00000000..060d8e34 --- /dev/null +++ b/docs/models/components/phonetype.md @@ -0,0 +1,11 @@ +# PhoneType + +The phone type. Authorized values are either MOBILE or WORK + + +## Values + +| Name | Value | +| -------- | -------- | +| `Mobile` | MOBILE | +| `Work` | WORK | \ No newline at end of file diff --git a/docs/models/components/priority.md b/docs/models/components/priority.md new file mode 100644 index 00000000..b36a54cc --- /dev/null +++ b/docs/models/components/priority.md @@ -0,0 +1,12 @@ +# Priority + +The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. + + +## Values + +| Name | Value | +| -------- | -------- | +| `High` | HIGH | +| `Medium` | MEDIUM | +| `Low` | LOW | \ No newline at end of file diff --git a/docs/models/components/race.md b/docs/models/components/race.md new file mode 100644 index 00000000..8ab22f8d --- /dev/null +++ b/docs/models/components/race.md @@ -0,0 +1,17 @@ +# Race + +The race of the candidate + + +## Values + +| Name | Value | +| ----------------------------------------- | ----------------------------------------- | +| `AmericanIndianOrAlaskanNative` | AMERICAN_INDIAN_OR_ALASKAN_NATIVE | +| `Asian` | ASIAN | +| `BlackOrAfricanAmerican` | BLACK_OR_AFRICAN_AMERICAN | +| `HispanicOrLatino` | HISPANIC_OR_LATINO | +| `White` | WHITE | +| `NativeHawaiianOrOtherPacificIslander` | NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER | +| `TwoOrMoreRaces` | TWO_OR_MORE_RACES | +| `DeclineToSelfIdentify` | DECLINE_TO_SELF_IDENTIFY | \ No newline at end of file diff --git a/docs/models/components/status.md b/docs/models/components/status.md new file mode 100644 index 00000000..a5007aca --- /dev/null +++ b/docs/models/components/status.md @@ -0,0 +1,11 @@ +# Status + +The status of the ticket. Authorized values are OPEN or CLOSED. + + +## Values + +| Name | Value | +| -------- | -------- | +| `Open` | OPEN | +| `Closed` | CLOSED | \ No newline at end of file diff --git a/docs/models/components/type.md b/docs/models/components/type.md new file mode 100644 index 00000000..8827a9eb --- /dev/null +++ b/docs/models/components/type.md @@ -0,0 +1,13 @@ +# Type + +The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK + + +## Values + +| Name | Value | +| --------- | --------- | +| `Bug` | BUG | +| `Subtask` | SUBTASK | +| `Task` | TASK | +| `ToDo` | TO-DO | \ No newline at end of file diff --git a/docs/models/components/unifiedatsactivityinput.md b/docs/models/components/unifiedatsactivityinput.md index 716641d3..fbe1535c 100644 --- a/docs/models/components/unifiedatsactivityinput.md +++ b/docs/models/components/unifiedatsactivityinput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `activityType` | *string* | :heavy_minus_sign: | The type of activity | -| `subject` | *string* | :heavy_minus_sign: | The subject of the activity | -| `body` | *string* | :heavy_minus_sign: | The body of the activity | -| `visibility` | *string* | :heavy_minus_sign: | The visibility of the activity | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the activity | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `activityType` | [components.UnifiedAtsActivityInputActivityType](../../models/components/unifiedatsactivityinputactivitytype.md) | :heavy_minus_sign: | The type of activity | NOTE | +| `subject` | *string* | :heavy_minus_sign: | The subject of the activity | Email subject | +| `body` | *string* | :heavy_minus_sign: | The body of the activity | Dear Diana, I love you | +| `visibility` | [components.UnifiedAtsActivityInputVisibility](../../models/components/unifiedatsactivityinputvisibility.md) | :heavy_minus_sign: | The visibility of the activity | PUBLIC | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the activity | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedatsactivityinputactivitytype.md b/docs/models/components/unifiedatsactivityinputactivitytype.md new file mode 100644 index 00000000..1f69dff4 --- /dev/null +++ b/docs/models/components/unifiedatsactivityinputactivitytype.md @@ -0,0 +1,12 @@ +# UnifiedAtsActivityInputActivityType + +The type of activity + + +## Values + +| Name | Value | +| ------- | ------- | +| `Note` | NOTE | +| `Email` | EMAIL | +| `Other` | OTHER | \ No newline at end of file diff --git a/docs/models/components/unifiedatsactivityinputvisibility.md b/docs/models/components/unifiedatsactivityinputvisibility.md new file mode 100644 index 00000000..6d8157b3 --- /dev/null +++ b/docs/models/components/unifiedatsactivityinputvisibility.md @@ -0,0 +1,12 @@ +# UnifiedAtsActivityInputVisibility + +The visibility of the activity + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `AdminOnly` | ADMIN_ONLY | +| `Public` | PUBLIC | +| `Private` | PRIVATE | \ No newline at end of file diff --git a/docs/models/components/unifiedatsactivityoutput.md b/docs/models/components/unifiedatsactivityoutput.md index 6e0b0ae2..97f26f95 100644 --- a/docs/models/components/unifiedatsactivityoutput.md +++ b/docs/models/components/unifiedatsactivityoutput.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `activityType` | *string* | :heavy_minus_sign: | The type of activity | -| `subject` | *string* | :heavy_minus_sign: | The subject of the activity | -| `body` | *string* | :heavy_minus_sign: | The body of the activity | -| `visibility` | *string* | :heavy_minus_sign: | The visibility of the activity | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the activity | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the activity | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the activity in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the activity in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `activityType` | [components.ActivityType](../../models/components/activitytype.md) | :heavy_minus_sign: | The type of activity | NOTE | +| `subject` | *string* | :heavy_minus_sign: | The subject of the activity | Email subject | +| `body` | *string* | :heavy_minus_sign: | The body of the activity | Dear Diana, I love you | +| `visibility` | [components.Visibility](../../models/components/visibility.md) | :heavy_minus_sign: | The visibility of the activity | PUBLIC | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the activity | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the activity | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the activity in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the activity in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsapplicationinput.md b/docs/models/components/unifiedatsapplicationinput.md index f262339d..1afbd076 100644 --- a/docs/models/components/unifiedatsapplicationinput.md +++ b/docs/models/components/unifiedatsapplicationinput.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `appliedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The application date | -| `rejectedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The rejection date | -| `offers` | *string*[] | :heavy_minus_sign: | The offers UUIDs for the application | -| `source` | *string* | :heavy_minus_sign: | The source of the application | -| `creditedTo` | *string* | :heavy_minus_sign: | The UUID of the person credited for the application | -| `currentStage` | *string* | :heavy_minus_sign: | The UUID of the current stage of the application | -| `rejectReason` | *string* | :heavy_minus_sign: | The rejection reason for the application | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `jobId` | *string* | :heavy_minus_sign: | The UUID of the job | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `appliedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The application date | 2024-10-01T12:00:00Z | +| `rejectedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The rejection date | 2024-10-01T12:00:00Z | +| `offers` | *string*[] | :heavy_minus_sign: | The offers UUIDs for the application | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"12345678-1234-1234-1234-123456789012"
] | +| `source` | *string* | :heavy_minus_sign: | The source of the application | Source Name | +| `creditedTo` | *string* | :heavy_minus_sign: | The UUID of the person credited for the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `currentStage` | *string* | :heavy_minus_sign: | The UUID of the current stage of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `rejectReason` | *string* | :heavy_minus_sign: | The rejection reason for the application | Candidate not experienced enough | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `jobId` | *string* | :heavy_minus_sign: | The UUID of the job | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedatsapplicationoutput.md b/docs/models/components/unifiedatsapplicationoutput.md index 2baf7c65..f6105a42 100644 --- a/docs/models/components/unifiedatsapplicationoutput.md +++ b/docs/models/components/unifiedatsapplicationoutput.md @@ -3,22 +3,22 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `appliedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The application date | -| `rejectedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The rejection date | -| `offers` | *string*[] | :heavy_minus_sign: | The offers UUIDs for the application | -| `source` | *string* | :heavy_minus_sign: | The source of the application | -| `creditedTo` | *string* | :heavy_minus_sign: | The UUID of the person credited for the application | -| `currentStage` | *string* | :heavy_minus_sign: | The UUID of the current stage of the application | -| `rejectReason` | *string* | :heavy_minus_sign: | The rejection reason for the application | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `jobId` | *string* | :heavy_minus_sign: | The UUID of the job | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the application | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the application in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the application in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote created date of the object | -| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `appliedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The application date | 2024-10-01T12:00:00Z | +| `rejectedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The rejection date | 2024-10-01T12:00:00Z | +| `offers` | *string*[] | :heavy_minus_sign: | The offers UUIDs for the application | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"12345678-1234-1234-1234-123456789012"
] | +| `source` | *string* | :heavy_minus_sign: | The source of the application | Source Name | +| `creditedTo` | *string* | :heavy_minus_sign: | The UUID of the person credited for the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `currentStage` | *string* | :heavy_minus_sign: | The UUID of the current stage of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `rejectReason` | *string* | :heavy_minus_sign: | The rejection reason for the application | Candidate not experienced enough | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `jobId` | *string* | :heavy_minus_sign: | The UUID of the job | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the application in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the application in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote created date of the object | | +| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modified date of the object | | \ No newline at end of file diff --git a/docs/models/components/unifiedatsattachmentinput.md b/docs/models/components/unifiedatsattachmentinput.md index e77c2188..41d26721 100644 --- a/docs/models/components/unifiedatsattachmentinput.md +++ b/docs/models/components/unifiedatsattachmentinput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `fileUrl` | *string* | :heavy_minus_sign: | The URL of the file | -| `fileName` | *string* | :heavy_minus_sign: | The name of the file | -| `attachmentType` | *string* | :heavy_minus_sign: | The type of the file | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the attachment | -| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the attachment | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `fileUrl` | *string* | :heavy_minus_sign: | The URL of the file | https://example.com/file.pdf | +| `fileName` | *string* | :heavy_minus_sign: | The name of the file | file.pdf | +| `attachmentType` | [components.UnifiedAtsAttachmentInputAttachmentType](../../models/components/unifiedatsattachmentinputattachmenttype.md) | :heavy_minus_sign: | The type of the file | RESUME | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the attachment | 2024-10-01T12:00:00Z | +| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the attachment | 2024-10-01T12:00:00Z | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedatsattachmentinputattachmenttype.md b/docs/models/components/unifiedatsattachmentinputattachmenttype.md new file mode 100644 index 00000000..4de1cd4e --- /dev/null +++ b/docs/models/components/unifiedatsattachmentinputattachmenttype.md @@ -0,0 +1,13 @@ +# UnifiedAtsAttachmentInputAttachmentType + +The type of the file + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Resume` | RESUME | +| `CoverLetter` | COVER_LETTER | +| `OfferLetter` | OFFER_LETTER | +| `Other` | OTHER | \ No newline at end of file diff --git a/docs/models/components/unifiedatsattachmentoutput.md b/docs/models/components/unifiedatsattachmentoutput.md index b8937751..0fbe7397 100644 --- a/docs/models/components/unifiedatsattachmentoutput.md +++ b/docs/models/components/unifiedatsattachmentoutput.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `fileUrl` | *string* | :heavy_minus_sign: | The URL of the file | -| `fileName` | *string* | :heavy_minus_sign: | The name of the file | -| `attachmentType` | *string* | :heavy_minus_sign: | The type of the file | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the attachment | -| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the attachment | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the attachment | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the attachment | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the attachment in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `fileUrl` | *string* | :heavy_minus_sign: | The URL of the file | https://example.com/file.pdf | +| `fileName` | *string* | :heavy_minus_sign: | The name of the file | file.pdf | +| `attachmentType` | [components.AttachmentType](../../models/components/attachmenttype.md) | :heavy_minus_sign: | The type of the file | RESUME | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the attachment | 2024-10-01T12:00:00Z | +| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the attachment | 2024-10-01T12:00:00Z | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the attachment | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the attachment | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the attachment in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatscandidateinput.md b/docs/models/components/unifiedatscandidateinput.md index adcb9f62..18ecf6ef 100644 --- a/docs/models/components/unifiedatscandidateinput.md +++ b/docs/models/components/unifiedatscandidateinput.md @@ -3,22 +3,22 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `firstName` | *string* | :heavy_minus_sign: | The first name of the candidate | -| `lastName` | *string* | :heavy_minus_sign: | The last name of the candidate | -| `company` | *string* | :heavy_minus_sign: | The company of the candidate | -| `title` | *string* | :heavy_minus_sign: | The title of the candidate | -| `locations` | *string* | :heavy_minus_sign: | The locations of the candidate | -| `isPrivate` | *boolean* | :heavy_minus_sign: | Whether the candidate is private | -| `emailReachable` | *boolean* | :heavy_minus_sign: | Whether the candidate is reachable by email | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the candidate | -| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the candidate | -| `lastInteractionAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The last interaction date with the candidate | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachments UUIDs of the candidate | -| `applications` | *string*[] | :heavy_minus_sign: | The applications UUIDs of the candidate | -| `tags` | *string*[] | :heavy_minus_sign: | The tags of the candidate | -| `urls` | [components.Url](../../models/components/url.md)[] | :heavy_minus_sign: | The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER | -| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the candidate | -| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the candidate | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `firstName` | *string* | :heavy_minus_sign: | The first name of the candidate | Joe | +| `lastName` | *string* | :heavy_minus_sign: | The last name of the candidate | Doe | +| `company` | *string* | :heavy_minus_sign: | The company of the candidate | Acme | +| `title` | *string* | :heavy_minus_sign: | The title of the candidate | Analyst | +| `locations` | *string* | :heavy_minus_sign: | The locations of the candidate | New York | +| `isPrivate` | *boolean* | :heavy_minus_sign: | Whether the candidate is private | false | +| `emailReachable` | *boolean* | :heavy_minus_sign: | Whether the candidate is reachable by email | true | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the candidate | 2024-10-01T12:00:00Z | +| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the candidate | 2024-10-01T12:00:00Z | +| `lastInteractionAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The last interaction date with the candidate | 2024-10-01T12:00:00Z | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachments UUIDs of the candidate | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `applications` | *string*[] | :heavy_minus_sign: | The applications UUIDs of the candidate | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `tags` | *string*[] | :heavy_minus_sign: | The tags of the candidate | [
"tag_1",
"tag_2"
] | +| `urls` | [components.Url](../../models/components/url.md)[] | :heavy_minus_sign: | The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER | [
{
"url": "mywebsite.com",
"url_type": "WEBSITE"
}
] | +| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the candidate | [
{
"phone_number": "+33660688899",
"phone_type": "WORK"
}
] | +| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the candidate | [
{
"email_address": "joedoe@gmail.com",
"email_address_type": "WORK"
}
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedatscandidateoutput.md b/docs/models/components/unifiedatscandidateoutput.md index cdc104de..c2bf1834 100644 --- a/docs/models/components/unifiedatscandidateoutput.md +++ b/docs/models/components/unifiedatscandidateoutput.md @@ -3,27 +3,27 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `firstName` | *string* | :heavy_minus_sign: | The first name of the candidate | -| `lastName` | *string* | :heavy_minus_sign: | The last name of the candidate | -| `company` | *string* | :heavy_minus_sign: | The company of the candidate | -| `title` | *string* | :heavy_minus_sign: | The title of the candidate | -| `locations` | *string* | :heavy_minus_sign: | The locations of the candidate | -| `isPrivate` | *boolean* | :heavy_minus_sign: | Whether the candidate is private | -| `emailReachable` | *boolean* | :heavy_minus_sign: | Whether the candidate is reachable by email | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the candidate | -| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the candidate | -| `lastInteractionAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The last interaction date with the candidate | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachments UUIDs of the candidate | -| `applications` | *string*[] | :heavy_minus_sign: | The applications UUIDs of the candidate | -| `tags` | *string*[] | :heavy_minus_sign: | The tags of the candidate | -| `urls` | [components.Url](../../models/components/url.md)[] | :heavy_minus_sign: | The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER | -| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the candidate | -| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the candidate | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the candidate in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the candidate in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `firstName` | *string* | :heavy_minus_sign: | The first name of the candidate | Joe | +| `lastName` | *string* | :heavy_minus_sign: | The last name of the candidate | Doe | +| `company` | *string* | :heavy_minus_sign: | The company of the candidate | Acme | +| `title` | *string* | :heavy_minus_sign: | The title of the candidate | Analyst | +| `locations` | *string* | :heavy_minus_sign: | The locations of the candidate | New York | +| `isPrivate` | *boolean* | :heavy_minus_sign: | Whether the candidate is private | false | +| `emailReachable` | *boolean* | :heavy_minus_sign: | Whether the candidate is reachable by email | true | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the candidate | 2024-10-01T12:00:00Z | +| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the candidate | 2024-10-01T12:00:00Z | +| `lastInteractionAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The last interaction date with the candidate | 2024-10-01T12:00:00Z | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachments UUIDs of the candidate | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `applications` | *string*[] | :heavy_minus_sign: | The applications UUIDs of the candidate | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `tags` | *string*[] | :heavy_minus_sign: | The tags of the candidate | [
"tag_1",
"tag_2"
] | +| `urls` | [components.Url](../../models/components/url.md)[] | :heavy_minus_sign: | The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER | [
{
"url": "mywebsite.com",
"url_type": "WEBSITE"
}
] | +| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the candidate | [
{
"phone_number": "+33660688899",
"phone_type": "WORK"
}
] | +| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the candidate | [
{
"email_address": "joedoe@gmail.com",
"email_address_type": "WORK"
}
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the candidate in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the candidate in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsdepartmentoutput.md b/docs/models/components/unifiedatsdepartmentoutput.md index 114143d6..bbb03a8a 100644 --- a/docs/models/components/unifiedatsdepartmentoutput.md +++ b/docs/models/components/unifiedatsdepartmentoutput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | The name of the department | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the department | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the department in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the department in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the department | Sales | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the department | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the department in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the department in the context of the 3rd Party | {
"key1": "value1",
"key2": 42,
"key3": true
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2023-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatseeocsoutput.md b/docs/models/components/unifiedatseeocsoutput.md index 3c9b6094..d7e458b3 100644 --- a/docs/models/components/unifiedatseeocsoutput.md +++ b/docs/models/components/unifiedatseeocsoutput.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `submittedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The submission date of the EEOC | -| `race` | *string* | :heavy_minus_sign: | The race of the candidate | -| `gender` | *string* | :heavy_minus_sign: | The gender of the candidate | -| `veteranStatus` | *string* | :heavy_minus_sign: | The veteran status of the candidate | -| `disabilityStatus` | *string* | :heavy_minus_sign: | The disability status of the candidate | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the EEOC | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the EEOC in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the EEOC in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `candidateId` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `submittedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The submission date of the EEOC | 2024-10-01T12:00:00Z | +| `race` | [components.Race](../../models/components/race.md) | :heavy_minus_sign: | The race of the candidate | AMERICAN_INDIAN_OR_ALASKAN_NATIVE | +| `gender` | [components.Gender](../../models/components/gender.md) | :heavy_minus_sign: | The gender of the candidate | MALE | +| `veteranStatus` | [components.VeteranStatus](../../models/components/veteranstatus.md) | :heavy_minus_sign: | The veteran status of the candidate | I_AM_NOT_A_PROTECTED_VETERAN | +| `disabilityStatus` | [components.DisabilityStatus](../../models/components/disabilitystatus.md) | :heavy_minus_sign: | The disability status of the candidate | YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the EEOC | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the EEOC in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the EEOC in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsinterviewinput.md b/docs/models/components/unifiedatsinterviewinput.md index 83c12335..8766a1ac 100644 --- a/docs/models/components/unifiedatsinterviewinput.md +++ b/docs/models/components/unifiedatsinterviewinput.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_minus_sign: | The status of the interview | -| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | -| `jobInterviewStageId` | *string* | :heavy_minus_sign: | The UUID of the job interview stage | -| `organizedBy` | *string* | :heavy_minus_sign: | The UUID of the organizer | -| `interviewers` | *string*[] | :heavy_minus_sign: | The UUIDs of the interviewers | -| `location` | *string* | :heavy_minus_sign: | The location of the interview | -| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start date and time of the interview | -| `endAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end date and time of the interview | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the interview | -| `remoteUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the interview | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `status` | [components.UnifiedAtsInterviewInputStatus](../../models/components/unifiedatsinterviewinputstatus.md) | :heavy_minus_sign: | The status of the interview | SCHEDULED | +| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `jobInterviewStageId` | *string* | :heavy_minus_sign: | The UUID of the job interview stage | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `organizedBy` | *string* | :heavy_minus_sign: | The UUID of the organizer | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `interviewers` | *string*[] | :heavy_minus_sign: | The UUIDs of the interviewers | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `location` | *string* | :heavy_minus_sign: | The location of the interview | San Francisco | +| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start date and time of the interview | 2024-10-01T12:00:00Z | +| `endAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end date and time of the interview | 2024-10-01T12:00:00Z | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the interview | 2024-10-01T12:00:00Z | +| `remoteUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the interview | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedatsinterviewinputstatus.md b/docs/models/components/unifiedatsinterviewinputstatus.md new file mode 100644 index 00000000..886b8476 --- /dev/null +++ b/docs/models/components/unifiedatsinterviewinputstatus.md @@ -0,0 +1,12 @@ +# UnifiedAtsInterviewInputStatus + +The status of the interview + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `Scheduled` | SCHEDULED | +| `AwaitingFeedback` | AWAITING_FEEDBACK | +| `Completed` | COMPLETED | \ No newline at end of file diff --git a/docs/models/components/unifiedatsinterviewoutput.md b/docs/models/components/unifiedatsinterviewoutput.md index e4c33857..d889f441 100644 --- a/docs/models/components/unifiedatsinterviewoutput.md +++ b/docs/models/components/unifiedatsinterviewoutput.md @@ -3,21 +3,21 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `status` | *string* | :heavy_minus_sign: | The status of the interview | -| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | -| `jobInterviewStageId` | *string* | :heavy_minus_sign: | The UUID of the job interview stage | -| `organizedBy` | *string* | :heavy_minus_sign: | The UUID of the organizer | -| `interviewers` | *string*[] | :heavy_minus_sign: | The UUIDs of the interviewers | -| `location` | *string* | :heavy_minus_sign: | The location of the interview | -| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start date and time of the interview | -| `endAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end date and time of the interview | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the interview | -| `remoteUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the interview | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the interview | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the interview in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the interview in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `status` | [components.UnifiedAtsInterviewOutputStatus](../../models/components/unifiedatsinterviewoutputstatus.md) | :heavy_minus_sign: | The status of the interview | SCHEDULED | +| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `jobInterviewStageId` | *string* | :heavy_minus_sign: | The UUID of the job interview stage | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `organizedBy` | *string* | :heavy_minus_sign: | The UUID of the organizer | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `interviewers` | *string*[] | :heavy_minus_sign: | The UUIDs of the interviewers | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `location` | *string* | :heavy_minus_sign: | The location of the interview | San Francisco | +| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start date and time of the interview | 2024-10-01T12:00:00Z | +| `endAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end date and time of the interview | 2024-10-01T12:00:00Z | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the interview | 2024-10-01T12:00:00Z | +| `remoteUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the interview | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the interview | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the interview in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the interview in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsinterviewoutputstatus.md b/docs/models/components/unifiedatsinterviewoutputstatus.md new file mode 100644 index 00000000..e9a21b12 --- /dev/null +++ b/docs/models/components/unifiedatsinterviewoutputstatus.md @@ -0,0 +1,12 @@ +# UnifiedAtsInterviewOutputStatus + +The status of the interview + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `Scheduled` | SCHEDULED | +| `AwaitingFeedback` | AWAITING_FEEDBACK | +| `Completed` | COMPLETED | \ No newline at end of file diff --git a/docs/models/components/unifiedatsjobinterviewstageoutput.md b/docs/models/components/unifiedatsjobinterviewstageoutput.md index ce0813ff..1e3e117e 100644 --- a/docs/models/components/unifiedatsjobinterviewstageoutput.md +++ b/docs/models/components/unifiedatsjobinterviewstageoutput.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | The name of the job interview stage | -| `stageOrder` | *number* | :heavy_minus_sign: | The order of the stage | -| `jobId` | *string* | :heavy_minus_sign: | The UUID of the job | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the job interview stage | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the job interview stage in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the job interview stage in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the job interview stage | Second Call | +| `stageOrder` | *number* | :heavy_minus_sign: | The order of the stage | 1 | +| `jobId` | *string* | :heavy_minus_sign: | The UUID of the job | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the job interview stage | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the job interview stage in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the job interview stage in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsjoboutput.md b/docs/models/components/unifiedatsjoboutput.md index 511a9f01..69ee1627 100644 --- a/docs/models/components/unifiedatsjoboutput.md +++ b/docs/models/components/unifiedatsjoboutput.md @@ -3,23 +3,23 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | The name of the job | -| `description` | *string* | :heavy_minus_sign: | The description of the job | -| `code` | *string* | :heavy_minus_sign: | The code of the job | -| `status` | *string* | :heavy_minus_sign: | The status of the job | -| `type` | *string* | :heavy_minus_sign: | The type of the job | -| `confidential` | *boolean* | :heavy_minus_sign: | Whether the job is confidential | -| `departments` | *string*[] | :heavy_minus_sign: | The departments UUIDs associated with the job | -| `offices` | *string*[] | :heavy_minus_sign: | The offices UUIDs associated with the job | -| `managers` | *string*[] | :heavy_minus_sign: | The managers UUIDs associated with the job | -| `recruiters` | *string*[] | :heavy_minus_sign: | The recruiters UUIDs associated with the job | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the job | -| `remoteUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the job | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the job | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the job in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the job in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the job | Financial Analyst | +| `description` | *string* | :heavy_minus_sign: | The description of the job | Extract financial data and write detailed investment thesis | +| `code` | *string* | :heavy_minus_sign: | The code of the job | JOB123 | +| `status` | [components.UnifiedAtsJobOutputStatus](../../models/components/unifiedatsjoboutputstatus.md) | :heavy_minus_sign: | The status of the job | OPEN | +| `type` | [components.UnifiedAtsJobOutputType](../../models/components/unifiedatsjoboutputtype.md) | :heavy_minus_sign: | The type of the job | POSTING | +| `confidential` | *boolean* | :heavy_minus_sign: | Whether the job is confidential | true | +| `departments` | *string*[] | :heavy_minus_sign: | The departments UUIDs associated with the job | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `offices` | *string*[] | :heavy_minus_sign: | The offices UUIDs associated with the job | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `managers` | *string*[] | :heavy_minus_sign: | The managers UUIDs associated with the job | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `recruiters` | *string*[] | :heavy_minus_sign: | The recruiters UUIDs associated with the job | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the job | 2024-10-01T12:00:00Z | +| `remoteUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the job | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the job | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the job in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the job in the context of the 3rd Party | {
"key1": "value1",
"key2": 42,
"key3": true
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2023-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsjoboutputstatus.md b/docs/models/components/unifiedatsjoboutputstatus.md new file mode 100644 index 00000000..9ce4ca53 --- /dev/null +++ b/docs/models/components/unifiedatsjoboutputstatus.md @@ -0,0 +1,14 @@ +# UnifiedAtsJobOutputStatus + +The status of the job + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Open` | OPEN | +| `Closed` | CLOSED | +| `Draft` | DRAFT | +| `Archived` | ARCHIVED | +| `Pending` | PENDING | \ No newline at end of file diff --git a/docs/models/components/unifiedatsjoboutputtype.md b/docs/models/components/unifiedatsjoboutputtype.md new file mode 100644 index 00000000..c2c768d5 --- /dev/null +++ b/docs/models/components/unifiedatsjoboutputtype.md @@ -0,0 +1,12 @@ +# UnifiedAtsJobOutputType + +The type of the job + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Posting` | POSTING | +| `Requisition` | REQUISITION | +| `Profile` | PROFILE | \ No newline at end of file diff --git a/docs/models/components/unifiedatsofferoutput.md b/docs/models/components/unifiedatsofferoutput.md index 80b7a8c0..84d707a5 100644 --- a/docs/models/components/unifiedatsofferoutput.md +++ b/docs/models/components/unifiedatsofferoutput.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `createdBy` | *string* | :heavy_minus_sign: | The UUID of the creator | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the offer | -| `closedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The closing date of the offer | -| `sentAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The sending date of the offer | -| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start date of the offer | -| `status` | *string* | :heavy_minus_sign: | The status of the offer | -| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the offer | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the offer in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the offer in the context of the 3rd Party | -| `createdAt` | [components.UnifiedAtsOfferOutputCreatedAt](../../models/components/unifiedatsofferoutputcreatedat.md) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [components.UnifiedAtsOfferOutputModifiedAt](../../models/components/unifiedatsofferoutputmodifiedat.md) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `createdBy` | *string* | :heavy_minus_sign: | The UUID of the creator | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the offer | 2024-10-01T12:00:00Z | +| `closedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The closing date of the offer | 2024-10-01T12:00:00Z | +| `sentAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The sending date of the offer | 2024-10-01T12:00:00Z | +| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start date of the offer | 2024-10-01T12:00:00Z | +| `status` | [components.UnifiedAtsOfferOutputStatus](../../models/components/unifiedatsofferoutputstatus.md) | :heavy_minus_sign: | The status of the offer | DRAFT | +| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the offer | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the offer in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the offer in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [components.UnifiedAtsOfferOutputCreatedAt](../../models/components/unifiedatsofferoutputcreatedat.md) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [components.UnifiedAtsOfferOutputModifiedAt](../../models/components/unifiedatsofferoutputmodifiedat.md) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsofferoutputstatus.md b/docs/models/components/unifiedatsofferoutputstatus.md new file mode 100644 index 00000000..58e8fa9e --- /dev/null +++ b/docs/models/components/unifiedatsofferoutputstatus.md @@ -0,0 +1,18 @@ +# UnifiedAtsOfferOutputStatus + +The status of the offer + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Draft` | DRAFT | +| `ApprovalSent` | APPROVAL_SENT | +| `Approved` | APPROVED | +| `Sent` | SENT | +| `SentManually` | SENT_MANUALLY | +| `Opened` | OPENED | +| `Denied` | DENIED | +| `Signed` | SIGNED | +| `Deprecated` | DEPRECATED | \ No newline at end of file diff --git a/docs/models/components/unifiedatsofficeoutput.md b/docs/models/components/unifiedatsofficeoutput.md index 8c5bd1d9..355b65d1 100644 --- a/docs/models/components/unifiedatsofficeoutput.md +++ b/docs/models/components/unifiedatsofficeoutput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | The name of the office | -| `location` | *string* | :heavy_minus_sign: | The location of the office | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the office | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the office in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the office in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the office | Condo Office 5th | +| `location` | *string* | :heavy_minus_sign: | The location of the office | New York | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the office | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the office in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the office in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsrejectreasonoutput.md b/docs/models/components/unifiedatsrejectreasonoutput.md index 30599345..a18f0d13 100644 --- a/docs/models/components/unifiedatsrejectreasonoutput.md +++ b/docs/models/components/unifiedatsrejectreasonoutput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | The name of the reject reason | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the reject reason | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the reject reason in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the reject reason in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the reject reason | Candidate inexperienced | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the reject reason | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the reject reason in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the reject reason in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsscorecardoutput.md b/docs/models/components/unifiedatsscorecardoutput.md index 2f4fa779..35edcd16 100644 --- a/docs/models/components/unifiedatsscorecardoutput.md +++ b/docs/models/components/unifiedatsscorecardoutput.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `overallRecommendation` | *string* | :heavy_minus_sign: | The overall recommendation | -| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | -| `interviewId` | *string* | :heavy_minus_sign: | The UUID of the interview | -| `remoteCreatedAt` | *string* | :heavy_minus_sign: | The remote creation date of the scorecard | -| `submittedAt` | *string* | :heavy_minus_sign: | The submission date of the scorecard | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the scorecard | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the scorecard in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the scorecard in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `overallRecommendation` | [components.OverallRecommendation](../../models/components/overallrecommendation.md) | :heavy_minus_sign: | The overall recommendation | YES | +| `applicationId` | *string* | :heavy_minus_sign: | The UUID of the application | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `interviewId` | *string* | :heavy_minus_sign: | The UUID of the interview | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the scorecard | 2024-10-01T12:00:00Z | +| `submittedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The submission date of the scorecard | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the scorecard | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the scorecard in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the scorecard in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatstagoutput.md b/docs/models/components/unifiedatstagoutput.md index 09815208..47e74e92 100644 --- a/docs/models/components/unifiedatstagoutput.md +++ b/docs/models/components/unifiedatstagoutput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | The name of the tag | -| `idAtsCandidate` | *string* | :heavy_minus_sign: | The UUID of the candidate | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the tag | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the tag in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the tag in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The creation date of the tag | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modification date of the tag | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_minus_sign: | The name of the tag | Important | +| `idAtsCandidate` | *string* | :heavy_minus_sign: | The UUID of the candidate | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the tag | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the tag in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the tag in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The creation date of the tag | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modification date of the tag | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedatsuseroutput.md b/docs/models/components/unifiedatsuseroutput.md index e4e7df52..5ff8e9c0 100644 --- a/docs/models/components/unifiedatsuseroutput.md +++ b/docs/models/components/unifiedatsuseroutput.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `firstName` | *string* | :heavy_minus_sign: | The first name of the user | -| `lastName` | *string* | :heavy_minus_sign: | The last name of the user | -| `email` | *string* | :heavy_minus_sign: | The email of the user | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether the user is disabled | -| `accessRole` | *string* | :heavy_minus_sign: | The access role of the user | -| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the user | -| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the user | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the user | -| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the user in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `firstName` | *string* | :heavy_minus_sign: | The first name of the user | John | +| `lastName` | *string* | :heavy_minus_sign: | The last name of the user | Doe | +| `email` | *string* | :heavy_minus_sign: | The email of the user | john.doe@example.com | +| `disabled` | *boolean* | :heavy_minus_sign: | Whether the user is disabled | false | +| `accessRole` | [components.AccessRole](../../models/components/accessrole.md) | :heavy_minus_sign: | The access role of the user | ADMIN | +| `remoteCreatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote creation date of the user | 2024-10-01T12:00:00Z | +| `remoteModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The remote modification date of the user | 2024-10-01T12:00:00Z | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the user | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the user in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmcompanyinput.md b/docs/models/components/unifiedcrmcompanyinput.md index e3d5ab45..0abae6cf 100644 --- a/docs/models/components/unifiedcrmcompanyinput.md +++ b/docs/models/components/unifiedcrmcompanyinput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the company | -| `industry` | *string* | :heavy_minus_sign: | The industry of the company. Authorized values can be found in the Industry enum. | -| `numberOfEmployees` | *number* | :heavy_minus_sign: | The number of employees of the company | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the company | -| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the company | -| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the company | -| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the company | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the company | Acme | +| `industry` | [components.UnifiedCrmCompanyInputIndustry](../../models/components/unifiedcrmcompanyinputindustry.md) | :heavy_minus_sign: | The industry of the company. Authorized values can be found in the Industry enum. | ACCOUNTING | +| `numberOfEmployees` | *number* | :heavy_minus_sign: | The number of employees of the company | 10 | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the company | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the company | [
{
"email_address": "acme@gmail.com",
"email_address_type": "WORK"
}
] | +| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the company | [
{
"street_1": "5th Avenue",
"city": "New York",
"state": "NY",
"country": "USA",
"address_type": "WORK"
}
] | +| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the company | [
{
"phone_number": "+33660606067",
"phone_type": "WORK"
}
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmcompanyinputindustry.md b/docs/models/components/unifiedcrmcompanyinputindustry.md new file mode 100644 index 00000000..5eb3e9bd --- /dev/null +++ b/docs/models/components/unifiedcrmcompanyinputindustry.md @@ -0,0 +1,156 @@ +# UnifiedCrmCompanyInputIndustry + +The industry of the company. Authorized values can be found in the Industry enum. + + +## Values + +| Name | Value | +| ------------------------------------ | ------------------------------------ | +| `Accounting` | ACCOUNTING | +| `AirlinesAviation` | AIRLINES_AVIATION | +| `AlternativeDisputeResolution` | ALTERNATIVE_DISPUTE_RESOLUTION | +| `AlternativeMedicine` | ALTERNATIVE_MEDICINE | +| `Animation` | ANIMATION | +| `ApparelFashion` | APPAREL_FASHION | +| `ArchitecturePlanning` | ARCHITECTURE_PLANNING | +| `ArtsAndCrafts` | ARTS_AND_CRAFTS | +| `Automotive` | AUTOMOTIVE | +| `AviationAerospace` | AVIATION_AEROSPACE | +| `Banking` | BANKING | +| `Biotechnology` | BIOTECHNOLOGY | +| `BroadcastMedia` | BROADCAST_MEDIA | +| `BuildingMaterials` | BUILDING_MATERIALS | +| `BusinessSuppliesAndEquipment` | BUSINESS_SUPPLIES_AND_EQUIPMENT | +| `CapitalMarkets` | CAPITAL_MARKETS | +| `Chemicals` | CHEMICALS | +| `CivicSocialOrganization` | CIVIC_SOCIAL_ORGANIZATION | +| `CivilEngineering` | CIVIL_ENGINEERING | +| `CommercialRealEstate` | COMMERCIAL_REAL_ESTATE | +| `ComputerNetworkSecurity` | COMPUTER_NETWORK_SECURITY | +| `ComputerGames` | COMPUTER_GAMES | +| `ComputerHardware` | COMPUTER_HARDWARE | +| `ComputerNetworking` | COMPUTER_NETWORKING | +| `ComputerSoftware` | COMPUTER_SOFTWARE | +| `Internet` | INTERNET | +| `Construction` | CONSTRUCTION | +| `ConsumerElectronics` | CONSUMER_ELECTRONICS | +| `ConsumerGoods` | CONSUMER_GOODS | +| `ConsumerServices` | CONSUMER_SERVICES | +| `Cosmetics` | COSMETICS | +| `Dairy` | DAIRY | +| `DefenseSpace` | DEFENSE_SPACE | +| `Design` | DESIGN | +| `EducationManagement` | EDUCATION_MANAGEMENT | +| `ELearning` | E_LEARNING | +| `ElectricalElectronicManufacturing` | ELECTRICAL_ELECTRONIC_MANUFACTURING | +| `Entertainment` | ENTERTAINMENT | +| `EnvironmentalServices` | ENVIRONMENTAL_SERVICES | +| `EventsServices` | EVENTS_SERVICES | +| `ExecutiveOffice` | EXECUTIVE_OFFICE | +| `FacilitiesServices` | FACILITIES_SERVICES | +| `Farming` | FARMING | +| `FinancialServices` | FINANCIAL_SERVICES | +| `FineArt` | FINE_ART | +| `Fishery` | FISHERY | +| `FoodBeverages` | FOOD_BEVERAGES | +| `FoodProduction` | FOOD_PRODUCTION | +| `FundRaising` | FUND_RAISING | +| `Furniture` | FURNITURE | +| `GamblingCasinos` | GAMBLING_CASINOS | +| `GlassCeramicsConcrete` | GLASS_CERAMICS_CONCRETE | +| `GovernmentAdministration` | GOVERNMENT_ADMINISTRATION | +| `GovernmentRelations` | GOVERNMENT_RELATIONS | +| `GraphicDesign` | GRAPHIC_DESIGN | +| `HealthWellnessAndFitness` | HEALTH_WELLNESS_AND_FITNESS | +| `HigherEducation` | HIGHER_EDUCATION | +| `HospitalHealthCare` | HOSPITAL_HEALTH_CARE | +| `Hospitality` | HOSPITALITY | +| `HumanResources` | HUMAN_RESOURCES | +| `ImportAndExport` | IMPORT_AND_EXPORT | +| `IndividualFamilyServices` | INDIVIDUAL_FAMILY_SERVICES | +| `IndustrialAutomation` | INDUSTRIAL_AUTOMATION | +| `InformationServices` | INFORMATION_SERVICES | +| `InformationTechnologyAndServices` | INFORMATION_TECHNOLOGY_AND_SERVICES | +| `Insurance` | INSURANCE | +| `InternationalAffairs` | INTERNATIONAL_AFFAIRS | +| `InternationalTradeAndDevelopment` | INTERNATIONAL_TRADE_AND_DEVELOPMENT | +| `InvestmentBanking` | INVESTMENT_BANKING | +| `InvestmentManagement` | INVESTMENT_MANAGEMENT | +| `Judiciary` | JUDICIARY | +| `LawEnforcement` | LAW_ENFORCEMENT | +| `LawPractice` | LAW_PRACTICE | +| `LegalServices` | LEGAL_SERVICES | +| `LegislativeOffice` | LEGISLATIVE_OFFICE | +| `LeisureTravelTourism` | LEISURE_TRAVEL_TOURISM | +| `Libraries` | LIBRARIES | +| `LogisticsAndSupplyChain` | LOGISTICS_AND_SUPPLY_CHAIN | +| `LuxuryGoodsJewelry` | LUXURY_GOODS_JEWELRY | +| `Machinery` | MACHINERY | +| `ManagementConsulting` | MANAGEMENT_CONSULTING | +| `Maritime` | MARITIME | +| `MarketResearch` | MARKET_RESEARCH | +| `MarketingAndAdvertising` | MARKETING_AND_ADVERTISING | +| `MechanicalOrIndustrialEngineering` | MECHANICAL_OR_INDUSTRIAL_ENGINEERING | +| `MediaProduction` | MEDIA_PRODUCTION | +| `MedicalDevices` | MEDICAL_DEVICES | +| `MedicalPractice` | MEDICAL_PRACTICE | +| `MentalHealthCare` | MENTAL_HEALTH_CARE | +| `Military` | MILITARY | +| `MiningMetals` | MINING_METALS | +| `MotionPicturesAndFilm` | MOTION_PICTURES_AND_FILM | +| `MuseumsAndInstitutions` | MUSEUMS_AND_INSTITUTIONS | +| `Music` | MUSIC | +| `Nanotechnology` | NANOTECHNOLOGY | +| `Newspapers` | NEWSPAPERS | +| `NonProfitOrganizationManagement` | NON_PROFIT_ORGANIZATION_MANAGEMENT | +| `OilEnergy` | OIL_ENERGY | +| `OnlineMedia` | ONLINE_MEDIA | +| `OutsourcingOffshoring` | OUTSOURCING_OFFSHORING | +| `PackageFreightDelivery` | PACKAGE_FREIGHT_DELIVERY | +| `PackagingAndContainers` | PACKAGING_AND_CONTAINERS | +| `PaperForestProducts` | PAPER_FOREST_PRODUCTS | +| `PerformingArts` | PERFORMING_ARTS | +| `Pharmaceuticals` | PHARMACEUTICALS | +| `Philanthropy` | PHILANTHROPY | +| `Photography` | PHOTOGRAPHY | +| `Plastics` | PLASTICS | +| `PoliticalOrganization` | POLITICAL_ORGANIZATION | +| `PrimarySecondaryEducation` | PRIMARY_SECONDARY_EDUCATION | +| `Printing` | PRINTING | +| `ProfessionalTrainingCoaching` | PROFESSIONAL_TRAINING_COACHING | +| `ProgramDevelopment` | PROGRAM_DEVELOPMENT | +| `PublicPolicy` | PUBLIC_POLICY | +| `PublicRelationsAndCommunications` | PUBLIC_RELATIONS_AND_COMMUNICATIONS | +| `PublicSafety` | PUBLIC_SAFETY | +| `Publishing` | PUBLISHING | +| `RailroadManufacture` | RAILROAD_MANUFACTURE | +| `Ranching` | RANCHING | +| `RealEstate` | REAL_ESTATE | +| `RecreationalFacilitiesAndServices` | RECREATIONAL_FACILITIES_AND_SERVICES | +| `ReligiousInstitutions` | RELIGIOUS_INSTITUTIONS | +| `RenewablesEnvironment` | RENEWABLES_ENVIRONMENT | +| `Research` | RESEARCH | +| `Restaurants` | RESTAURANTS | +| `Retail` | RETAIL | +| `SecurityAndInvestigations` | SECURITY_AND_INVESTIGATIONS | +| `Semiconductors` | SEMICONDUCTORS | +| `Shipbuilding` | SHIPBUILDING | +| `SportingGoods` | SPORTING_GOODS | +| `Sports` | SPORTS | +| `StaffingAndRecruiting` | STAFFING_AND_RECRUITING | +| `Supermarkets` | SUPERMARKETS | +| `Telecommunications` | TELECOMMUNICATIONS | +| `Textiles` | TEXTILES | +| `ThinkTanks` | THINK_TANKS | +| `Tobacco` | TOBACCO | +| `TranslationAndLocalization` | TRANSLATION_AND_LOCALIZATION | +| `TransportationTruckingRailroad` | TRANSPORTATION_TRUCKING_RAILROAD | +| `Utilities` | UTILITIES | +| `VentureCapitalPrivateEquity` | VENTURE_CAPITAL_PRIVATE_EQUITY | +| `Veterinary` | VETERINARY | +| `Warehousing` | WAREHOUSING | +| `Wholesale` | WHOLESALE | +| `WineAndSpirits` | WINE_AND_SPIRITS | +| `Wireless` | WIRELESS | +| `WritingAndEditing` | WRITING_AND_EDITING | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmcompanyoutput.md b/docs/models/components/unifiedcrmcompanyoutput.md index 1de5e592..7e9eecb0 100644 --- a/docs/models/components/unifiedcrmcompanyoutput.md +++ b/docs/models/components/unifiedcrmcompanyoutput.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the company | -| `industry` | *string* | :heavy_minus_sign: | The industry of the company. Authorized values can be found in the Industry enum. | -| `numberOfEmployees` | *number* | :heavy_minus_sign: | The number of employees of the company | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the company | -| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the company | -| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the company | -| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the company | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the company | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the company in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the company in the context of the Crm 3rd Party | -| `createdAt` | [components.CreatedAt](../../models/components/createdat.md) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [components.ModifiedAt](../../models/components/modifiedat.md) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the company | Acme | +| `industry` | [components.Industry](../../models/components/industry.md) | :heavy_minus_sign: | The industry of the company. Authorized values can be found in the Industry enum. | ACCOUNTING | +| `numberOfEmployees` | *number* | :heavy_minus_sign: | The number of employees of the company | 10 | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the company | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the company | [
{
"email_address": "acme@gmail.com",
"email_address_type": "WORK"
}
] | +| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the company | [
{
"street_1": "5th Avenue",
"city": "New York",
"state": "NY",
"country": "USA",
"address_type": "WORK"
}
] | +| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the company | [
{
"phone_number": "+33660606067",
"phone_type": "WORK"
}
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the company | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the company in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the company in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [components.CreatedAt](../../models/components/createdat.md) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [components.ModifiedAt](../../models/components/modifiedat.md) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmcontactinput.md b/docs/models/components/unifiedcrmcontactinput.md index 4bd5b2eb..d3e2dee5 100644 --- a/docs/models/components/unifiedcrmcontactinput.md +++ b/docs/models/components/unifiedcrmcontactinput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `firstName` | *string* | :heavy_check_mark: | The first name of the contact | -| `lastName` | *string* | :heavy_check_mark: | The last name of the contact | -| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the contact | -| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the contact | -| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the contact | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the contact | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the contact between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `firstName` | *string* | :heavy_check_mark: | The first name of the contact | John | +| `lastName` | *string* | :heavy_check_mark: | The last name of the contact | Doe | +| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the contact | [
{
"email": "john.doe@example.com",
"type": "WORK"
}
] | +| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the contact | [
{
"phone": "1234567890",
"type": "WORK"
}
] | +| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the contact | [
{
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345",
"country": "USA",
"type": "WORK"
}
] | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the contact | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the contact between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmcontactoutput.md b/docs/models/components/unifiedcrmcontactoutput.md index b7f54feb..3276763e 100644 --- a/docs/models/components/unifiedcrmcontactoutput.md +++ b/docs/models/components/unifiedcrmcontactoutput.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `firstName` | *string* | :heavy_check_mark: | The first name of the contact | -| `lastName` | *string* | :heavy_check_mark: | The last name of the contact | -| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the contact | -| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the contact | -| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the contact | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the contact | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the contact between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the contact | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the contact in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the contact in the context of the Crm 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `firstName` | *string* | :heavy_check_mark: | The first name of the contact | John | +| `lastName` | *string* | :heavy_check_mark: | The last name of the contact | Doe | +| `emailAddresses` | [components.Email](../../models/components/email.md)[] | :heavy_minus_sign: | The email addresses of the contact | [
{
"email": "john.doe@example.com",
"type": "WORK"
}
] | +| `phoneNumbers` | [components.Phone](../../models/components/phone.md)[] | :heavy_minus_sign: | The phone numbers of the contact | [
{
"phone": "1234567890",
"type": "WORK"
}
] | +| `addresses` | [components.Address](../../models/components/address.md)[] | :heavy_minus_sign: | The addresses of the contact | [
{
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345",
"country": "USA",
"type": "WORK"
}
] | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who owns the contact | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the contact between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the contact | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the contact in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the contact in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmdealinput.md b/docs/models/components/unifiedcrmdealinput.md index 144318ef..f5bdc027 100644 --- a/docs/models/components/unifiedcrmdealinput.md +++ b/docs/models/components/unifiedcrmdealinput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `name` | *string* | :heavy_check_mark: | The name of the deal | -| `description` | *string* | :heavy_check_mark: | The description of the deal | -| `amount` | *number* | :heavy_check_mark: | The amount of the deal | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who is on the deal | -| `stageId` | *string* | :heavy_minus_sign: | The UUID of the stage of the deal | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the deal | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `name` | *string* | :heavy_check_mark: | The name of the deal | Huge Contract with Acme | +| `description` | *string* | :heavy_check_mark: | The description of the deal | Contract with Sales Operations Team | +| `amount` | *number* | :heavy_check_mark: | The amount of the deal | 1000 | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who is on the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `stageId` | *string* | :heavy_minus_sign: | The UUID of the stage of the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmdealoutput.md b/docs/models/components/unifiedcrmdealoutput.md index 4e1fe93f..2908b1b8 100644 --- a/docs/models/components/unifiedcrmdealoutput.md +++ b/docs/models/components/unifiedcrmdealoutput.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the deal | -| `description` | *string* | :heavy_check_mark: | The description of the deal | -| `amount` | *number* | :heavy_check_mark: | The amount of the deal | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who is on the deal | -| `stageId` | *string* | :heavy_minus_sign: | The UUID of the stage of the deal | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the deal | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the deal | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the deal in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the deal in the context of the Crm 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the deal | Huge Contract with Acme | +| `description` | *string* | :heavy_check_mark: | The description of the deal | Contract with Sales Operations Team | +| `amount` | *number* | :heavy_check_mark: | The amount of the deal | 1000 | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user who is on the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `stageId` | *string* | :heavy_minus_sign: | The UUID of the stage of the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the company between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the deal | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the deal in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the deal in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmengagementinput.md b/docs/models/components/unifiedcrmengagementinput.md index 18fd4289..a5077630 100644 --- a/docs/models/components/unifiedcrmengagementinput.md +++ b/docs/models/components/unifiedcrmengagementinput.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `content` | *string* | :heavy_minus_sign: | The content of the engagement | -| `direction` | *string* | :heavy_minus_sign: | The direction of the engagement. Authorized values are INBOUND or OUTBOUND | -| `subject` | *string* | :heavy_minus_sign: | The subject of the engagement | -| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the engagement | -| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the engagement | -| `type` | *string* | :heavy_check_mark: | The type of the engagement. Authorized values are EMAIL, CALL or MEETING | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the engagement | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the engagement | -| `contacts` | *string*[] | :heavy_minus_sign: | The UUIDs of contacts tied to the engagement object | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the engagement between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `content` | *string* | :heavy_minus_sign: | The content of the engagement | Meeting call with CTO | +| `direction` | [components.UnifiedCrmEngagementInputDirection](../../models/components/unifiedcrmengagementinputdirection.md) | :heavy_minus_sign: | The direction of the engagement. Authorized values are INBOUND or OUTBOUND | INBOUND | +| `subject` | *string* | :heavy_minus_sign: | The subject of the engagement | Technical features planning | +| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the engagement | 2024-10-01T12:00:00Z | +| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the engagement | 2024-10-01T22:00:00Z | +| `type` | [components.UnifiedCrmEngagementInputType](../../models/components/unifiedcrmengagementinputtype.md) | :heavy_check_mark: | The type of the engagement. Authorized values are EMAIL, CALL or MEETING | MEETING | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the engagement | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the engagement | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contacts` | *string*[] | :heavy_minus_sign: | The UUIDs of contacts tied to the engagement object | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the engagement between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmengagementinputdirection.md b/docs/models/components/unifiedcrmengagementinputdirection.md new file mode 100644 index 00000000..f3d45f10 --- /dev/null +++ b/docs/models/components/unifiedcrmengagementinputdirection.md @@ -0,0 +1,11 @@ +# UnifiedCrmEngagementInputDirection + +The direction of the engagement. Authorized values are INBOUND or OUTBOUND + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Inbound` | INBOUND | +| `Outbound` | OUTBOUND | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmengagementinputtype.md b/docs/models/components/unifiedcrmengagementinputtype.md new file mode 100644 index 00000000..ed4569cc --- /dev/null +++ b/docs/models/components/unifiedcrmengagementinputtype.md @@ -0,0 +1,12 @@ +# UnifiedCrmEngagementInputType + +The type of the engagement. Authorized values are EMAIL, CALL or MEETING + + +## Values + +| Name | Value | +| --------- | --------- | +| `Email` | EMAIL | +| `Call` | CALL | +| `Meeting` | MEETING | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmengagementoutput.md b/docs/models/components/unifiedcrmengagementoutput.md index e21fd85d..8d5a279d 100644 --- a/docs/models/components/unifiedcrmengagementoutput.md +++ b/docs/models/components/unifiedcrmengagementoutput.md @@ -3,20 +3,20 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `content` | *string* | :heavy_minus_sign: | The content of the engagement | -| `direction` | *string* | :heavy_minus_sign: | The direction of the engagement. Authorized values are INBOUND or OUTBOUND | -| `subject` | *string* | :heavy_minus_sign: | The subject of the engagement | -| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the engagement | -| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the engagement | -| `type` | *string* | :heavy_check_mark: | The type of the engagement. Authorized values are EMAIL, CALL or MEETING | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the engagement | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the engagement | -| `contacts` | *string*[] | :heavy_minus_sign: | The UUIDs of contacts tied to the engagement object | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the engagement between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the engagement | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the engagement in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the engagement in the context of the Crm 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `content` | *string* | :heavy_minus_sign: | The content of the engagement | Meeting call with CTO | +| `direction` | [components.Direction](../../models/components/direction.md) | :heavy_minus_sign: | The direction of the engagement. Authorized values are INBOUND or OUTBOUND | INBOUND | +| `subject` | *string* | :heavy_minus_sign: | The subject of the engagement | Technical features planning | +| `startAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the engagement | 2024-10-01T12:00:00Z | +| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the engagement | 2024-10-01T22:00:00Z | +| `type` | [components.UnifiedCrmEngagementOutputType](../../models/components/unifiedcrmengagementoutputtype.md) | :heavy_check_mark: | The type of the engagement. Authorized values are EMAIL, CALL or MEETING | MEETING | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the engagement | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the engagement | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contacts` | *string*[] | :heavy_minus_sign: | The UUIDs of contacts tied to the engagement object | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the engagement between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the engagement | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the engagement in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the engagement in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmengagementoutputtype.md b/docs/models/components/unifiedcrmengagementoutputtype.md new file mode 100644 index 00000000..8280419f --- /dev/null +++ b/docs/models/components/unifiedcrmengagementoutputtype.md @@ -0,0 +1,12 @@ +# UnifiedCrmEngagementOutputType + +The type of the engagement. Authorized values are EMAIL, CALL or MEETING + + +## Values + +| Name | Value | +| --------- | --------- | +| `Email` | EMAIL | +| `Call` | CALL | +| `Meeting` | MEETING | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmnoteinput.md b/docs/models/components/unifiedcrmnoteinput.md index 6568d5b2..87cbaee3 100644 --- a/docs/models/components/unifiedcrmnoteinput.md +++ b/docs/models/components/unifiedcrmnoteinput.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `content` | *string* | :heavy_check_mark: | The content of the note | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied the note | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the note | -| `contactId` | *string* | :heavy_minus_sign: | The UUID fo the contact tied to the note | -| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the note | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the note between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `content` | *string* | :heavy_check_mark: | The content of the note | My notes taken during the meeting | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the note between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmnoteoutput.md b/docs/models/components/unifiedcrmnoteoutput.md index 00c13f60..22d537e0 100644 --- a/docs/models/components/unifiedcrmnoteoutput.md +++ b/docs/models/components/unifiedcrmnoteoutput.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `content` | *string* | :heavy_check_mark: | The content of the note | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied the note | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the note | -| `contactId` | *string* | :heavy_minus_sign: | The UUID fo the contact tied to the note | -| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the note | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the note between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the note | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the note in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the note in the context of the Crm 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `content` | *string* | :heavy_check_mark: | The content of the note | My notes taken during the meeting | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the note between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the note | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The ID of the note in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the note in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmstageoutput.md b/docs/models/components/unifiedcrmstageoutput.md index 8a264f49..c707e12d 100644 --- a/docs/models/components/unifiedcrmstageoutput.md +++ b/docs/models/components/unifiedcrmstageoutput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `stageName` | *string* | :heavy_check_mark: | The name of the stage | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the stage between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the stage | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the stage in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the stage in the context of the Crm 3rd Party | -| `createdAt` | [components.UnifiedCrmStageOutputCreatedAt](../../models/components/unifiedcrmstageoutputcreatedat.md) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [components.UnifiedCrmStageOutputModifiedAt](../../models/components/unifiedcrmstageoutputmodifiedat.md) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `stageName` | *string* | :heavy_check_mark: | The name of the stage | Qualified | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the stage between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the stage | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The ID of the stage in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the stage in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [components.UnifiedCrmStageOutputCreatedAt](../../models/components/unifiedcrmstageoutputcreatedat.md) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [components.UnifiedCrmStageOutputModifiedAt](../../models/components/unifiedcrmstageoutputmodifiedat.md) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmtaskinput.md b/docs/models/components/unifiedcrmtaskinput.md index 2257a855..142256e0 100644 --- a/docs/models/components/unifiedcrmtaskinput.md +++ b/docs/models/components/unifiedcrmtaskinput.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `subject` | *string* | :heavy_check_mark: | The subject of the task | -| `content` | *string* | :heavy_check_mark: | The content of the task | -| `status` | *string* | :heavy_check_mark: | The status of the task. Authorized values are PENDING, COMPLETED. | -| `dueDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The due date of the task | -| `finishedDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The finished date of the task | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the task | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the task | -| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the task | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the task between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `subject` | *string* | :heavy_check_mark: | The subject of the task | Answer customers | +| `content` | *string* | :heavy_check_mark: | The content of the task | Prepare email campaign | +| `status` | [components.UnifiedCrmTaskInputStatus](../../models/components/unifiedcrmtaskinputstatus.md) | :heavy_check_mark: | The status of the task. Authorized values are PENDING, COMPLETED. | PENDING | +| `dueDate` | *string* | :heavy_minus_sign: | The due date of the task | 2024-10-01T12:00:00Z | +| `finishedDate` | *string* | :heavy_minus_sign: | The finished date of the task | 2024-10-01T12:00:00Z | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the task between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmtaskinputstatus.md b/docs/models/components/unifiedcrmtaskinputstatus.md new file mode 100644 index 00000000..55238e06 --- /dev/null +++ b/docs/models/components/unifiedcrmtaskinputstatus.md @@ -0,0 +1,11 @@ +# UnifiedCrmTaskInputStatus + +The status of the task. Authorized values are PENDING, COMPLETED. + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `Pending` | PENDING | +| `Completed` | COMPLETED | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmtaskoutput.md b/docs/models/components/unifiedcrmtaskoutput.md index a2a51354..44fa2131 100644 --- a/docs/models/components/unifiedcrmtaskoutput.md +++ b/docs/models/components/unifiedcrmtaskoutput.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `subject` | *string* | :heavy_check_mark: | The subject of the task | -| `content` | *string* | :heavy_check_mark: | The content of the task | -| `status` | *string* | :heavy_check_mark: | The status of the task. Authorized values are PENDING, COMPLETED. | -| `dueDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The due date of the task | -| `finishedDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The finished date of the task | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the task | -| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the task | -| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the task | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the task between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the task | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the task in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the task in the context of the Crm 3rd Party | -| `createdAt` | [components.UnifiedCrmTaskOutputCreatedAt](../../models/components/unifiedcrmtaskoutputcreatedat.md) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [components.UnifiedCrmTaskOutputModifiedAt](../../models/components/unifiedcrmtaskoutputmodifiedat.md) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `subject` | *string* | :heavy_check_mark: | The subject of the task | Answer customers | +| `content` | *string* | :heavy_check_mark: | The content of the task | Prepare email campaign | +| `status` | [components.UnifiedCrmTaskOutputStatus](../../models/components/unifiedcrmtaskoutputstatus.md) | :heavy_check_mark: | The status of the task. Authorized values are PENDING, COMPLETED. | PENDING | +| `dueDate` | *string* | :heavy_minus_sign: | The due date of the task | 2024-10-01T12:00:00Z | +| `finishedDate` | *string* | :heavy_minus_sign: | The finished date of the task | 2024-10-01T12:00:00Z | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user tied to the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `companyId` | *string* | :heavy_minus_sign: | The UUID of the company tied to the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `dealId` | *string* | :heavy_minus_sign: | The UUID of the deal tied to the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the task between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the task | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The ID of the task in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the task in the context of the Crm 3rd Party | {
"key1": "value1",
"key2": 42,
"key3": true
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmtaskoutputcreatedat.md b/docs/models/components/unifiedcrmtaskoutputcreatedat.md deleted file mode 100644 index e5b80ea8..00000000 --- a/docs/models/components/unifiedcrmtaskoutputcreatedat.md +++ /dev/null @@ -1,9 +0,0 @@ -# UnifiedCrmTaskOutputCreatedAt - -The created date of the object - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmtaskoutputmodifiedat.md b/docs/models/components/unifiedcrmtaskoutputmodifiedat.md deleted file mode 100644 index ada1bbe5..00000000 --- a/docs/models/components/unifiedcrmtaskoutputmodifiedat.md +++ /dev/null @@ -1,9 +0,0 @@ -# UnifiedCrmTaskOutputModifiedAt - -The modified date of the object - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmtaskoutputstatus.md b/docs/models/components/unifiedcrmtaskoutputstatus.md new file mode 100644 index 00000000..f636356e --- /dev/null +++ b/docs/models/components/unifiedcrmtaskoutputstatus.md @@ -0,0 +1,11 @@ +# UnifiedCrmTaskOutputStatus + +The status of the task. Authorized values are PENDING, COMPLETED. + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `Pending` | PENDING | +| `Completed` | COMPLETED | \ No newline at end of file diff --git a/docs/models/components/unifiedcrmuseroutput.md b/docs/models/components/unifiedcrmuseroutput.md index 3c93997b..02b10598 100644 --- a/docs/models/components/unifiedcrmuseroutput.md +++ b/docs/models/components/unifiedcrmuseroutput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the user | -| `email` | *string* | :heavy_check_mark: | The email of the user | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the user between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the user | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the user in the context of the Crm 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the Crm 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the user | Jane Doe | +| `email` | *string* | :heavy_check_mark: | The email of the user | jane.doe@example.com | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the user between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the user | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the user in the context of the Crm 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the Crm 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedfilestoragedriveoutput.md b/docs/models/components/unifiedfilestoragedriveoutput.md index a570c6e3..ffc53470 100644 --- a/docs/models/components/unifiedfilestoragedriveoutput.md +++ b/docs/models/components/unifiedfilestoragedriveoutput.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the drive | -| `remoteCreatedAt` | *string* | :heavy_check_mark: | When the third party s drive was created. | -| `driveUrl` | *string* | :heavy_check_mark: | The url of the drive | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the drive | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the drive in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the drive in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the drive | school | +| `remoteCreatedAt` | *string* | :heavy_check_mark: | When the third party s drive was created. | 2024-10-01T12:00:00Z | +| `driveUrl` | *string* | :heavy_check_mark: | The url of the drive | https://example.com/school | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the drive | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the drive in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the drive in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedfilestoragefileinput.md b/docs/models/components/unifiedfilestoragefileinput.md index 0af4c6db..49f8a3ed 100644 --- a/docs/models/components/unifiedfilestoragefileinput.md +++ b/docs/models/components/unifiedfilestoragefileinput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the file | -| `fileUrl` | *string* | :heavy_check_mark: | The url of the file | -| `mimeType` | *string* | :heavy_check_mark: | The mime type of the file | -| `size` | *string* | :heavy_check_mark: | The size of the file | -| `folderId` | *string* | :heavy_check_mark: | The UUID of the folder tied to the file | -| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the file | -| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the file | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the file | my_paris_photo.png | +| `fileUrl` | *string* | :heavy_check_mark: | The url of the file | https://example.com/my_paris_photo.png | +| `mimeType` | *string* | :heavy_check_mark: | The mime type of the file | application/pdf | +| `size` | *string* | :heavy_check_mark: | The size of the file | 1024 | +| `folderId` | *string* | :heavy_check_mark: | The UUID of the folder tied to the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedfilestoragefileoutput.md b/docs/models/components/unifiedfilestoragefileoutput.md index a69ea8d4..380bb00a 100644 --- a/docs/models/components/unifiedfilestoragefileoutput.md +++ b/docs/models/components/unifiedfilestoragefileoutput.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the file | -| `fileUrl` | *string* | :heavy_check_mark: | The url of the file | -| `mimeType` | *string* | :heavy_check_mark: | The mime type of the file | -| `size` | *string* | :heavy_check_mark: | The size of the file | -| `folderId` | *string* | :heavy_check_mark: | The UUID of the folder tied to the file | -| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the file | -| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the file | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the file | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the file in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the file in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the file | my_paris_photo.png | +| `fileUrl` | *string* | :heavy_check_mark: | The url of the file | https://example.com/my_paris_photo.png | +| `mimeType` | *string* | :heavy_check_mark: | The mime type of the file | application/pdf | +| `size` | *string* | :heavy_check_mark: | The size of the file | 1024 | +| `folderId` | *string* | :heavy_check_mark: | The UUID of the folder tied to the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the file | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the file in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the file in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedfilestoragefolderinput.md b/docs/models/components/unifiedfilestoragefolderinput.md index 412eb73b..15c33187 100644 --- a/docs/models/components/unifiedfilestoragefolderinput.md +++ b/docs/models/components/unifiedfilestoragefolderinput.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the folder | -| `size` | *string* | :heavy_check_mark: | The size of the folder | -| `folderUrl` | *string* | :heavy_check_mark: | The url of the folder | -| `description` | *string* | :heavy_check_mark: | The description of the folder | -| `driveId` | *string* | :heavy_check_mark: | The UUID of the drive tied to the folder | -| `parentFolderId` | *string* | :heavy_check_mark: | The UUID of the parent folder | -| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the folder | -| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the folder | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the folder | school | +| `size` | *string* | :heavy_check_mark: | The size of the folder | 2048 | +| `folderUrl` | *string* | :heavy_check_mark: | The url of the folder | https://example.com/school | +| `description` | *string* | :heavy_check_mark: | The description of the folder | All things school related | +| `driveId` | *string* | :heavy_check_mark: | The UUID of the drive tied to the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `parentFolderId` | *string* | :heavy_check_mark: | The UUID of the parent folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedfilestoragefolderoutput.md b/docs/models/components/unifiedfilestoragefolderoutput.md index c3fdf6de..97d3b6af 100644 --- a/docs/models/components/unifiedfilestoragefolderoutput.md +++ b/docs/models/components/unifiedfilestoragefolderoutput.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the folder | -| `size` | *string* | :heavy_check_mark: | The size of the folder | -| `folderUrl` | *string* | :heavy_check_mark: | The url of the folder | -| `description` | *string* | :heavy_check_mark: | The description of the folder | -| `driveId` | *string* | :heavy_check_mark: | The UUID of the drive tied to the folder | -| `parentFolderId` | *string* | :heavy_check_mark: | The UUID of the parent folder | -| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the folder | -| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the folder | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the folder | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the folder in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the folder in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the folder | school | +| `size` | *string* | :heavy_check_mark: | The size of the folder | 2048 | +| `folderUrl` | *string* | :heavy_check_mark: | The url of the folder | https://example.com/school | +| `description` | *string* | :heavy_check_mark: | The description of the folder | All things school related | +| `driveId` | *string* | :heavy_check_mark: | The UUID of the drive tied to the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `parentFolderId` | *string* | :heavy_check_mark: | The UUID of the parent folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `sharedLink` | *string* | :heavy_check_mark: | The UUID of the shared link tied to the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `permission` | *string* | :heavy_check_mark: | The UUID of the permission tied to the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the folder | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the folder in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the folder in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the folder | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the folder | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedfilestoragegroupoutput.md b/docs/models/components/unifiedfilestoragegroupoutput.md index 06de213a..7254ca8b 100644 --- a/docs/models/components/unifiedfilestoragegroupoutput.md +++ b/docs/models/components/unifiedfilestoragegroupoutput.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the group | -| `users` | *string*[] | :heavy_check_mark: | Uuids of users of the group | -| `remoteWasDeleted` | *boolean* | :heavy_check_mark: | Indicates whether or not this object has been deleted in the third party platform. | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the group | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the group in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the group in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the group | My group | +| `users` | *string*[] | :heavy_check_mark: | Uuids of users of the group | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `remoteWasDeleted` | *boolean* | :heavy_check_mark: | Indicates whether or not this object has been deleted in the third party platform. | false | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the group | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the group in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the group in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifieduseroutput.md b/docs/models/components/unifiedfilestorageuseroutput.md similarity index 79% rename from docs/models/components/unifieduseroutput.md rename to docs/models/components/unifiedfilestorageuseroutput.md index 64bbd1f3..f2a88c93 100644 --- a/docs/models/components/unifieduseroutput.md +++ b/docs/models/components/unifiedfilestorageuseroutput.md @@ -1,16 +1,16 @@ -# UnifiedUserOutput +# UnifiedFilestorageUserOutput ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the user | -| `email` | *string* | :heavy_check_mark: | The email of the user | -| `isMe` | *boolean* | :heavy_check_mark: | Whether the user is the one who linked this account. | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the user | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the user in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the user | Joe Doe | +| `email` | *string* | :heavy_check_mark: | The email of the user | joe.doe@gmail.com | +| `isMe` | *boolean* | :heavy_check_mark: | Whether the user is the one who linked this account. | true | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the object between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the user | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the user in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedcampaignoutput.md b/docs/models/components/unifiedmarketingautomationcampaignoutput.md similarity index 74% rename from docs/models/components/unifiedcampaignoutput.md rename to docs/models/components/unifiedmarketingautomationcampaignoutput.md index c2af2597..52cbbc17 100644 --- a/docs/models/components/unifiedcampaignoutput.md +++ b/docs/models/components/unifiedmarketingautomationcampaignoutput.md @@ -1,4 +1,4 @@ -# UnifiedCampaignOutput +# UnifiedMarketingautomationCampaignOutput ## Fields diff --git a/docs/models/components/unifiedticketingaccountoutput.md b/docs/models/components/unifiedticketingaccountoutput.md index e3096035..4f8f6d06 100644 --- a/docs/models/components/unifiedticketingaccountoutput.md +++ b/docs/models/components/unifiedticketingaccountoutput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the account | -| `domains` | *string*[] | :heavy_minus_sign: | The domains of the account | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the account between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the account | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the account in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the account in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the account | My Personal Account | +| `domains` | *string*[] | :heavy_minus_sign: | The domains of the account | [
"acme.com",
"acme-test.com"
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the account between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the account | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the account in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the account in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the account | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the account | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingattachmentinput.md b/docs/models/components/unifiedticketingattachmentinput.md index ea4b9762..24dc4756 100644 --- a/docs/models/components/unifiedticketingattachmentinput.md +++ b/docs/models/components/unifiedticketingattachmentinput.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `fileName` | *string* | :heavy_check_mark: | The file name of the attachment | -| `fileUrl` | *string* | :heavy_check_mark: | The file url of the attachment | -| `uploader` | *string* | :heavy_check_mark: | The uploader's UUID of the attachment | -| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the attachment is tied to | -| `commentId` | *string* | :heavy_minus_sign: | The UUID of the comment the attachment is tied to | -| `fieldMappings` | Record | :heavy_check_mark: | The custom field mappings of the attachment between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `fileName` | *string* | :heavy_check_mark: | The file name of the attachment | features_planning.pdf | +| `fileUrl` | *string* | :heavy_check_mark: | The file url of the attachment | https://example.com/features_planning.pdf | +| `uploader` | *string* | :heavy_check_mark: | The uploader's UUID of the attachment | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the attachment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `commentId` | *string* | :heavy_minus_sign: | The UUID of the comment the attachment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the attachment between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingattachmentoutput.md b/docs/models/components/unifiedticketingattachmentoutput.md index 74d4a640..abe03b41 100644 --- a/docs/models/components/unifiedticketingattachmentoutput.md +++ b/docs/models/components/unifiedticketingattachmentoutput.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `fileName` | *string* | :heavy_check_mark: | The file name of the attachment | -| `fileUrl` | *string* | :heavy_check_mark: | The file url of the attachment | -| `uploader` | *string* | :heavy_check_mark: | The uploader's UUID of the attachment | -| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the attachment is tied to | -| `commentId` | *string* | :heavy_minus_sign: | The UUID of the comment the attachment is tied to | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the attachment between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the attachment | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the attachment in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the attachment in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `fileName` | *string* | :heavy_check_mark: | The file name of the attachment | features_planning.pdf | +| `fileUrl` | *string* | :heavy_check_mark: | The file url of the attachment | https://example.com/features_planning.pdf | +| `uploader` | *string* | :heavy_check_mark: | The uploader's UUID of the attachment | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the attachment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `commentId` | *string* | :heavy_minus_sign: | The UUID of the comment the attachment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the attachment between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the attachment | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the attachment in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the attachment in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingcollectionoutput.md b/docs/models/components/unifiedticketingcollectionoutput.md index 1f82f6a6..9ccb4886 100644 --- a/docs/models/components/unifiedticketingcollectionoutput.md +++ b/docs/models/components/unifiedticketingcollectionoutput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the collection | -| `description` | *string* | :heavy_minus_sign: | The description of the collection | -| `collectionType` | *string* | :heavy_minus_sign: | The type of the collection. Authorized values are either PROJECT or LIST | -| `id` | *string* | :heavy_minus_sign: | The UUID of the collection | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the collection in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the collection in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the collection | My Personal Collection | +| `description` | *string* | :heavy_minus_sign: | The description of the collection | Collect issues | +| `collectionType` | [components.CollectionType](../../models/components/collectiontype.md) | :heavy_minus_sign: | The type of the collection. Authorized values are either PROJECT or LIST | PROJECT | +| `id` | *string* | :heavy_minus_sign: | The UUID of the collection | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the collection in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the collection in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingcommentinput.md b/docs/models/components/unifiedticketingcommentinput.md index 8fa7ade3..4654eb5e 100644 --- a/docs/models/components/unifiedticketingcommentinput.md +++ b/docs/models/components/unifiedticketingcommentinput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `body` | *string* | :heavy_check_mark: | The body of the comment | -| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment | -| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | -| `creatorType` | *string* | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | -| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | -| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `body` | *string* | :heavy_check_mark: | The body of the comment | Assigned to Eric ! | +| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment |

Assigned to Eric !

| +| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | false | +| `creatorType` | [components.UnifiedTicketingCommentInputCreatorType](../../models/components/unifiedticketingcommentinputcreatortype.md) | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | USER | +| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingcommentinputcreatortype.md b/docs/models/components/unifiedticketingcommentinputcreatortype.md new file mode 100644 index 00000000..96a5498b --- /dev/null +++ b/docs/models/components/unifiedticketingcommentinputcreatortype.md @@ -0,0 +1,11 @@ +# UnifiedTicketingCommentInputCreatorType + +The creator type of the comment. Authorized values are either USER or CONTACT + + +## Values + +| Name | Value | +| --------- | --------- | +| `User` | USER | +| `Contact` | CONTACT | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingcommentoutput.md b/docs/models/components/unifiedticketingcommentoutput.md index 401d9c7a..ef983e4a 100644 --- a/docs/models/components/unifiedticketingcommentoutput.md +++ b/docs/models/components/unifiedticketingcommentoutput.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `body` | *string* | :heavy_check_mark: | The body of the comment | -| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment | -| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | -| `creatorType` | *string* | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | -| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | -| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | -| `id` | *string* | :heavy_minus_sign: | The UUID of the comment | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the comment in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the comment in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the comment | Assigned to Eric ! | +| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment |

Assigned to Eric !

| +| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | false | +| `creatorType` | [components.CreatorType](../../models/components/creatortype.md) | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | USER | +| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `id` | *string* | :heavy_minus_sign: | The UUID of the comment | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the comment in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the comment in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingcontactoutput.md b/docs/models/components/unifiedticketingcontactoutput.md index 6f6bb4fe..1405df29 100644 --- a/docs/models/components/unifiedticketingcontactoutput.md +++ b/docs/models/components/unifiedticketingcontactoutput.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the contact | -| `emailAddress` | *string* | :heavy_check_mark: | The email address of the contact | -| `phoneNumber` | *string* | :heavy_minus_sign: | The phone number of the contact | -| `details` | *string* | :heavy_minus_sign: | The details of the contact | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the contact between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the contact | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the contact in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the contact in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the contact | Joe | +| `emailAddress` | *string* | :heavy_check_mark: | The email address of the contact | joedoe@acme.org | +| `phoneNumber` | *string* | :heavy_minus_sign: | The phone number of the contact | +33 6 50 11 11 10 | +| `details` | *string* | :heavy_minus_sign: | The details of the contact | Contact Details | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the contact between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the contact | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the contact in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the contact in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingtagoutput.md b/docs/models/components/unifiedticketingtagoutput.md index 2daacbb5..f57b280c 100644 --- a/docs/models/components/unifiedticketingtagoutput.md +++ b/docs/models/components/unifiedticketingtagoutput.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the tag | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the tag between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the tag | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the tag in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the tag in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the tag | urgent_tag | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the tag between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the tag | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The remote ID of the tag in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the tag in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the tag | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the tag | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingteamoutput.md b/docs/models/components/unifiedticketingteamoutput.md index c6f0c59a..6f4a473e 100644 --- a/docs/models/components/unifiedticketingteamoutput.md +++ b/docs/models/components/unifiedticketingteamoutput.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the team | -| `description` | *string* | :heavy_minus_sign: | The description of the team | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the team between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the team | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the team in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the team in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the team | My team | +| `description` | *string* | :heavy_minus_sign: | The description of the team | Internal members | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the team between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the team | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the team in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the team in the context of the 3rd Party | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketinput.md b/docs/models/components/unifiedticketingticketinput.md index b9cdc71e..83f5a6ce 100644 --- a/docs/models/components/unifiedticketingticketinput.md +++ b/docs/models/components/unifiedticketingticketinput.md @@ -3,21 +3,21 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the ticket | -| `status` | *string* | :heavy_minus_sign: | The status of the ticket. Authorized values are OPEN or CLOSED. | -| `description` | *string* | :heavy_check_mark: | The description of the ticket | -| `dueDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket is due | -| `type` | *string* | :heavy_minus_sign: | The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK | -| `parentTicket` | *string* | :heavy_minus_sign: | The UUID of the parent ticket | -| `collections` | *string* | :heavy_minus_sign: | The collection UUIDs the ticket belongs to | -| `tags` | *string*[] | :heavy_minus_sign: | The tags names of the ticket | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket has been completed | -| `priority` | *string* | :heavy_minus_sign: | The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. | -| `assignedTo` | *string*[] | :heavy_minus_sign: | The users UUIDs the ticket is assigned to | -| `comment` | [components.UnifiedTicketingTicketInputComment](../../models/components/unifiedticketingticketinputcomment.md) | :heavy_minus_sign: | The comment of the ticket | -| `accountId` | *string* | :heavy_minus_sign: | The UUID of the account which the ticket belongs to | -| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the ticket belongs to | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachments UUIDs tied to the ticket | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the ticket between the remote 3rd party & Panora | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the ticket | Customer Service Inquiry | +| `status` | [components.UnifiedTicketingTicketInputStatus](../../models/components/unifiedticketingticketinputstatus.md) | :heavy_minus_sign: | The status of the ticket. Authorized values are OPEN or CLOSED. | OPEN | +| `description` | *string* | :heavy_check_mark: | The description of the ticket | Help customer | +| `dueDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket is due | 2024-10-01T12:00:00Z | +| `type` | [components.UnifiedTicketingTicketInputType](../../models/components/unifiedticketingticketinputtype.md) | :heavy_minus_sign: | The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK | BUG | +| `parentTicket` | *string* | :heavy_minus_sign: | The UUID of the parent ticket | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `collections` | *string* | :heavy_minus_sign: | The collection UUIDs the ticket belongs to | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `tags` | *string*[] | :heavy_minus_sign: | The tags names of the ticket | [
"my_tag",
"urgent_tag"
] | +| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket has been completed | 2024-10-01T12:00:00Z | +| `priority` | [components.UnifiedTicketingTicketInputPriority](../../models/components/unifiedticketingticketinputpriority.md) | :heavy_minus_sign: | The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. | HIGH | +| `assignedTo` | *string*[] | :heavy_minus_sign: | The users UUIDs the ticket is assigned to | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `comment` | [components.UnifiedTicketingTicketInputComment](../../models/components/unifiedticketingticketinputcomment.md) | :heavy_minus_sign: | The comment of the ticket | {
"content": "Assigned the issue !"
} | +| `accountId` | *string* | :heavy_minus_sign: | The UUID of the account which the ticket belongs to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the ticket belongs to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the ticket | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the ticket between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketinputcomment.md b/docs/models/components/unifiedticketingticketinputcomment.md index e4e7dfce..cbfc34a0 100644 --- a/docs/models/components/unifiedticketingticketinputcomment.md +++ b/docs/models/components/unifiedticketingticketinputcomment.md @@ -5,13 +5,13 @@ The comment of the ticket ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `body` | *string* | :heavy_check_mark: | The body of the comment | -| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment | -| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | -| `creatorType` | *string* | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | -| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | -| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | -| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the comment | Assigned to Eric ! | +| `htmlBody` | *string* | :heavy_minus_sign: | The html body of the comment |

Assigned to Eric !

| +| `isPrivate` | *boolean* | :heavy_minus_sign: | The public status of the comment | false | +| `creatorType` | [components.UnifiedTicketingTicketInputCreatorType](../../models/components/unifiedticketingticketinputcreatortype.md) | :heavy_minus_sign: | The creator type of the comment. Authorized values are either USER or CONTACT | USER | +| `ticketId` | *string* | :heavy_minus_sign: | The UUID of the ticket the comment is tied to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the comment belongs to (if no user_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `userId` | *string* | :heavy_minus_sign: | The UUID of the user which the comment belongs to (if no contact_id specified) | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the comment | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketinputcreatortype.md b/docs/models/components/unifiedticketingticketinputcreatortype.md new file mode 100644 index 00000000..75f1e221 --- /dev/null +++ b/docs/models/components/unifiedticketingticketinputcreatortype.md @@ -0,0 +1,11 @@ +# UnifiedTicketingTicketInputCreatorType + +The creator type of the comment. Authorized values are either USER or CONTACT + + +## Values + +| Name | Value | +| --------- | --------- | +| `User` | USER | +| `Contact` | CONTACT | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketinputpriority.md b/docs/models/components/unifiedticketingticketinputpriority.md new file mode 100644 index 00000000..54608ce4 --- /dev/null +++ b/docs/models/components/unifiedticketingticketinputpriority.md @@ -0,0 +1,12 @@ +# UnifiedTicketingTicketInputPriority + +The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. + + +## Values + +| Name | Value | +| -------- | -------- | +| `High` | HIGH | +| `Medium` | MEDIUM | +| `Low` | LOW | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketinputstatus.md b/docs/models/components/unifiedticketingticketinputstatus.md new file mode 100644 index 00000000..32dbbd34 --- /dev/null +++ b/docs/models/components/unifiedticketingticketinputstatus.md @@ -0,0 +1,11 @@ +# UnifiedTicketingTicketInputStatus + +The status of the ticket. Authorized values are OPEN or CLOSED. + + +## Values + +| Name | Value | +| -------- | -------- | +| `Open` | OPEN | +| `Closed` | CLOSED | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketinputtype.md b/docs/models/components/unifiedticketingticketinputtype.md new file mode 100644 index 00000000..a522a7f4 --- /dev/null +++ b/docs/models/components/unifiedticketingticketinputtype.md @@ -0,0 +1,13 @@ +# UnifiedTicketingTicketInputType + +The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK + + +## Values + +| Name | Value | +| --------- | --------- | +| `Bug` | BUG | +| `Subtask` | SUBTASK | +| `Task` | TASK | +| `ToDo` | TO-DO | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketoutput.md b/docs/models/components/unifiedticketingticketoutput.md index a547767c..b8905a85 100644 --- a/docs/models/components/unifiedticketingticketoutput.md +++ b/docs/models/components/unifiedticketingticketoutput.md @@ -3,26 +3,26 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the ticket | -| `status` | *string* | :heavy_minus_sign: | The status of the ticket. Authorized values are OPEN or CLOSED. | -| `description` | *string* | :heavy_check_mark: | The description of the ticket | -| `dueDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket is due | -| `type` | *string* | :heavy_minus_sign: | The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK | -| `parentTicket` | *string* | :heavy_minus_sign: | The UUID of the parent ticket | -| `collections` | *string* | :heavy_minus_sign: | The collection UUIDs the ticket belongs to | -| `tags` | *string*[] | :heavy_minus_sign: | The tags names of the ticket | -| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket has been completed | -| `priority` | *string* | :heavy_minus_sign: | The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. | -| `assignedTo` | *string*[] | :heavy_minus_sign: | The users UUIDs the ticket is assigned to | -| `comment` | [components.Comment](../../models/components/comment.md) | :heavy_minus_sign: | The comment of the ticket | -| `accountId` | *string* | :heavy_minus_sign: | The UUID of the account which the ticket belongs to | -| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the ticket belongs to | -| `attachments` | *string*[] | :heavy_minus_sign: | The attachments UUIDs tied to the ticket | -| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the ticket between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the ticket | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the ticket in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the ticket in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the ticket | Customer Service Inquiry | +| `status` | [components.Status](../../models/components/status.md) | :heavy_minus_sign: | The status of the ticket. Authorized values are OPEN or CLOSED. | OPEN | +| `description` | *string* | :heavy_check_mark: | The description of the ticket | Help customer | +| `dueDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket is due | 2024-10-01T12:00:00Z | +| `type` | [components.Type](../../models/components/type.md) | :heavy_minus_sign: | The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK | BUG | +| `parentTicket` | *string* | :heavy_minus_sign: | The UUID of the parent ticket | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `collections` | *string* | :heavy_minus_sign: | The collection UUIDs the ticket belongs to | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `tags` | *string*[] | :heavy_minus_sign: | The tags names of the ticket | [
"my_tag",
"urgent_tag"
] | +| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the ticket has been completed | 2024-10-01T12:00:00Z | +| `priority` | [components.Priority](../../models/components/priority.md) | :heavy_minus_sign: | The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. | HIGH | +| `assignedTo` | *string*[] | :heavy_minus_sign: | The users UUIDs the ticket is assigned to | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `comment` | [components.Comment](../../models/components/comment.md) | :heavy_minus_sign: | The comment of the ticket | {
"content": "Assigned the issue !"
} | +| `accountId` | *string* | :heavy_minus_sign: | The UUID of the account which the ticket belongs to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `contactId` | *string* | :heavy_minus_sign: | The UUID of the contact which the ticket belongs to | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `attachments` | *string*[] | :heavy_minus_sign: | The attachements UUIDs tied to the ticket | [
"801f9ede-c698-4e66-a7fc-48d19eebaa4f"
] | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the ticket between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the ticket | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the ticket in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the ticket in the context of the 3rd Party | {
"key1": "value1",
"key2": 42,
"key3": true
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/unifiedticketingticketoutputcreatortype.md b/docs/models/components/unifiedticketingticketoutputcreatortype.md new file mode 100644 index 00000000..ff74d8f1 --- /dev/null +++ b/docs/models/components/unifiedticketingticketoutputcreatortype.md @@ -0,0 +1,11 @@ +# UnifiedTicketingTicketOutputCreatorType + +The creator type of the comment. Authorized values are either USER or CONTACT + + +## Values + +| Name | Value | +| --------- | --------- | +| `User` | USER | +| `Contact` | CONTACT | \ No newline at end of file diff --git a/docs/models/components/unifiedticketinguseroutput.md b/docs/models/components/unifiedticketinguseroutput.md index a6e38cd5..881c295a 100644 --- a/docs/models/components/unifiedticketinguseroutput.md +++ b/docs/models/components/unifiedticketinguseroutput.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the user | -| `emailAddress` | *string* | :heavy_check_mark: | The email address of the user | -| `teams` | *string*[] | :heavy_minus_sign: | The teams whose the user is part of | -| `accountId` | *string* | :heavy_minus_sign: | The account or organization the user is part of | -| `fieldMappings` | Record | :heavy_check_mark: | The custom field mappings of the user between the remote 3rd party & Panora | -| `id` | *string* | :heavy_minus_sign: | The UUID of the user | -| `remoteId` | *string* | :heavy_minus_sign: | The id of the user in the context of the 3rd Party | -| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the 3rd Party | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the user | John Doe | +| `emailAddress` | *string* | :heavy_check_mark: | The email address of the user | john.doe@example.com | +| `teams` | *string*[] | :heavy_minus_sign: | The teams whose the user is part of | [
"team1",
"team2"
] | +| `accountId` | *string* | :heavy_minus_sign: | The account or organization the user is part of | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `fieldMappings` | Record | :heavy_minus_sign: | The custom field mappings of the user between the remote 3rd party & Panora | {
"fav_dish": "broccoli",
"fav_color": "red"
} | +| `id` | *string* | :heavy_minus_sign: | The UUID of the user | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteId` | *string* | :heavy_minus_sign: | The id of the user in the context of the 3rd Party | id_1 | +| `remoteData` | Record | :heavy_minus_sign: | The remote data of the user in the context of the 3rd Party | {
"key1": "value1",
"key2": 42,
"key3": true
} | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The created date of the object | 2024-10-01T12:00:00Z | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The modified date of the object | 2023-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/components/veteranstatus.md b/docs/models/components/veteranstatus.md new file mode 100644 index 00000000..ab4af2b6 --- /dev/null +++ b/docs/models/components/veteranstatus.md @@ -0,0 +1,12 @@ +# VeteranStatus + +The veteran status of the candidate + + +## Values + +| Name | Value | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `IAmNotAProtectedVeteran` | I_AM_NOT_A_PROTECTED_VETERAN | +| `IIdentifyAsOneOrMoreOfTheClassificationsOfAProtectedVeteran` | I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN | +| `IDontWishToAnswer` | I_DONT_WISH_TO_ANSWER | \ No newline at end of file diff --git a/docs/models/components/visibility.md b/docs/models/components/visibility.md new file mode 100644 index 00000000..b7255d1a --- /dev/null +++ b/docs/models/components/visibility.md @@ -0,0 +1,12 @@ +# Visibility + +The visibility of the activity + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `AdminOnly` | ADMIN_ONLY | +| `Public` | PUBLIC | +| `Private` | PRIVATE | \ No newline at end of file diff --git a/docs/models/components/webhookdto.md b/docs/models/components/webhookdto.md index cea13f35..842d7b96 100644 --- a/docs/models/components/webhookdto.md +++ b/docs/models/components/webhookdto.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `url` | *string* | :heavy_check_mark: | The endpoint url of the webhook. | -| `description` | *string* | :heavy_minus_sign: | The description of the webhook. | -| `scope` | *string*[] | :heavy_check_mark: | The events that the webhook listen to. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `url` | *string* | :heavy_check_mark: | The endpoint url of the webhook. | https://acme.com/webhook_receiver | +| `description` | *string* | :heavy_check_mark: | The description of the webhook. | Webhook to receive connection events | +| `scope` | *string*[] | :heavy_check_mark: | The events that the webhook listen to. | [
"connection.created"
] | \ No newline at end of file diff --git a/docs/models/components/webhookresponse.md b/docs/models/components/webhookresponse.md index 1437f165..b984085f 100644 --- a/docs/models/components/webhookresponse.md +++ b/docs/models/components/webhookresponse.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `idWebhookEndpoint` | *string* | :heavy_check_mark: | The unique UUID of the webhook. | -| `endpointDescription` | *string* | :heavy_check_mark: | The description of the webhook. | -| `url` | *string* | :heavy_check_mark: | The endpoint url of the webhook. | -| `secret` | *string* | :heavy_check_mark: | The secret of the webhook. | -| `active` | *boolean* | :heavy_check_mark: | The status of the webhook. | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The created date of the webhook. | -| `scope` | *string*[] | :heavy_check_mark: | The events that the webhook listen to. | -| `idProject` | *string* | :heavy_check_mark: | The project id tied to the webhook. | -| `lastUpdate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The last update date of the webhook. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `idWebhookEndpoint` | *string* | :heavy_check_mark: | The unique UUID of the webhook. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `endpointDescription` | *string* | :heavy_check_mark: | The description of the webhook. | Webhook to receive connection events | +| `url` | *string* | :heavy_check_mark: | The endpoint url of the webhook. | https://acme.com/webhook_receiver | +| `secret` | *string* | :heavy_check_mark: | The secret of the webhook. | | +| `active` | *boolean* | :heavy_check_mark: | The status of the webhook. | true | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The created date of the webhook. | 2024-10-01T12:00:00Z | +| `scope` | *string*[] | :heavy_check_mark: | The events that the webhook listen to. | [
"connection.created"
] | +| `idProject` | *string* | :heavy_check_mark: | The project id tied to the webhook. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `lastUpdate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The last update date of the webhook. | 2024-10-01T12:00:00Z | \ No newline at end of file diff --git a/docs/models/operations/createaccountingaccountrequest.md b/docs/models/operations/createaccountingaccountrequest.md index e736672d..564c544d 100644 --- a/docs/models/operations/createaccountingaccountrequest.md +++ b/docs/models/operations/createaccountingaccountrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingAccountInput` | [components.UnifiedAccountingAccountInput](../../models/components/unifiedaccountingaccountinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingAccountInput` | [components.UnifiedAccountingAccountInput](../../models/components/unifiedaccountingaccountinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountingattachmentrequest.md b/docs/models/operations/createaccountingattachmentrequest.md index 4c97394c..80e7e40a 100644 --- a/docs/models/operations/createaccountingattachmentrequest.md +++ b/docs/models/operations/createaccountingattachmentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingAttachmentInput` | [components.UnifiedAccountingAttachmentInput](../../models/components/unifiedaccountingattachmentinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingAttachmentInput` | [components.UnifiedAccountingAttachmentInput](../../models/components/unifiedaccountingattachmentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountingcontactrequest.md b/docs/models/operations/createaccountingcontactrequest.md index 04f8f201..91d2c899 100644 --- a/docs/models/operations/createaccountingcontactrequest.md +++ b/docs/models/operations/createaccountingcontactrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingContactInput` | [components.UnifiedAccountingContactInput](../../models/components/unifiedaccountingcontactinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingContactInput` | [components.UnifiedAccountingContactInput](../../models/components/unifiedaccountingcontactinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountingexpenserequest.md b/docs/models/operations/createaccountingexpenserequest.md index 2b278de2..78d484c4 100644 --- a/docs/models/operations/createaccountingexpenserequest.md +++ b/docs/models/operations/createaccountingexpenserequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingExpenseInput` | [components.UnifiedAccountingExpenseInput](../../models/components/unifiedaccountingexpenseinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingExpenseInput` | [components.UnifiedAccountingExpenseInput](../../models/components/unifiedaccountingexpenseinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountinginvoicerequest.md b/docs/models/operations/createaccountinginvoicerequest.md index 81955af2..bf0c0a2a 100644 --- a/docs/models/operations/createaccountinginvoicerequest.md +++ b/docs/models/operations/createaccountinginvoicerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingInvoiceInput` | [components.UnifiedAccountingInvoiceInput](../../models/components/unifiedaccountinginvoiceinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingInvoiceInput` | [components.UnifiedAccountingInvoiceInput](../../models/components/unifiedaccountinginvoiceinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountingjournalentryrequest.md b/docs/models/operations/createaccountingjournalentryrequest.md index b12feea5..ff7a25b0 100644 --- a/docs/models/operations/createaccountingjournalentryrequest.md +++ b/docs/models/operations/createaccountingjournalentryrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingJournalentryInput` | [components.UnifiedAccountingJournalentryInput](../../models/components/unifiedaccountingjournalentryinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingJournalentryInput` | [components.UnifiedAccountingJournalentryInput](../../models/components/unifiedaccountingjournalentryinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountingpaymentrequest.md b/docs/models/operations/createaccountingpaymentrequest.md index 45c5065a..2b7faa03 100644 --- a/docs/models/operations/createaccountingpaymentrequest.md +++ b/docs/models/operations/createaccountingpaymentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingPaymentInput` | [components.UnifiedAccountingPaymentInput](../../models/components/unifiedaccountingpaymentinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingPaymentInput` | [components.UnifiedAccountingPaymentInput](../../models/components/unifiedaccountingpaymentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createaccountingpurchaseorderrequest.md b/docs/models/operations/createaccountingpurchaseorderrequest.md index dab6a08b..5fcf82d3 100644 --- a/docs/models/operations/createaccountingpurchaseorderrequest.md +++ b/docs/models/operations/createaccountingpurchaseorderrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | -| `unifiedAccountingPurchaseorderInput` | [components.UnifiedAccountingPurchaseorderInput](../../models/components/unifiedaccountingpurchaseorderinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | +| `unifiedAccountingPurchaseorderInput` | [components.UnifiedAccountingPurchaseorderInput](../../models/components/unifiedaccountingpurchaseorderinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createatsactivityrequest.md b/docs/models/operations/createatsactivityrequest.md index 14e46cff..9a012af7 100644 --- a/docs/models/operations/createatsactivityrequest.md +++ b/docs/models/operations/createatsactivityrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | -| `unifiedAtsActivityInput` | [components.UnifiedAtsActivityInput](../../models/components/unifiedatsactivityinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | +| `unifiedAtsActivityInput` | [components.UnifiedAtsActivityInput](../../models/components/unifiedatsactivityinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createatsapplicationrequest.md b/docs/models/operations/createatsapplicationrequest.md index eefc7a2a..bffa02a1 100644 --- a/docs/models/operations/createatsapplicationrequest.md +++ b/docs/models/operations/createatsapplicationrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | -| `unifiedAtsApplicationInput` | [components.UnifiedAtsApplicationInput](../../models/components/unifiedatsapplicationinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | +| `unifiedAtsApplicationInput` | [components.UnifiedAtsApplicationInput](../../models/components/unifiedatsapplicationinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createatsattachmentrequest.md b/docs/models/operations/createatsattachmentrequest.md index 27e29e0e..3ecd54b9 100644 --- a/docs/models/operations/createatsattachmentrequest.md +++ b/docs/models/operations/createatsattachmentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | -| `unifiedAtsAttachmentInput` | [components.UnifiedAtsAttachmentInput](../../models/components/unifiedatsattachmentinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | +| `unifiedAtsAttachmentInput` | [components.UnifiedAtsAttachmentInput](../../models/components/unifiedatsattachmentinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createatscandidaterequest.md b/docs/models/operations/createatscandidaterequest.md index 6f8b3d17..d4837446 100644 --- a/docs/models/operations/createatscandidaterequest.md +++ b/docs/models/operations/createatscandidaterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | -| `unifiedAtsCandidateInput` | [components.UnifiedAtsCandidateInput](../../models/components/unifiedatscandidateinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | +| `unifiedAtsCandidateInput` | [components.UnifiedAtsCandidateInput](../../models/components/unifiedatscandidateinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createatsinterviewrequest.md b/docs/models/operations/createatsinterviewrequest.md index 85bab87f..8b8b421d 100644 --- a/docs/models/operations/createatsinterviewrequest.md +++ b/docs/models/operations/createatsinterviewrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | -| `unifiedAtsInterviewInput` | [components.UnifiedAtsInterviewInput](../../models/components/unifiedatsinterviewinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | +| `unifiedAtsInterviewInput` | [components.UnifiedAtsInterviewInput](../../models/components/unifiedatsinterviewinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createcrmcompanyrequest.md b/docs/models/operations/createcrmcompanyrequest.md index 54d8feb0..2bef8407 100644 --- a/docs/models/operations/createcrmcompanyrequest.md +++ b/docs/models/operations/createcrmcompanyrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original CRM software. | -| `unifiedCrmCompanyInput` | [components.UnifiedCrmCompanyInput](../../models/components/unifiedcrmcompanyinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original CRM software. | false | +| `unifiedCrmCompanyInput` | [components.UnifiedCrmCompanyInput](../../models/components/unifiedcrmcompanyinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createcrmcontactrequest.md b/docs/models/operations/createcrmcontactrequest.md index 6e77410d..b5e450c3 100644 --- a/docs/models/operations/createcrmcontactrequest.md +++ b/docs/models/operations/createcrmcontactrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original CRM software. | -| `unifiedCrmContactInput` | [components.UnifiedCrmContactInput](../../models/components/unifiedcrmcontactinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original CRM software. | false | +| `unifiedCrmContactInput` | [components.UnifiedCrmContactInput](../../models/components/unifiedcrmcontactinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createcrmengagementrequest.md b/docs/models/operations/createcrmengagementrequest.md index 88ab0efb..bf887802 100644 --- a/docs/models/operations/createcrmengagementrequest.md +++ b/docs/models/operations/createcrmengagementrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | -| `unifiedCrmEngagementInput` | [components.UnifiedCrmEngagementInput](../../models/components/unifiedcrmengagementinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | +| `unifiedCrmEngagementInput` | [components.UnifiedCrmEngagementInput](../../models/components/unifiedcrmengagementinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createcrmnoterequest.md b/docs/models/operations/createcrmnoterequest.md index e8d23605..0f0d83d3 100644 --- a/docs/models/operations/createcrmnoterequest.md +++ b/docs/models/operations/createcrmnoterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | -| `unifiedCrmNoteInput` | [components.UnifiedCrmNoteInput](../../models/components/unifiedcrmnoteinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | +| `unifiedCrmNoteInput` | [components.UnifiedCrmNoteInput](../../models/components/unifiedcrmnoteinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createmarketingautomationactionrequest.md b/docs/models/operations/createmarketingautomationactionrequest.md index 5e0284b1..32b34c36 100644 --- a/docs/models/operations/createmarketingautomationactionrequest.md +++ b/docs/models/operations/createmarketingautomationactionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | -| `unifiedMarketingautomationActionInput` | [components.UnifiedMarketingautomationActionInput](../../models/components/unifiedmarketingautomationactioninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | +| `unifiedMarketingautomationActionInput` | [components.UnifiedMarketingautomationActionInput](../../models/components/unifiedmarketingautomationactioninput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createmarketingautomationautomationrequest.md b/docs/models/operations/createmarketingautomationautomationrequest.md index 5582e39b..29884b12 100644 --- a/docs/models/operations/createmarketingautomationautomationrequest.md +++ b/docs/models/operations/createmarketingautomationautomationrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | -| `unifiedMarketingautomationAutomationInput` | [components.UnifiedMarketingautomationAutomationInput](../../models/components/unifiedmarketingautomationautomationinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | +| `unifiedMarketingautomationAutomationInput` | [components.UnifiedMarketingautomationAutomationInput](../../models/components/unifiedmarketingautomationautomationinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createmarketingautomationcampaignrequest.md b/docs/models/operations/createmarketingautomationcampaignrequest.md index 774d453f..4ba87edc 100644 --- a/docs/models/operations/createmarketingautomationcampaignrequest.md +++ b/docs/models/operations/createmarketingautomationcampaignrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | -| `unifiedMarketingautomationCampaignInput` | [components.UnifiedMarketingautomationCampaignInput](../../models/components/unifiedmarketingautomationcampaigninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | +| `unifiedMarketingautomationCampaignInput` | [components.UnifiedMarketingautomationCampaignInput](../../models/components/unifiedmarketingautomationcampaigninput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createmarketingautomationcontactrequest.md b/docs/models/operations/createmarketingautomationcontactrequest.md index f19356e6..2d5ccef6 100644 --- a/docs/models/operations/createmarketingautomationcontactrequest.md +++ b/docs/models/operations/createmarketingautomationcontactrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | -| `unifiedMarketingautomationContactInput` | [components.UnifiedMarketingautomationContactInput](../../models/components/unifiedmarketingautomationcontactinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | +| `unifiedMarketingautomationContactInput` | [components.UnifiedMarketingautomationContactInput](../../models/components/unifiedmarketingautomationcontactinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createticketingticketrequest.md b/docs/models/operations/createticketingticketrequest.md index 7ee36d4c..b4c7ee77 100644 --- a/docs/models/operations/createticketingticketrequest.md +++ b/docs/models/operations/createticketingticketrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | -| `unifiedTicketingTicketInput` | [components.UnifiedTicketingTicketInput](../../models/components/unifiedticketingticketinput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | +| `unifiedTicketingTicketInput` | [components.UnifiedTicketingTicketInput](../../models/components/unifiedticketingticketinput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/deleterequest.md b/docs/models/operations/deleterequest.md index 4fc97699..0fdb034b 100644 --- a/docs/models/operations/deleterequest.md +++ b/docs/models/operations/deleterequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `id` | *string* | :heavy_check_mark: | id of the webhook to delete. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | \ No newline at end of file diff --git a/docs/models/operations/listfilestorageusersresponsebody.md b/docs/models/operations/listfilestorageusersresponsebody.md index e8934952..9e052021 100644 --- a/docs/models/operations/listfilestorageusersresponsebody.md +++ b/docs/models/operations/listfilestorageusersresponsebody.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `prevCursor` | *string* | :heavy_check_mark: | N/A | -| `nextCursor` | *string* | :heavy_check_mark: | N/A | -| `data` | [components.UnifiedUserOutput](../../models/components/unifieduseroutput.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `prevCursor` | *string* | :heavy_check_mark: | N/A | +| `nextCursor` | *string* | :heavy_check_mark: | N/A | +| `data` | [components.UnifiedFilestorageUserOutput](../../models/components/unifiedfilestorageuseroutput.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listhrisbankinforequest.md b/docs/models/operations/listhrisbankinforequest.md index aa4ce059..72ddc2d0 100644 --- a/docs/models/operations/listhrisbankinforequest.md +++ b/docs/models/operations/listhrisbankinforequest.md @@ -1,4 +1,4 @@ -# ListHrisBankinfoRequest +# ListHrisBankInfoRequest ## Fields diff --git a/docs/models/operations/listhrisbankinforesponsebody.md b/docs/models/operations/listhrisbankinforesponsebody.md index f91085c2..e5b49734 100644 --- a/docs/models/operations/listhrisbankinforesponsebody.md +++ b/docs/models/operations/listhrisbankinforesponsebody.md @@ -1,4 +1,4 @@ -# ListHrisBankinfoResponseBody +# ListHrisBankInfoResponseBody ## Fields diff --git a/docs/models/operations/listhrisbenefitrequest.md b/docs/models/operations/listhrisbenefitsrequest.md similarity index 98% rename from docs/models/operations/listhrisbenefitrequest.md rename to docs/models/operations/listhrisbenefitsrequest.md index 3783dd75..886b7e7c 100644 --- a/docs/models/operations/listhrisbenefitrequest.md +++ b/docs/models/operations/listhrisbenefitsrequest.md @@ -1,4 +1,4 @@ -# ListHrisBenefitRequest +# ListHrisBenefitsRequest ## Fields diff --git a/docs/models/operations/listhrisbenefitresponsebody.md b/docs/models/operations/listhrisbenefitsresponsebody.md similarity index 98% rename from docs/models/operations/listhrisbenefitresponsebody.md rename to docs/models/operations/listhrisbenefitsresponsebody.md index b2fab8fd..0b575b6d 100644 --- a/docs/models/operations/listhrisbenefitresponsebody.md +++ b/docs/models/operations/listhrisbenefitsresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisBenefitResponseBody +# ListHrisBenefitsResponseBody ## Fields diff --git a/docs/models/operations/listhrisemployeerequest.md b/docs/models/operations/listhriscompaniesrequest.md similarity index 98% rename from docs/models/operations/listhrisemployeerequest.md rename to docs/models/operations/listhriscompaniesrequest.md index 3e5553d4..254bc44d 100644 --- a/docs/models/operations/listhrisemployeerequest.md +++ b/docs/models/operations/listhriscompaniesrequest.md @@ -1,4 +1,4 @@ -# ListHrisEmployeeRequest +# ListHrisCompaniesRequest ## Fields diff --git a/docs/models/operations/listhriscompanysresponsebody.md b/docs/models/operations/listhriscompaniesresponsebody.md similarity index 98% rename from docs/models/operations/listhriscompanysresponsebody.md rename to docs/models/operations/listhriscompaniesresponsebody.md index 76de28da..04a6b763 100644 --- a/docs/models/operations/listhriscompanysresponsebody.md +++ b/docs/models/operations/listhriscompaniesresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisCompanysResponseBody +# ListHrisCompaniesResponseBody ## Fields diff --git a/docs/models/operations/listhriscompanysrequest.md b/docs/models/operations/listhrisemployeesrequest.md similarity index 98% rename from docs/models/operations/listhriscompanysrequest.md rename to docs/models/operations/listhrisemployeesrequest.md index 04e6d007..8ee7c8fe 100644 --- a/docs/models/operations/listhriscompanysrequest.md +++ b/docs/models/operations/listhrisemployeesrequest.md @@ -1,4 +1,4 @@ -# ListHrisCompanysRequest +# ListHrisEmployeesRequest ## Fields diff --git a/docs/models/operations/listhrisemployeeresponsebody.md b/docs/models/operations/listhrisemployeesresponsebody.md similarity index 98% rename from docs/models/operations/listhrisemployeeresponsebody.md rename to docs/models/operations/listhrisemployeesresponsebody.md index 538c1f39..88019bd7 100644 --- a/docs/models/operations/listhrisemployeeresponsebody.md +++ b/docs/models/operations/listhrisemployeesresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisEmployeeResponseBody +# ListHrisEmployeesResponseBody ## Fields diff --git a/docs/models/operations/listhrisemployerbenefitsrequest.md b/docs/models/operations/listhrisemployerbenefitsrequest.md new file mode 100644 index 00000000..a5c36a65 --- /dev/null +++ b/docs/models/operations/listhrisemployerbenefitsrequest.md @@ -0,0 +1,11 @@ +# ListHrisEmployerBenefitsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listhrisemployerbenefitresponsebody.md b/docs/models/operations/listhrisemployerbenefitsresponsebody.md similarity index 98% rename from docs/models/operations/listhrisemployerbenefitresponsebody.md rename to docs/models/operations/listhrisemployerbenefitsresponsebody.md index dbab1647..e7364ead 100644 --- a/docs/models/operations/listhrisemployerbenefitresponsebody.md +++ b/docs/models/operations/listhrisemployerbenefitsresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisEmployerBenefitResponseBody +# ListHrisEmployerBenefitsResponseBody ## Fields diff --git a/docs/models/operations/listhrisemploymentrequest.md b/docs/models/operations/listhrisemploymentsrequest.md similarity index 97% rename from docs/models/operations/listhrisemploymentrequest.md rename to docs/models/operations/listhrisemploymentsrequest.md index 7c362c87..09ccdc8b 100644 --- a/docs/models/operations/listhrisemploymentrequest.md +++ b/docs/models/operations/listhrisemploymentsrequest.md @@ -1,4 +1,4 @@ -# ListHrisEmploymentRequest +# ListHrisEmploymentsRequest ## Fields diff --git a/docs/models/operations/listhrisemploymentresponsebody.md b/docs/models/operations/listhrisemploymentsresponsebody.md similarity index 98% rename from docs/models/operations/listhrisemploymentresponsebody.md rename to docs/models/operations/listhrisemploymentsresponsebody.md index 4cf3f637..49bd3356 100644 --- a/docs/models/operations/listhrisemploymentresponsebody.md +++ b/docs/models/operations/listhrisemploymentsresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisEmploymentResponseBody +# ListHrisEmploymentsResponseBody ## Fields diff --git a/docs/models/operations/listhrisgrouprequest.md b/docs/models/operations/listhrisgroupsrequest.md similarity index 98% rename from docs/models/operations/listhrisgrouprequest.md rename to docs/models/operations/listhrisgroupsrequest.md index 4502eecb..3d83902b 100644 --- a/docs/models/operations/listhrisgrouprequest.md +++ b/docs/models/operations/listhrisgroupsrequest.md @@ -1,4 +1,4 @@ -# ListHrisGroupRequest +# ListHrisGroupsRequest ## Fields diff --git a/docs/models/operations/listhrisgroupresponsebody.md b/docs/models/operations/listhrisgroupsresponsebody.md similarity index 98% rename from docs/models/operations/listhrisgroupresponsebody.md rename to docs/models/operations/listhrisgroupsresponsebody.md index eba894ea..720cb854 100644 --- a/docs/models/operations/listhrisgroupresponsebody.md +++ b/docs/models/operations/listhrisgroupsresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisGroupResponseBody +# ListHrisGroupsResponseBody ## Fields diff --git a/docs/models/operations/listhrislocationrequest.md b/docs/models/operations/listhrislocationrequest.md deleted file mode 100644 index 105a02b6..00000000 --- a/docs/models/operations/listhrislocationrequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListHrisLocationRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listhrislocationsrequest.md b/docs/models/operations/listhrislocationsrequest.md new file mode 100644 index 00000000..8a36d4ee --- /dev/null +++ b/docs/models/operations/listhrislocationsrequest.md @@ -0,0 +1,11 @@ +# ListHrisLocationsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listhrislocationresponsebody.md b/docs/models/operations/listhrislocationsresponsebody.md similarity index 98% rename from docs/models/operations/listhrislocationresponsebody.md rename to docs/models/operations/listhrislocationsresponsebody.md index 875944b9..3148a1ee 100644 --- a/docs/models/operations/listhrislocationresponsebody.md +++ b/docs/models/operations/listhrislocationsresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisLocationResponseBody +# ListHrisLocationsResponseBody ## Fields diff --git a/docs/models/operations/listhrispaygrouprequest.md b/docs/models/operations/listhrispaygrouprequest.md deleted file mode 100644 index a4c13d1a..00000000 --- a/docs/models/operations/listhrispaygrouprequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListHrisPaygroupRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listhrispaygroupsrequest.md b/docs/models/operations/listhrispaygroupsrequest.md new file mode 100644 index 00000000..dbecf855 --- /dev/null +++ b/docs/models/operations/listhrispaygroupsrequest.md @@ -0,0 +1,11 @@ +# ListHrisPaygroupsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listhrispaygroupresponsebody.md b/docs/models/operations/listhrispaygroupsresponsebody.md similarity index 98% rename from docs/models/operations/listhrispaygroupresponsebody.md rename to docs/models/operations/listhrispaygroupsresponsebody.md index 2a727f8e..05ce41f1 100644 --- a/docs/models/operations/listhrispaygroupresponsebody.md +++ b/docs/models/operations/listhrispaygroupsresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisPaygroupResponseBody +# ListHrisPaygroupsResponseBody ## Fields diff --git a/docs/models/operations/listhristimeoffbalancerequest.md b/docs/models/operations/listhristimeoffbalancerequest.md deleted file mode 100644 index 32910c00..00000000 --- a/docs/models/operations/listhristimeoffbalancerequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListHrisTimeoffbalanceRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listhrisemployerbenefitrequest.md b/docs/models/operations/listhristimeoffbalancesrequest.md similarity index 97% rename from docs/models/operations/listhrisemployerbenefitrequest.md rename to docs/models/operations/listhristimeoffbalancesrequest.md index 126975b8..304e3888 100644 --- a/docs/models/operations/listhrisemployerbenefitrequest.md +++ b/docs/models/operations/listhristimeoffbalancesrequest.md @@ -1,4 +1,4 @@ -# ListHrisEmployerBenefitRequest +# ListHrisTimeoffbalancesRequest ## Fields diff --git a/docs/models/operations/listhristimeoffbalanceresponsebody.md b/docs/models/operations/listhristimeoffbalancesresponsebody.md similarity index 98% rename from docs/models/operations/listhristimeoffbalanceresponsebody.md rename to docs/models/operations/listhristimeoffbalancesresponsebody.md index 9a71ef92..0bec6229 100644 --- a/docs/models/operations/listhristimeoffbalanceresponsebody.md +++ b/docs/models/operations/listhristimeoffbalancesresponsebody.md @@ -1,4 +1,4 @@ -# ListHrisTimeoffbalanceResponseBody +# ListHrisTimeoffbalancesResponseBody ## Fields diff --git a/docs/models/operations/listmarketingautomationautomationrequest.md b/docs/models/operations/listmarketingautomationautomationrequest.md deleted file mode 100644 index 56d8c7f2..00000000 --- a/docs/models/operations/listmarketingautomationautomationrequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListMarketingautomationAutomationRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationautomationsrequest.md b/docs/models/operations/listmarketingautomationautomationsrequest.md new file mode 100644 index 00000000..b688902b --- /dev/null +++ b/docs/models/operations/listmarketingautomationautomationsrequest.md @@ -0,0 +1,11 @@ +# ListMarketingautomationAutomationsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationautomationresponsebody.md b/docs/models/operations/listmarketingautomationautomationsresponsebody.md similarity index 98% rename from docs/models/operations/listmarketingautomationautomationresponsebody.md rename to docs/models/operations/listmarketingautomationautomationsresponsebody.md index 7e7ab349..a53fc465 100644 --- a/docs/models/operations/listmarketingautomationautomationresponsebody.md +++ b/docs/models/operations/listmarketingautomationautomationsresponsebody.md @@ -1,4 +1,4 @@ -# ListMarketingautomationAutomationResponseBody +# ListMarketingautomationAutomationsResponseBody ## Fields diff --git a/docs/models/operations/listmarketingautomationcampaignrequest.md b/docs/models/operations/listmarketingautomationcampaignrequest.md deleted file mode 100644 index f55c07c5..00000000 --- a/docs/models/operations/listmarketingautomationcampaignrequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListMarketingautomationCampaignRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | -| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | -| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationcampaignresponsebody.md b/docs/models/operations/listmarketingautomationcampaignresponsebody.md deleted file mode 100644 index a173b2ab..00000000 --- a/docs/models/operations/listmarketingautomationcampaignresponsebody.md +++ /dev/null @@ -1,10 +0,0 @@ -# ListMarketingautomationCampaignResponseBody - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `prevCursor` | *string* | :heavy_check_mark: | N/A | -| `nextCursor` | *string* | :heavy_check_mark: | N/A | -| `data` | [components.UnifiedCampaignOutput](../../models/components/unifiedcampaignoutput.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationcampaignsrequest.md b/docs/models/operations/listmarketingautomationcampaignsrequest.md new file mode 100644 index 00000000..45cc4989 --- /dev/null +++ b/docs/models/operations/listmarketingautomationcampaignsrequest.md @@ -0,0 +1,11 @@ +# ListMarketingautomationCampaignsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original software. | +| `limit` | *number* | :heavy_minus_sign: | Set to get the number of records. | +| `cursor` | *string* | :heavy_minus_sign: | Set to get the number of records after this cursor. | \ No newline at end of file diff --git a/docs/models/operations/listmarketingautomationcampaignsresponsebody.md b/docs/models/operations/listmarketingautomationcampaignsresponsebody.md new file mode 100644 index 00000000..75d0d7c7 --- /dev/null +++ b/docs/models/operations/listmarketingautomationcampaignsresponsebody.md @@ -0,0 +1,10 @@ +# ListMarketingautomationCampaignsResponseBody + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `prevCursor` | *string* | :heavy_check_mark: | N/A | +| `nextCursor` | *string* | :heavy_check_mark: | N/A | +| `data` | [components.UnifiedMarketingautomationCampaignOutput](../../models/components/unifiedmarketingautomationcampaignoutput.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/remoteidrequest.md b/docs/models/operations/remoteidrequest.md index 2a19265e..bf31a87b 100644 --- a/docs/models/operations/remoteidrequest.md +++ b/docs/models/operations/remoteidrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `remoteId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `remoteId` | *string* | :heavy_check_mark: | N/A | id_1 | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingaccountrequest.md b/docs/models/operations/retrieveaccountingaccountrequest.md index d6959e1a..0bc867e3 100644 --- a/docs/models/operations/retrieveaccountingaccountrequest.md +++ b/docs/models/operations/retrieveaccountingaccountrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the account you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the account you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingaddressrequest.md b/docs/models/operations/retrieveaccountingaddressrequest.md index 248f094f..99ecde01 100644 --- a/docs/models/operations/retrieveaccountingaddressrequest.md +++ b/docs/models/operations/retrieveaccountingaddressrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the address you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the address you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingattachmentrequest.md b/docs/models/operations/retrieveaccountingattachmentrequest.md index 7e7aef02..fdbc7e2b 100644 --- a/docs/models/operations/retrieveaccountingattachmentrequest.md +++ b/docs/models/operations/retrieveaccountingattachmentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the attachment you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the attachment you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingbalancesheetrequest.md b/docs/models/operations/retrieveaccountingbalancesheetrequest.md index 356fd769..e856aedc 100644 --- a/docs/models/operations/retrieveaccountingbalancesheetrequest.md +++ b/docs/models/operations/retrieveaccountingbalancesheetrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the balancesheet you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the balancesheet you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingcashflowstatementrequest.md b/docs/models/operations/retrieveaccountingcashflowstatementrequest.md index 0cdfdbc7..31b99b62 100644 --- a/docs/models/operations/retrieveaccountingcashflowstatementrequest.md +++ b/docs/models/operations/retrieveaccountingcashflowstatementrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the cashflowstatement you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the cashflowstatement you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingcompanyinforequest.md b/docs/models/operations/retrieveaccountingcompanyinforequest.md index 84f0c76f..c9290119 100644 --- a/docs/models/operations/retrieveaccountingcompanyinforequest.md +++ b/docs/models/operations/retrieveaccountingcompanyinforequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the companyinfo you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the companyinfo you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingcontactrequest.md b/docs/models/operations/retrieveaccountingcontactrequest.md index 0953fbaf..ed5566bc 100644 --- a/docs/models/operations/retrieveaccountingcontactrequest.md +++ b/docs/models/operations/retrieveaccountingcontactrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the contact you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the contact you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingcreditnoterequest.md b/docs/models/operations/retrieveaccountingcreditnoterequest.md index ea5635ea..3bfeb9cc 100644 --- a/docs/models/operations/retrieveaccountingcreditnoterequest.md +++ b/docs/models/operations/retrieveaccountingcreditnoterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the creditnote you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the creditnote you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingexpenserequest.md b/docs/models/operations/retrieveaccountingexpenserequest.md index 87f07f40..c512b100 100644 --- a/docs/models/operations/retrieveaccountingexpenserequest.md +++ b/docs/models/operations/retrieveaccountingexpenserequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the expense you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the expense you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingincomestatementrequest.md b/docs/models/operations/retrieveaccountingincomestatementrequest.md index 7f5f682a..66c20735 100644 --- a/docs/models/operations/retrieveaccountingincomestatementrequest.md +++ b/docs/models/operations/retrieveaccountingincomestatementrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the incomestatement you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the incomestatement you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountinginvoicerequest.md b/docs/models/operations/retrieveaccountinginvoicerequest.md index 305f4e63..2d47cf38 100644 --- a/docs/models/operations/retrieveaccountinginvoicerequest.md +++ b/docs/models/operations/retrieveaccountinginvoicerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the invoice you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the invoice you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingitemrequest.md b/docs/models/operations/retrieveaccountingitemrequest.md index 6c3d40fd..c85c55e0 100644 --- a/docs/models/operations/retrieveaccountingitemrequest.md +++ b/docs/models/operations/retrieveaccountingitemrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the item you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the item you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingjournalentryrequest.md b/docs/models/operations/retrieveaccountingjournalentryrequest.md index cac0c8f7..f15b4824 100644 --- a/docs/models/operations/retrieveaccountingjournalentryrequest.md +++ b/docs/models/operations/retrieveaccountingjournalentryrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the journalentry you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the journalentry you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingpaymentrequest.md b/docs/models/operations/retrieveaccountingpaymentrequest.md index 96e08a0a..5dd821ec 100644 --- a/docs/models/operations/retrieveaccountingpaymentrequest.md +++ b/docs/models/operations/retrieveaccountingpaymentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the payment you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the payment you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingphonenumberrequest.md b/docs/models/operations/retrieveaccountingphonenumberrequest.md index 2f7848bf..02121ffe 100644 --- a/docs/models/operations/retrieveaccountingphonenumberrequest.md +++ b/docs/models/operations/retrieveaccountingphonenumberrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the phonenumber you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the phonenumber you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingpurchaseorderrequest.md b/docs/models/operations/retrieveaccountingpurchaseorderrequest.md index 80dc340e..d459a637 100644 --- a/docs/models/operations/retrieveaccountingpurchaseorderrequest.md +++ b/docs/models/operations/retrieveaccountingpurchaseorderrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the purchaseorder you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the purchaseorder you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingtaxraterequest.md b/docs/models/operations/retrieveaccountingtaxraterequest.md index 21f4a9a0..ab2da52b 100644 --- a/docs/models/operations/retrieveaccountingtaxraterequest.md +++ b/docs/models/operations/retrieveaccountingtaxraterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the taxrate you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the taxrate you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md b/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md index 8ef88347..8dee02c4 100644 --- a/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md +++ b/docs/models/operations/retrieveaccountingtrackingcategoryrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the trackingcategory you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the trackingcategory you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingtransactionrequest.md b/docs/models/operations/retrieveaccountingtransactionrequest.md index f3e8846b..4a482b8b 100644 --- a/docs/models/operations/retrieveaccountingtransactionrequest.md +++ b/docs/models/operations/retrieveaccountingtransactionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the transaction you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the transaction you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveaccountingvendorcreditrequest.md b/docs/models/operations/retrieveaccountingvendorcreditrequest.md index fc641374..bfea768c 100644 --- a/docs/models/operations/retrieveaccountingvendorcreditrequest.md +++ b/docs/models/operations/retrieveaccountingvendorcreditrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the vendorcredit you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the vendorcredit you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Accounting software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsactivityrequest.md b/docs/models/operations/retrieveatsactivityrequest.md index cadf3261..fc68522c 100644 --- a/docs/models/operations/retrieveatsactivityrequest.md +++ b/docs/models/operations/retrieveatsactivityrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the activity you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the activity you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsapplicationrequest.md b/docs/models/operations/retrieveatsapplicationrequest.md index a7fad0f9..e9074fc3 100644 --- a/docs/models/operations/retrieveatsapplicationrequest.md +++ b/docs/models/operations/retrieveatsapplicationrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the application you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the application you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsattachmentrequest.md b/docs/models/operations/retrieveatsattachmentrequest.md index e999fcc4..dfcf17ae 100644 --- a/docs/models/operations/retrieveatsattachmentrequest.md +++ b/docs/models/operations/retrieveatsattachmentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the attachment you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the attachment you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatscandidaterequest.md b/docs/models/operations/retrieveatscandidaterequest.md index 4855d251..e31b0e34 100644 --- a/docs/models/operations/retrieveatscandidaterequest.md +++ b/docs/models/operations/retrieveatscandidaterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the candidate you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the candidate you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsdepartmentrequest.md b/docs/models/operations/retrieveatsdepartmentrequest.md index 3d555be5..8b4c0ae0 100644 --- a/docs/models/operations/retrieveatsdepartmentrequest.md +++ b/docs/models/operations/retrieveatsdepartmentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the department you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the department you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsinterviewrequest.md b/docs/models/operations/retrieveatsinterviewrequest.md index 6275976b..85a4d0af 100644 --- a/docs/models/operations/retrieveatsinterviewrequest.md +++ b/docs/models/operations/retrieveatsinterviewrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the interview you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the interview you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsjobinterviewstagerequest.md b/docs/models/operations/retrieveatsjobinterviewstagerequest.md index 4248ebad..16f57e6f 100644 --- a/docs/models/operations/retrieveatsjobinterviewstagerequest.md +++ b/docs/models/operations/retrieveatsjobinterviewstagerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the jobinterviewstage you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the jobinterviewstage you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsjobrequest.md b/docs/models/operations/retrieveatsjobrequest.md index 459f2daf..ccee4112 100644 --- a/docs/models/operations/retrieveatsjobrequest.md +++ b/docs/models/operations/retrieveatsjobrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the job you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the job you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsofferrequest.md b/docs/models/operations/retrieveatsofferrequest.md index 450a03d5..96ab5b76 100644 --- a/docs/models/operations/retrieveatsofferrequest.md +++ b/docs/models/operations/retrieveatsofferrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the offer you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the offer you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsofficerequest.md b/docs/models/operations/retrieveatsofficerequest.md index 6f3ac9e0..697c6672 100644 --- a/docs/models/operations/retrieveatsofficerequest.md +++ b/docs/models/operations/retrieveatsofficerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the office you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the office you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsrejectreasonrequest.md b/docs/models/operations/retrieveatsrejectreasonrequest.md index 5c6fc86d..0e545e7a 100644 --- a/docs/models/operations/retrieveatsrejectreasonrequest.md +++ b/docs/models/operations/retrieveatsrejectreasonrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the rejectreason you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the rejectreason you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsscorecardrequest.md b/docs/models/operations/retrieveatsscorecardrequest.md index f8fb579f..e7bcf177 100644 --- a/docs/models/operations/retrieveatsscorecardrequest.md +++ b/docs/models/operations/retrieveatsscorecardrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the scorecard you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the scorecard you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatstagrequest.md b/docs/models/operations/retrieveatstagrequest.md index 2d00361b..a2d6019b 100644 --- a/docs/models/operations/retrieveatstagrequest.md +++ b/docs/models/operations/retrieveatstagrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the tag you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the tag you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveatsuserrequest.md b/docs/models/operations/retrieveatsuserrequest.md index 552e9ae1..dc9752b6 100644 --- a/docs/models/operations/retrieveatsuserrequest.md +++ b/docs/models/operations/retrieveatsuserrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ats software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecollectionrequest.md b/docs/models/operations/retrievecollectionrequest.md index fdea35a3..a2f1b32f 100644 --- a/docs/models/operations/retrievecollectionrequest.md +++ b/docs/models/operations/retrievecollectionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the collection you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the collection you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmcompanyrequest.md b/docs/models/operations/retrievecrmcompanyrequest.md index a0b0f1fe..58d6dfda 100644 --- a/docs/models/operations/retrievecrmcompanyrequest.md +++ b/docs/models/operations/retrievecrmcompanyrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the company you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the company you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmcontactrequest.md b/docs/models/operations/retrievecrmcontactrequest.md index 119b11bc..fe8262ee 100644 --- a/docs/models/operations/retrievecrmcontactrequest.md +++ b/docs/models/operations/retrievecrmcontactrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the `contact` you want to retrive. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original CRM software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the `contact` you want to retrive. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original CRM software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmdealrequest.md b/docs/models/operations/retrievecrmdealrequest.md index 0e188ad8..837dc783 100644 --- a/docs/models/operations/retrievecrmdealrequest.md +++ b/docs/models/operations/retrievecrmdealrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the deal you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the deal you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmengagementrequest.md b/docs/models/operations/retrievecrmengagementrequest.md index 47fef4c8..8d79f5a5 100644 --- a/docs/models/operations/retrievecrmengagementrequest.md +++ b/docs/models/operations/retrievecrmengagementrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the engagement you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the engagement you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmnoterequest.md b/docs/models/operations/retrievecrmnoterequest.md index aba263dd..f43ac42a 100644 --- a/docs/models/operations/retrievecrmnoterequest.md +++ b/docs/models/operations/retrievecrmnoterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the note you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the note you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmstagerequest.md b/docs/models/operations/retrievecrmstagerequest.md index d25bb776..ef175ec5 100644 --- a/docs/models/operations/retrievecrmstagerequest.md +++ b/docs/models/operations/retrievecrmstagerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the stage you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the stage you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmtaskrequest.md b/docs/models/operations/retrievecrmtaskrequest.md index c4eac4b8..2e926915 100644 --- a/docs/models/operations/retrievecrmtaskrequest.md +++ b/docs/models/operations/retrievecrmtaskrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the task you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the task you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievecrmuserrequest.md b/docs/models/operations/retrievecrmuserrequest.md index 4c8024c5..00ff029b 100644 --- a/docs/models/operations/retrievecrmuserrequest.md +++ b/docs/models/operations/retrievecrmuserrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | b008e199-eda9-4629-bd41-a01b6195864a | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Crm software. | true | \ No newline at end of file diff --git a/docs/models/operations/retrievefilestoragedriverequest.md b/docs/models/operations/retrievefilestoragedriverequest.md index 77fd9f0c..771ded60 100644 --- a/docs/models/operations/retrievefilestoragedriverequest.md +++ b/docs/models/operations/retrievefilestoragedriverequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the drive you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the drive you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original file storage service. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievefilestoragefilerequest.md b/docs/models/operations/retrievefilestoragefilerequest.md index d68085a9..df2fab89 100644 --- a/docs/models/operations/retrievefilestoragefilerequest.md +++ b/docs/models/operations/retrievefilestoragefilerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the file you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the file you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievefilestoragefolderrequest.md b/docs/models/operations/retrievefilestoragefolderrequest.md index fd544b58..f154e0e9 100644 --- a/docs/models/operations/retrievefilestoragefolderrequest.md +++ b/docs/models/operations/retrievefilestoragefolderrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the folder you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the folder you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievefilestoragegrouprequest.md b/docs/models/operations/retrievefilestoragegrouprequest.md index 03648c8d..a8db0db2 100644 --- a/docs/models/operations/retrievefilestoragegrouprequest.md +++ b/docs/models/operations/retrievefilestoragegrouprequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the permission you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the permission you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievefilestorageuserrequest.md b/docs/models/operations/retrievefilestorageuserrequest.md index ae9ebee9..01858e17 100644 --- a/docs/models/operations/retrievefilestorageuserrequest.md +++ b/docs/models/operations/retrievefilestorageuserrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the permission you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the permission you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original File Storage software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisbankinforequest.md b/docs/models/operations/retrievehrisbankinforequest.md index d637f81f..fdf84610 100644 --- a/docs/models/operations/retrievehrisbankinforequest.md +++ b/docs/models/operations/retrievehrisbankinforequest.md @@ -1,10 +1,10 @@ -# RetrieveHrisBankinfoRequest +# RetrieveHrisBankInfoRequest ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the bankinfo you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the bank info you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisbenefitrequest.md b/docs/models/operations/retrievehrisbenefitrequest.md index 435fdc68..be66ace6 100644 --- a/docs/models/operations/retrievehrisbenefitrequest.md +++ b/docs/models/operations/retrievehrisbenefitrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the benefit you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the benefit you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehriscompanyrequest.md b/docs/models/operations/retrievehriscompanyrequest.md new file mode 100644 index 00000000..74b18e40 --- /dev/null +++ b/docs/models/operations/retrievehriscompanyrequest.md @@ -0,0 +1,10 @@ +# RetrieveHrisCompanyRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the company you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisdependentrequest.md b/docs/models/operations/retrievehrisdependentrequest.md index 1a24a90e..47254fcc 100644 --- a/docs/models/operations/retrievehrisdependentrequest.md +++ b/docs/models/operations/retrievehrisdependentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the dependent you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the dependent you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisemployeepayrollrunrequest.md b/docs/models/operations/retrievehrisemployeepayrollrunrequest.md index 60ddaf9a..b26d12e6 100644 --- a/docs/models/operations/retrievehrisemployeepayrollrunrequest.md +++ b/docs/models/operations/retrievehrisemployeepayrollrunrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the employeepayrollrun you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the employeepayrollrun you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisemployeerequest.md b/docs/models/operations/retrievehrisemployeerequest.md index 04dbd406..7d85a27b 100644 --- a/docs/models/operations/retrievehrisemployeerequest.md +++ b/docs/models/operations/retrievehrisemployeerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the employee you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the employee you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisemployerbenefitrequest.md b/docs/models/operations/retrievehrisemployerbenefitrequest.md index 33326f7c..248699cd 100644 --- a/docs/models/operations/retrievehrisemployerbenefitrequest.md +++ b/docs/models/operations/retrievehrisemployerbenefitrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the employerbenefit you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the employer benefit you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisemploymentrequest.md b/docs/models/operations/retrievehrisemploymentrequest.md index a9129999..0ae6b6f4 100644 --- a/docs/models/operations/retrievehrisemploymentrequest.md +++ b/docs/models/operations/retrievehrisemploymentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the employment you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the employment you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrisgrouprequest.md b/docs/models/operations/retrievehrisgrouprequest.md index 45fddc44..49c0973b 100644 --- a/docs/models/operations/retrievehrisgrouprequest.md +++ b/docs/models/operations/retrievehrisgrouprequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the group you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the group you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrislocationrequest.md b/docs/models/operations/retrievehrislocationrequest.md index 672f5198..29f7e819 100644 --- a/docs/models/operations/retrievehrislocationrequest.md +++ b/docs/models/operations/retrievehrislocationrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the location you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the location you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrispaygrouprequest.md b/docs/models/operations/retrievehrispaygrouprequest.md index 9144807b..716cf68c 100644 --- a/docs/models/operations/retrievehrispaygrouprequest.md +++ b/docs/models/operations/retrievehrispaygrouprequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the paygroup you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the paygroup you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehrispayrollrunrequest.md b/docs/models/operations/retrievehrispayrollrunrequest.md new file mode 100644 index 00000000..c378b6e3 --- /dev/null +++ b/docs/models/operations/retrievehrispayrollrunrequest.md @@ -0,0 +1,10 @@ +# RetrieveHrisPayrollRunRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the payroll run you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehristimeoffbalancerequest.md b/docs/models/operations/retrievehristimeoffbalancerequest.md index 7de2fecc..afd3359b 100644 --- a/docs/models/operations/retrievehristimeoffbalancerequest.md +++ b/docs/models/operations/retrievehristimeoffbalancerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the timeoffbalance you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the timeoffbalance you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievehristimeoffrequest.md b/docs/models/operations/retrievehristimeoffrequest.md index 2357614c..73c4d233 100644 --- a/docs/models/operations/retrievehristimeoffrequest.md +++ b/docs/models/operations/retrievehristimeoffrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the timeoff you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the time off you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Hris software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievelinkeduserrequest.md b/docs/models/operations/retrievelinkeduserrequest.md index 95bc554b..654944a8 100644 --- a/docs/models/operations/retrievelinkeduserrequest.md +++ b/docs/models/operations/retrievelinkeduserrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `id` | *string* | :heavy_check_mark: | N/A | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationactionrequest.md b/docs/models/operations/retrievemarketingautomationactionrequest.md index 2b8f23eb..70190b80 100644 --- a/docs/models/operations/retrievemarketingautomationactionrequest.md +++ b/docs/models/operations/retrievemarketingautomationactionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the action you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the action you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationautomationrequest.md b/docs/models/operations/retrievemarketingautomationautomationrequest.md index 126a61e5..32f1b2d1 100644 --- a/docs/models/operations/retrievemarketingautomationautomationrequest.md +++ b/docs/models/operations/retrievemarketingautomationautomationrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the automation you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the automation you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationcampaignrequest.md b/docs/models/operations/retrievemarketingautomationcampaignrequest.md index 831edf7c..75a02eaa 100644 --- a/docs/models/operations/retrievemarketingautomationcampaignrequest.md +++ b/docs/models/operations/retrievemarketingautomationcampaignrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the campaign you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the campaign you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationcontactrequest.md b/docs/models/operations/retrievemarketingautomationcontactrequest.md index a0a0e55e..a9c974d0 100644 --- a/docs/models/operations/retrievemarketingautomationcontactrequest.md +++ b/docs/models/operations/retrievemarketingautomationcontactrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the contact you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the contact you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationemailrequest.md b/docs/models/operations/retrievemarketingautomationemailrequest.md index 6b8107c7..447687e1 100644 --- a/docs/models/operations/retrievemarketingautomationemailrequest.md +++ b/docs/models/operations/retrievemarketingautomationemailrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the email you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the email you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationeventrequest.md b/docs/models/operations/retrievemarketingautomationeventrequest.md index 990779bf..f2db14e4 100644 --- a/docs/models/operations/retrievemarketingautomationeventrequest.md +++ b/docs/models/operations/retrievemarketingautomationeventrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the event you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the event you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationlistrequest.md b/docs/models/operations/retrievemarketingautomationlistrequest.md index d131c1ef..341fbc8f 100644 --- a/docs/models/operations/retrievemarketingautomationlistrequest.md +++ b/docs/models/operations/retrievemarketingautomationlistrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the list you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the list you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationmessagerequest.md b/docs/models/operations/retrievemarketingautomationmessagerequest.md index 43ca7095..61157b20 100644 --- a/docs/models/operations/retrievemarketingautomationmessagerequest.md +++ b/docs/models/operations/retrievemarketingautomationmessagerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the message you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the message you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationtemplaterequest.md b/docs/models/operations/retrievemarketingautomationtemplaterequest.md index dc6c2740..92043607 100644 --- a/docs/models/operations/retrievemarketingautomationtemplaterequest.md +++ b/docs/models/operations/retrievemarketingautomationtemplaterequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the template you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the template you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrievemarketingautomationuserrequest.md b/docs/models/operations/retrievemarketingautomationuserrequest.md index 00d54069..a525eedf 100644 --- a/docs/models/operations/retrievemarketingautomationuserrequest.md +++ b/docs/models/operations/retrievemarketingautomationuserrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Marketingautomation software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveticketingattachmentrequest.md b/docs/models/operations/retrieveticketingattachmentrequest.md index fff55778..9fd307c2 100644 --- a/docs/models/operations/retrieveticketingattachmentrequest.md +++ b/docs/models/operations/retrieveticketingattachmentrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the attachment you want to retrive. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the attachment you want to retrive. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveticketingtagrequest.md b/docs/models/operations/retrieveticketingtagrequest.md index d1087fde..8492a5ae 100644 --- a/docs/models/operations/retrieveticketingtagrequest.md +++ b/docs/models/operations/retrieveticketingtagrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the tag you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the tag you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveticketingteamrequest.md b/docs/models/operations/retrieveticketingteamrequest.md index 966e22a5..9d23750e 100644 --- a/docs/models/operations/retrieveticketingteamrequest.md +++ b/docs/models/operations/retrieveticketingteamrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the team you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the team you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveticketingticketrequest.md b/docs/models/operations/retrieveticketingticketrequest.md index 2f04193b..46d89e50 100644 --- a/docs/models/operations/retrieveticketingticketrequest.md +++ b/docs/models/operations/retrieveticketingticketrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the `ticket` you want to retrive. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the `ticket` you want to retrive. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | \ No newline at end of file diff --git a/docs/models/operations/retrieveticketinguserrequest.md b/docs/models/operations/retrieveticketinguserrequest.md index 50a42445..8c0ecd8e 100644 --- a/docs/models/operations/retrieveticketinguserrequest.md +++ b/docs/models/operations/retrieveticketinguserrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | -| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | -| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `xConnectionToken` | *string* | :heavy_check_mark: | The connection token | | +| `id` | *string* | :heavy_check_mark: | id of the user you want to retrieve. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | +| `remoteData` | *boolean* | :heavy_minus_sign: | Set to true to include data from the original Ticketing software. | false | \ No newline at end of file diff --git a/docs/models/operations/statusrequest.md b/docs/models/operations/statusrequest.md index 23f706af..13cc5aca 100644 --- a/docs/models/operations/statusrequest.md +++ b/docs/models/operations/statusrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `vertical` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `vertical` | [operations.Vertical](../../models/operations/vertical.md) | :heavy_check_mark: | N/A | ticketing | \ No newline at end of file diff --git a/docs/models/operations/updatestatusrequest.md b/docs/models/operations/updatestatusrequest.md index 2a12b534..77bdf64e 100644 --- a/docs/models/operations/updatestatusrequest.md +++ b/docs/models/operations/updatestatusrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `id` | *string* | :heavy_check_mark: | id of the webhook to update. | 801f9ede-c698-4e66-a7fc-48d19eebaa4f | \ No newline at end of file diff --git a/docs/models/operations/vertical.md b/docs/models/operations/vertical.md new file mode 100644 index 00000000..68e4c741 --- /dev/null +++ b/docs/models/operations/vertical.md @@ -0,0 +1,15 @@ +# Vertical + + +## Values + +| Name | Value | +| --------------------- | --------------------- | +| `Ticketing` | ticketing | +| `Marketingautomation` | marketingautomation | +| `Crm` | crm | +| `Filestorage` | filestorage | +| `Ats` | ats | +| `Hris` | hris | +| `Accounting` | accounting | +| `Ecommerce` | ecommerce | \ No newline at end of file diff --git a/docs/sdks/accounts/README.md b/docs/sdks/accounts/README.md index 81414443..f43b6116 100644 --- a/docs/sdks/accounts/README.md +++ b/docs/sdks/accounts/README.md @@ -16,7 +16,7 @@ List Accounts import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,7 +60,7 @@ Retrieve Accounts from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/actions/README.md b/docs/sdks/actions/README.md index a340c893..a5eefb0c 100644 --- a/docs/sdks/actions/README.md +++ b/docs/sdks/actions/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Actions +* [list](#list) - List Actions * [create](#create) - Create Action * [retrieve](#retrieve) - Retrieve Actions ## list -List Actions +List Actions ### Example Usage @@ -17,7 +17,7 @@ List Actions import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create a action in any supported Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.actions.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationActionInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Actions from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.actions.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 0a35f37a..38bc0e19 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -17,7 +17,7 @@ List Activities import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,15 +59,28 @@ Create Activities in any supported Ats software ```typescript import { Panora } from "@panora/sdk"; +import { UnifiedAtsActivityInputActivityType, UnifiedAtsActivityInputVisibility } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.activities.create({ xConnectionToken: "", - unifiedAtsActivityInput: {}, + remoteData: false, + unifiedAtsActivityInput: { + activityType: UnifiedAtsActivityInputActivityType.Note, + subject: "Email subject", + body: "Dear Diana, I love you", + visibility: UnifiedAtsActivityInputVisibility.Public, + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -106,13 +119,14 @@ Retrieve Activities from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.activities.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/addresses/README.md b/docs/sdks/addresses/README.md index 697731cb..2171f8ab 100644 --- a/docs/sdks/addresses/README.md +++ b/docs/sdks/addresses/README.md @@ -16,7 +16,7 @@ List Addresss import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Addresses from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.addresses.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/applications/README.md b/docs/sdks/applications/README.md index f20b2f0c..47923d60 100644 --- a/docs/sdks/applications/README.md +++ b/docs/sdks/applications/README.md @@ -17,7 +17,7 @@ List Applications import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,13 +61,31 @@ Create Applications in any supported Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.applications.create({ xConnectionToken: "", - unifiedAtsApplicationInput: {}, + remoteData: false, + unifiedAtsApplicationInput: { + appliedAt: new Date("2024-10-01T12:00:00Z"), + rejectedAt: new Date("2024-10-01T12:00:00Z"), + offers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + "12345678-1234-1234-1234-123456789012", + ], + source: "Source Name", + creditedTo: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + currentStage: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + rejectReason: "Candidate not experienced enough", + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -106,13 +124,14 @@ Retrieve Applications from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.applications.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/attachments/README.md b/docs/sdks/attachments/README.md index bfe814f4..69f3233e 100644 --- a/docs/sdks/attachments/README.md +++ b/docs/sdks/attachments/README.md @@ -17,7 +17,7 @@ List Attachments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,15 +59,28 @@ Create Attachments in any supported ATS software ```typescript import { Panora } from "@panora/sdk"; +import { UnifiedAtsAttachmentInputAttachmentType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.attachments.create({ xConnectionToken: "", - unifiedAtsAttachmentInput: {}, + remoteData: false, + unifiedAtsAttachmentInput: { + fileUrl: "https://example.com/file.pdf", + fileName: "file.pdf", + attachmentType: UnifiedAtsAttachmentInputAttachmentType.Resume, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + candidateId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -106,13 +119,14 @@ Retrieve Attachments from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.attachments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/automations/README.md b/docs/sdks/automations/README.md index 1a0b5d48..30ededbf 100644 --- a/docs/sdks/automations/README.md +++ b/docs/sdks/automations/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Automations +* [list](#list) - List Automations * [create](#create) - Create Automation -* [retrieve](#retrieve) - Retrieve Automations +* [retrieve](#retrieve) - Retrieve Automation ## list -List Automations +List Automations ### Example Usage @@ -17,7 +17,7 @@ List Automations import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -36,7 +36,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListMarketingautomationAutomationRequest](../../models/operations/listmarketingautomationautomationrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListMarketingautomationAutomationsRequest](../../models/operations/listmarketingautomationautomationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -44,7 +44,7 @@ run(); ### Response -**Promise\<[operations.ListMarketingautomationAutomationResponseBody](../../models/operations/listmarketingautomationautomationresponsebody.md)\>** +**Promise\<[operations.ListMarketingautomationAutomationsResponseBody](../../models/operations/listmarketingautomationautomationsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -61,12 +61,13 @@ Create a automation in any supported Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.automations.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationAutomationInput: {}, }); @@ -98,7 +99,7 @@ run(); ## retrieve -Retrieve Automations from any connected Marketingautomation software +Retrieve an Automation from any connected Marketingautomation software ### Example Usage @@ -106,13 +107,14 @@ Retrieve Automations from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.automations.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/balancesheets/README.md b/docs/sdks/balancesheets/README.md index a14a404c..73e5e44d 100644 --- a/docs/sdks/balancesheets/README.md +++ b/docs/sdks/balancesheets/README.md @@ -16,7 +16,7 @@ List BalanceSheets import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve BalanceSheets from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.balancesheets.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/bankinfos/README.md b/docs/sdks/bankinfos/README.md index e1f6e617..919d8be6 100644 --- a/docs/sdks/bankinfos/README.md +++ b/docs/sdks/bankinfos/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Bankinfos -* [retrieve](#retrieve) - Retrieve Bank Infos +* [list](#list) - List Bank Info +* [retrieve](#retrieve) - Retrieve Bank Info ## list -List Bankinfos +List Bank Info ### Example Usage @@ -16,7 +16,7 @@ List Bankinfos import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisBankinfoRequest](../../models/operations/listhrisbankinforequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisBankInfoRequest](../../models/operations/listhrisbankinforequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisBankinfoResponseBody](../../models/operations/listhrisbankinforesponsebody.md)\>** +**Promise\<[operations.ListHrisBankInfoResponseBody](../../models/operations/listhrisbankinforesponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Bank Infos from any connected Hris software +Retrieve Bank Info from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Bank Infos from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.bankinfos.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -80,7 +81,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.RetrieveHrisBankinfoRequest](../../models/operations/retrievehrisbankinforequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.RetrieveHrisBankInfoRequest](../../models/operations/retrievehrisbankinforequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | diff --git a/docs/sdks/batch/README.md b/docs/sdks/batch/README.md index 82a6721c..ac89719d 100644 --- a/docs/sdks/batch/README.md +++ b/docs/sdks/batch/README.md @@ -15,15 +15,15 @@ Add Batch Linked Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.linkedUsers.batch.importBatch({ linkedUserOriginIds: [ - "", + "id_1", ], - alias: "", + alias: "acme", }); // Handle the result diff --git a/docs/sdks/benefits/README.md b/docs/sdks/benefits/README.md index 8d1d4dbb..d206a165 100644 --- a/docs/sdks/benefits/README.md +++ b/docs/sdks/benefits/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Benefits -* [retrieve](#retrieve) - Retrieve Benefits +* [list](#list) - List Benefits +* [retrieve](#retrieve) - Retrieve Benefit ## list -List Benefits +List Benefits ### Example Usage @@ -16,7 +16,7 @@ List Benefits import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisBenefitRequest](../../models/operations/listhrisbenefitrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisBenefitsRequest](../../models/operations/listhrisbenefitsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisBenefitResponseBody](../../models/operations/listhrisbenefitresponsebody.md)\>** +**Promise\<[operations.ListHrisBenefitsResponseBody](../../models/operations/listhrisbenefitsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Benefits from any connected Hris software +Retrieve a Benefit from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Benefits from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.benefits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/campaigns/README.md b/docs/sdks/campaigns/README.md index 872eabf8..1d59553d 100644 --- a/docs/sdks/campaigns/README.md +++ b/docs/sdks/campaigns/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Campaigns +* [list](#list) - List Campaigns * [create](#create) - Create Campaign -* [retrieve](#retrieve) - Retrieve Campaigns +* [retrieve](#retrieve) - Retrieve Campaign ## list -List Campaigns +List Campaigns ### Example Usage @@ -17,7 +17,7 @@ List Campaigns import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -36,7 +36,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListMarketingautomationCampaignRequest](../../models/operations/listmarketingautomationcampaignrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListMarketingautomationCampaignsRequest](../../models/operations/listmarketingautomationcampaignsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -44,7 +44,7 @@ run(); ### Response -**Promise\<[operations.ListMarketingautomationCampaignResponseBody](../../models/operations/listmarketingautomationcampaignresponsebody.md)\>** +**Promise\<[operations.ListMarketingautomationCampaignsResponseBody](../../models/operations/listmarketingautomationcampaignsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -61,12 +61,13 @@ Create a campaign in any supported Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.campaigns.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationCampaignInput: {}, }); @@ -89,7 +90,7 @@ run(); ### Response -**Promise\<[components.UnifiedCampaignOutput](../../models/components/unifiedcampaignoutput.md)\>** +**Promise\<[components.UnifiedMarketingautomationCampaignOutput](../../models/components/unifiedmarketingautomationcampaignoutput.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -98,7 +99,7 @@ run(); ## retrieve -Retrieve Campaigns from any connected Marketingautomation software +Retrieve a Campaign from any connected Marketingautomation software ### Example Usage @@ -106,13 +107,14 @@ Retrieve Campaigns from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.campaigns.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -134,7 +136,7 @@ run(); ### Response -**Promise\<[components.UnifiedCampaignOutput](../../models/components/unifiedcampaignoutput.md)\>** +**Promise\<[components.UnifiedMarketingautomationCampaignOutput](../../models/components/unifiedmarketingautomationcampaignoutput.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/candidates/README.md b/docs/sdks/candidates/README.md index d63908a1..033a2c31 100644 --- a/docs/sdks/candidates/README.md +++ b/docs/sdks/candidates/README.md @@ -17,7 +17,7 @@ List Candidates import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,15 +59,60 @@ Create Candidates in any supported Ats software ```typescript import { Panora } from "@panora/sdk"; +import { EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.candidates.create({ xConnectionToken: "", - unifiedAtsCandidateInput: {}, + remoteData: false, + unifiedAtsCandidateInput: { + firstName: "Joe", + lastName: "Doe", + company: "Acme", + title: "Analyst", + locations: "New York", + isPrivate: false, + emailReachable: true, + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteModifiedAt: new Date("2024-10-01T12:00:00Z"), + lastInteractionAt: new Date("2024-10-01T12:00:00Z"), + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + applications: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + tags: [ + "tag_1", + "tag_2", + ], + urls: [ + { + url: "mywebsite.com", + urlType: "WEBSITE", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660688899", + phoneType: PhoneType.Work, + }, + ], + emailAddresses: [ + { + emailAddress: "joedoe@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -106,13 +151,14 @@ Retrieve Candidates from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.candidates.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/cashflowstatements/README.md b/docs/sdks/cashflowstatements/README.md index 55df9abe..d6ff654a 100644 --- a/docs/sdks/cashflowstatements/README.md +++ b/docs/sdks/cashflowstatements/README.md @@ -16,7 +16,7 @@ List CashflowStatements import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Cashflow Statements from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.cashflowstatements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/collections/README.md b/docs/sdks/collections/README.md index 0eaec62e..1aa05c6e 100644 --- a/docs/sdks/collections/README.md +++ b/docs/sdks/collections/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Collections +* [list](#list) - List Collections * [retrieve](#retrieve) - Retrieve Collections ## list -List Collections +List Collections ### Example Usage @@ -16,7 +16,7 @@ List Collections import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Collections from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.collections.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/comments/README.md b/docs/sdks/comments/README.md index d054ff6e..71dc557d 100644 --- a/docs/sdks/comments/README.md +++ b/docs/sdks/comments/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Comments +* [list](#list) - List Comments * [create](#create) - Create Comments -* [retrieve](#retrieve) - Retrieve Comments +* [retrieve](#retrieve) - Retrieve Comment ## list -List Comments +List Comments ### Example Usage @@ -17,7 +17,7 @@ List Comments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,16 +59,26 @@ Create Comments in any supported Ticketing software ```typescript import { Panora } from "@panora/sdk"; +import { UnifiedTicketingCommentInputCreatorType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.comments.create({ xConnectionToken: "", unifiedTicketingCommentInput: { - body: "", + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingCommentInputCreatorType.User, + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], }, }); @@ -100,7 +110,7 @@ run(); ## retrieve -Retrieve Comments from any connected Ticketing software +Retrieve a Comment from any connected Ticketing software ### Example Usage @@ -108,7 +118,7 @@ Retrieve Comments from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md index 1969ccf9..1515ce3c 100644 --- a/docs/sdks/companies/README.md +++ b/docs/sdks/companies/README.md @@ -17,7 +17,7 @@ List Companies import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,16 +59,49 @@ Create Companies in any supported CRM software ```typescript import { Panora } from "@panora/sdk"; +import { AddressType, EmailAddressType, PhoneType, UnifiedCrmCompanyInputIndustry } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.companies.create({ xConnectionToken: "", + remoteData: false, unifiedCrmCompanyInput: { - name: "", + name: "Acme", + industry: UnifiedCrmCompanyInputIndustry.Accounting, + numberOfEmployees: 10, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + emailAddresses: [ + { + emailAddress: "acme@gmail.com", + emailAddressType: EmailAddressType.Work, + }, + ], + addresses: [ + { + street1: "5th Avenue", + street2: "", + city: "New York", + state: "NY", + postalCode: "46842", + country: "USA", + addressType: AddressType.Work, + ownerType: "", + }, + ], + phoneNumbers: [ + { + phoneNumber: "+33660606067", + phoneType: PhoneType.Work, + }, + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -108,13 +141,14 @@ Retrieve Companies from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.companies.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/companyinfos/README.md b/docs/sdks/companyinfos/README.md index 9dce3cae..4cec83e2 100644 --- a/docs/sdks/companyinfos/README.md +++ b/docs/sdks/companyinfos/README.md @@ -16,7 +16,7 @@ List CompanyInfos import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Company Infos from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.companyinfos.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md index f1a7805f..7c33a2c0 100644 --- a/docs/sdks/contacts/README.md +++ b/docs/sdks/contacts/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List all Contacts -* [retrieve](#retrieve) - Retrieve Contacts +* [list](#list) - List Contacts +* [retrieve](#retrieve) - Retrieve Contact ## list -List all Contacts +List Contacts ### Example Usage @@ -16,7 +16,7 @@ List all Contacts import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Contacts from any connected Ticketing software +Retrieve a Contact from any connected Ticketing software ### Example Usage @@ -60,7 +60,7 @@ Retrieve Contacts from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index a07d1b2f..9e83bec2 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -16,7 +16,7 @@ List CreditNotes import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Credit Notes from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.creditnotes.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/deals/README.md b/docs/sdks/deals/README.md index 43972a06..3c27879b 100644 --- a/docs/sdks/deals/README.md +++ b/docs/sdks/deals/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Deals +* [list](#list) - List Deals * [create](#create) - Create Deals * [retrieve](#retrieve) - Retrieve Deals ## list -List Deals +List Deals ### Example Usage @@ -17,7 +17,7 @@ List Deals import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,16 +61,23 @@ Create Deals in any supported Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.deals.create({ xConnectionToken: "", unifiedCrmDealInput: { - name: "", - description: "Multi-tiered human-resource model", - amount: 8592.13, + name: "Huge Contract with Acme", + description: "Contract with Sales Operations Team", + amount: 1000, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + stageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -110,13 +117,14 @@ Retrieve Deals from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.deals.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/define/README.md b/docs/sdks/define/README.md index 36cd0f12..26032836 100644 --- a/docs/sdks/define/README.md +++ b/docs/sdks/define/README.md @@ -13,17 +13,18 @@ Define target Field ```typescript import { Panora } from "@panora/sdk"; +import { DataType, ObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.fieldMappings.define.definitions({ - objectTypeOwner: "", - name: "", - description: "Universal heuristic matrices", - dataType: "decimal", + objectTypeOwner: ObjectTypeOwner.Company, + name: "fav_dish", + description: "My favorite dish", + dataType: DataType.String, }); // Handle the result diff --git a/docs/sdks/departments/README.md b/docs/sdks/departments/README.md index 2bc7e44e..0c7d0599 100644 --- a/docs/sdks/departments/README.md +++ b/docs/sdks/departments/README.md @@ -16,7 +16,7 @@ List Departments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Departments from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.departments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/dependents/README.md b/docs/sdks/dependents/README.md index 8836f8de..0017f4e3 100644 --- a/docs/sdks/dependents/README.md +++ b/docs/sdks/dependents/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Dependents -* [retrieve](#retrieve) - Retrieve Dependents +* [list](#list) - List Dependents +* [retrieve](#retrieve) - Retrieve Dependent ## list -List Dependents +List Dependents ### Example Usage @@ -16,7 +16,7 @@ List Dependents import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Dependents from any connected Hris software +Retrieve a Dependent from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Dependents from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.dependents.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/drives/README.md b/docs/sdks/drives/README.md index 49d7f740..1295e5fb 100644 --- a/docs/sdks/drives/README.md +++ b/docs/sdks/drives/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Drives -* [retrieve](#retrieve) - Retrieve Drives +* [list](#list) - List Drives +* [retrieve](#retrieve) - Retrieve Drive ## list -List Drives +List Drives ### Example Usage @@ -16,7 +16,7 @@ List Drives import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Drives from any connected Filestorage software +Retrieve a Drive from any connected file storage service ### Example Usage @@ -60,13 +60,14 @@ Retrieve Drives from any connected Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.drives.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/eeocs/README.md b/docs/sdks/eeocs/README.md index 3e2201dc..b87f9794 100644 --- a/docs/sdks/eeocs/README.md +++ b/docs/sdks/eeocs/README.md @@ -16,7 +16,7 @@ List Eeocss import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,7 +60,7 @@ Retrieve a eeocs from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/emails/README.md b/docs/sdks/emails/README.md index 2a673865..8e044a5b 100644 --- a/docs/sdks/emails/README.md +++ b/docs/sdks/emails/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Emails -* [retrieve](#retrieve) - Retrieve Emails +* [list](#list) - List Emails +* [retrieve](#retrieve) - Retrieve Email ## list -List Emails +List Emails ### Example Usage @@ -16,7 +16,7 @@ List Emails import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Emails from any connected Marketingautomation software +Retrieve an Email from any connected Marketingautomation software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Emails from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.emails.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/employeepayrollruns/README.md b/docs/sdks/employeepayrollruns/README.md index 02f86cde..f9dcd1d6 100644 --- a/docs/sdks/employeepayrollruns/README.md +++ b/docs/sdks/employeepayrollruns/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List EmployeePayrollRuns -* [retrieve](#retrieve) - Retrieve Employee Payroll Runs +* [list](#list) - List Employee Payroll Runs +* [retrieve](#retrieve) - Retrieve Employee Payroll Run ## list -List EmployeePayrollRuns +List Employee Payroll Runs ### Example Usage @@ -16,7 +16,7 @@ List EmployeePayrollRuns import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Employee Payroll Runs from any connected Hris software +Retrieve Employee Payroll Run from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Employee Payroll Runs from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employeepayrollruns.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md index 0f3f292f..f052cf07 100644 --- a/docs/sdks/employees/README.md +++ b/docs/sdks/employees/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Employees +* [list](#list) - List Employees * [create](#create) - Create Employees -* [retrieve](#retrieve) - Retrieven Employees +* [retrieve](#retrieve) - Retrieve Employee ## list -List Employees +List Employees ### Example Usage @@ -17,7 +17,7 @@ List Employees import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -36,7 +36,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisEmployeeRequest](../../models/operations/listhrisemployeerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisEmployeesRequest](../../models/operations/listhrisemployeesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -44,7 +44,7 @@ run(); ### Response -**Promise\<[operations.ListHrisEmployeeResponseBody](../../models/operations/listhrisemployeeresponsebody.md)\>** +**Promise\<[operations.ListHrisEmployeesResponseBody](../../models/operations/listhrisemployeesresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -61,7 +61,7 @@ Create Employees in any supported Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -98,7 +98,7 @@ run(); ## retrieve -Retrieven Employees from any connected Hris software +Retrieve an Employee from any connected Hris software ### Example Usage @@ -106,13 +106,14 @@ Retrieven Employees from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employees.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/employerbenefits/README.md b/docs/sdks/employerbenefits/README.md index 959b7528..259ba4a0 100644 --- a/docs/sdks/employerbenefits/README.md +++ b/docs/sdks/employerbenefits/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List EmployerBenefits -* [retrieve](#retrieve) - Retrieve Employer Benefits +* [list](#list) - List Employer Benefits +* [retrieve](#retrieve) - Retrieve Employer Benefit ## list -List EmployerBenefits +List Employer Benefits ### Example Usage @@ -16,7 +16,7 @@ List EmployerBenefits import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisEmployerBenefitRequest](../../models/operations/listhrisemployerbenefitrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisEmployerBenefitsRequest](../../models/operations/listhrisemployerbenefitsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisEmployerBenefitResponseBody](../../models/operations/listhrisemployerbenefitresponsebody.md)\>** +**Promise\<[operations.ListHrisEmployerBenefitsResponseBody](../../models/operations/listhrisemployerbenefitsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Employer Benefits from any connected Hris software +Retrieve an Employer Benefit from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Employer Benefits from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employerbenefits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/employments/README.md b/docs/sdks/employments/README.md index b121c249..c8ed4858 100644 --- a/docs/sdks/employments/README.md +++ b/docs/sdks/employments/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Employments -* [retrieve](#retrieve) - Retrieve Employments +* [list](#list) - List Employments +* [retrieve](#retrieve) - Retrieve Employment ## list -List Employments +List Employments ### Example Usage @@ -16,7 +16,7 @@ List Employments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisEmploymentRequest](../../models/operations/listhrisemploymentrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisEmploymentsRequest](../../models/operations/listhrisemploymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisEmploymentResponseBody](../../models/operations/listhrisemploymentresponsebody.md)\>** +**Promise\<[operations.ListHrisEmploymentsResponseBody](../../models/operations/listhrisemploymentsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Employments from any connected Hris software +Retrieve an Employment from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Employments from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.employments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/engagements/README.md b/docs/sdks/engagements/README.md index 59bcd3e9..3c50b46d 100644 --- a/docs/sdks/engagements/README.md +++ b/docs/sdks/engagements/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Engagements +* [list](#list) - List Engagements * [create](#create) - Create Engagements * [retrieve](#retrieve) - Retrieve Engagements ## list -List Engagements +List Engagements ### Example Usage @@ -17,7 +17,7 @@ List Engagements import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,16 +59,32 @@ Create Engagements in any supported Crm software ```typescript import { Panora } from "@panora/sdk"; +import { UnifiedCrmEngagementInputDirection, UnifiedCrmEngagementInputType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.engagements.create({ xConnectionToken: "", + remoteData: false, unifiedCrmEngagementInput: { - type: "", + content: "Meeting call with CTO", + direction: UnifiedCrmEngagementInputDirection.Inbound, + subject: "Technical features planning", + startAt: new Date("2024-10-01T12:00:00Z"), + endTime: new Date("2024-10-01T22:00:00Z"), + type: UnifiedCrmEngagementInputType.Meeting, + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contacts: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -108,13 +124,14 @@ Retrieve Engagements from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.engagements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/events/README.md b/docs/sdks/events/README.md index 5e97e1b8..2dbba779 100644 --- a/docs/sdks/events/README.md +++ b/docs/sdks/events/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Events -* [retrieve](#retrieve) - Retrieve Events +* [list](#list) - List Events +* [retrieve](#retrieve) - Retrieve Event ## list -List Events +List Events ### Example Usage @@ -16,7 +16,7 @@ List Events import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Events from any connected Marketingautomation software +Retrieve an Event from any connected Marketingautomation software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Events from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.events.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index b1706a19..c782ffac 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -17,7 +17,7 @@ List Expenses import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create Expenses in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.expenses.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingExpenseInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Expenses from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.expenses.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/fieldmappings/README.md b/docs/sdks/fieldmappings/README.md index 220b5e7c..905412dd 100644 --- a/docs/sdks/fieldmappings/README.md +++ b/docs/sdks/fieldmappings/README.md @@ -13,20 +13,21 @@ Create Custom Field ```typescript import { Panora } from "@panora/sdk"; +import { CustomFieldCreateDtoDataType, CustomFieldCreateDtoObjectTypeOwner } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.fieldMappings.defineCustomField({ - objectTypeOwner: "", - name: "", - description: "Balanced multimedia policy", - dataType: "point", - sourceCustomFieldId: "", - sourceProvider: "", - linkedUserId: "", + objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner.Company, + name: "my_favorite_dish", + description: "Favorite Dish", + dataType: CustomFieldCreateDtoDataType.String, + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result diff --git a/docs/sdks/files/README.md b/docs/sdks/files/README.md index 3bb9f304..32ed2436 100644 --- a/docs/sdks/files/README.md +++ b/docs/sdks/files/README.md @@ -17,7 +17,7 @@ List Files import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,7 +61,7 @@ Create Files in any supported Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -69,13 +69,17 @@ async function run() { xConnectionToken: "", remoteData: false, unifiedFilestorageFileInput: { - name: "", - fileUrl: "", - mimeType: "", - size: "", - folderId: "", - permission: "", - sharedLink: "", + name: "my_paris_photo.png", + fileUrl: "https://example.com/my_paris_photo.png", + mimeType: "application/pdf", + size: "1024", + folderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -115,13 +119,14 @@ Retrieve Files from any connected Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.files.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/folders/README.md b/docs/sdks/folders/README.md index 733f7d9e..96a3dfef 100644 --- a/docs/sdks/folders/README.md +++ b/docs/sdks/folders/README.md @@ -17,7 +17,7 @@ List Folders import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,7 +61,7 @@ Create Folders in any supported Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -69,14 +69,18 @@ async function run() { xConnectionToken: "", remoteData: false, unifiedFilestorageFolderInput: { - name: "", - size: "", - folderUrl: "", - description: "Multi-tiered human-resource model", - driveId: "", - parentFolderId: "", - sharedLink: "", - permission: "", + name: "school", + size: "2048", + folderUrl: "https://example.com/school", + description: "All things school related", + driveId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + parentFolderId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sharedLink: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + permission: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -116,13 +120,14 @@ Retrieve Folders from any connected Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.folders.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/fromremoteid/README.md b/docs/sdks/fromremoteid/README.md index ee77336f..b41525cb 100644 --- a/docs/sdks/fromremoteid/README.md +++ b/docs/sdks/fromremoteid/README.md @@ -15,12 +15,12 @@ Retrieve a Linked User From A Remote Id import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.linkedUsers.fromremoteid.remoteId({ - remoteId: "", + remoteId: "id_1", }); // Handle the result diff --git a/docs/sdks/groups/README.md b/docs/sdks/groups/README.md index 48c104bf..016c1fda 100644 --- a/docs/sdks/groups/README.md +++ b/docs/sdks/groups/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Groups -* [retrieve](#retrieve) - Retrieve Groups +* [list](#list) - List Groups +* [retrieve](#retrieve) - Retrieve Group ## list -List Groups +List Groups ### Example Usage @@ -16,7 +16,7 @@ List Groups import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisGroupRequest](../../models/operations/listhrisgrouprequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisGroupsRequest](../../models/operations/listhrisgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisGroupResponseBody](../../models/operations/listhrisgroupresponsebody.md)\>** +**Promise\<[operations.ListHrisGroupsResponseBody](../../models/operations/listhrisgroupsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Groups from any connected Hris software +Retrieve a Group from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Groups from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.groups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/single/README.md b/docs/sdks/id/README.md similarity index 94% rename from docs/sdks/single/README.md rename to docs/sdks/id/README.md index 6ae509c3..65ba9c41 100644 --- a/docs/sdks/single/README.md +++ b/docs/sdks/id/README.md @@ -1,5 +1,5 @@ -# Single -(*linkedUsers.single*) +# Id +(*linkedUsers.id*) ### Available Operations @@ -15,16 +15,15 @@ Retrieve Linked Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { - const result = await panora.linkedUsers.single.retrieve({ - id: "", + await panora.linkedUsers.id.retrieve({ + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); - // Handle the result - console.log(result) + } run(); @@ -42,7 +41,7 @@ run(); ### Response -**Promise\<[components.LinkedUserResponse](../../models/components/linkeduserresponse.md)\>** +**Promise\** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/incomestatements/README.md b/docs/sdks/incomestatements/README.md index 1a6be737..f31893e7 100644 --- a/docs/sdks/incomestatements/README.md +++ b/docs/sdks/incomestatements/README.md @@ -16,7 +16,7 @@ List IncomeStatements import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Income Statements from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.incomestatements.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/interviews/README.md b/docs/sdks/interviews/README.md index 9c816f87..7312b5c2 100644 --- a/docs/sdks/interviews/README.md +++ b/docs/sdks/interviews/README.md @@ -17,7 +17,7 @@ List Interviews import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,15 +59,34 @@ Create Interviews in any supported Ats software ```typescript import { Panora } from "@panora/sdk"; +import { UnifiedAtsInterviewInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.interviews.create({ xConnectionToken: "", - unifiedAtsInterviewInput: {}, + remoteData: false, + unifiedAtsInterviewInput: { + status: UnifiedAtsInterviewInputStatus.Scheduled, + applicationId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + jobInterviewStageId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + organizedBy: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + interviewers: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + location: "San Francisco", + startAt: new Date("2024-10-01T12:00:00Z"), + endAt: new Date("2024-10-01T12:00:00Z"), + remoteCreatedAt: new Date("2024-10-01T12:00:00Z"), + remoteUpdatedAt: new Date("2024-10-01T12:00:00Z"), + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, + }, }); // Handle the result @@ -106,13 +125,14 @@ Retrieve Interviews from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.interviews.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index 45798440..cb28925d 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -17,7 +17,7 @@ List Invoices import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create invoices in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.invoices.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingInvoiceInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Invoices from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.invoices.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/items/README.md b/docs/sdks/items/README.md index 696cbf97..9394eb99 100644 --- a/docs/sdks/items/README.md +++ b/docs/sdks/items/README.md @@ -16,7 +16,7 @@ List Items import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Items from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.items.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/jobinterviewstages/README.md b/docs/sdks/jobinterviewstages/README.md index e6b6d8e6..7c69c7d7 100644 --- a/docs/sdks/jobinterviewstages/README.md +++ b/docs/sdks/jobinterviewstages/README.md @@ -16,7 +16,7 @@ List JobInterviewStages import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Job Interview Stages from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.jobinterviewstages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index 7e5b2667..637524af 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -16,7 +16,7 @@ List Jobs import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Jobs from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.jobs.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index 3e52ba83..414e79b4 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -17,7 +17,7 @@ List JournalEntrys import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create Journal Entries in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.journalentries.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingJournalentryInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Journal Entries from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.journalentries.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/linkedusers/README.md b/docs/sdks/linkedusers/README.md index 01dbb19e..3338f1e2 100644 --- a/docs/sdks/linkedusers/README.md +++ b/docs/sdks/linkedusers/README.md @@ -16,13 +16,13 @@ Create Linked Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.linkedUsers.create({ - linkedUserOriginId: "", - alias: "", + linkedUserOriginId: "id_1", + alias: "acme", }); // Handle the result @@ -61,7 +61,7 @@ List Linked Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/lists/README.md b/docs/sdks/lists/README.md index 60087c6a..ff2ca364 100644 --- a/docs/sdks/lists/README.md +++ b/docs/sdks/lists/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Lists +* [list](#list) - List Lists * [create](#create) - Create Lists -* [retrieve](#retrieve) - Retrieve Lists +* [retrieve](#retrieve) - Retrieve List ## list -List Lists +List Lists ### Example Usage @@ -17,7 +17,7 @@ List Lists import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,7 +61,7 @@ Create Lists in any supported Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -98,7 +98,7 @@ run(); ## retrieve -Retrieve Lists from any connected Marketingautomation software +Retrieve a List from any connected Marketingautomation software ### Example Usage @@ -106,13 +106,14 @@ Retrieve Lists from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.lists.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/locations/README.md b/docs/sdks/locations/README.md index e02ec311..1d13c8f6 100644 --- a/docs/sdks/locations/README.md +++ b/docs/sdks/locations/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Locations -* [retrieve](#retrieve) - Retrieve Locations +* [list](#list) - List Locations +* [retrieve](#retrieve) - Retrieve Location ## list -List Locations +List Locations ### Example Usage @@ -16,7 +16,7 @@ List Locations import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisLocationRequest](../../models/operations/listhrislocationrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisLocationsRequest](../../models/operations/listhrislocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisLocationResponseBody](../../models/operations/listhrislocationresponsebody.md)\>** +**Promise\<[operations.ListHrisLocationsResponseBody](../../models/operations/listhrislocationsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Locations from any connected Hris software +Retrieve a Location from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Locations from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.locations.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/map/README.md b/docs/sdks/map/README.md index 0cc30ef9..914a5453 100644 --- a/docs/sdks/map/README.md +++ b/docs/sdks/map/README.md @@ -15,15 +15,15 @@ Map Custom Field import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.fieldMappings.map.map({ - attributeId: "", - sourceCustomFieldId: "", - sourceProvider: "", - linkedUserId: "", + attributeId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + sourceCustomFieldId: "id_1", + sourceProvider: "hubspot", + linkedUserId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index 591cd9e0..e85359d8 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Messages +* [list](#list) - List Messages * [retrieve](#retrieve) - Retrieve Messages ## list -List Messages +List Messages ### Example Usage @@ -16,7 +16,7 @@ List Messages import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Messages from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.messages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/notes/README.md b/docs/sdks/notes/README.md index 2c940059..14bec15c 100644 --- a/docs/sdks/notes/README.md +++ b/docs/sdks/notes/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Notes +* [list](#list) - List Notes * [create](#create) - Create Notes * [retrieve](#retrieve) - Retrieve Notes ## list -List Notes +List Notes ### Example Usage @@ -17,7 +17,7 @@ List Notes import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,14 +61,23 @@ Create Notes in any supported Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.notes.create({ xConnectionToken: "", + remoteData: false, unifiedCrmNoteInput: { - content: "", + content: "My notes taken during the meeting", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -108,13 +117,14 @@ Retrieve Notes from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.notes.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/offers/README.md b/docs/sdks/offers/README.md index 7541478c..d6a2f22f 100644 --- a/docs/sdks/offers/README.md +++ b/docs/sdks/offers/README.md @@ -16,7 +16,7 @@ List Offers import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Offers from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.offers.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/offices/README.md b/docs/sdks/offices/README.md index 8dcb46a3..786c8255 100644 --- a/docs/sdks/offices/README.md +++ b/docs/sdks/offices/README.md @@ -16,7 +16,7 @@ List Offices import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Offices from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.offices.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panora/README.md b/docs/sdks/panora/README.md index e06dd0a9..b779024b 100644 --- a/docs/sdks/panora/README.md +++ b/docs/sdks/panora/README.md @@ -18,7 +18,7 @@ Panora API: A unified API to ship integrations import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -57,7 +57,7 @@ run(); import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/panoraaccountingcontacts/README.md b/docs/sdks/panoraaccountingcontacts/README.md index 833123d7..e4a8bce3 100644 --- a/docs/sdks/panoraaccountingcontacts/README.md +++ b/docs/sdks/panoraaccountingcontacts/README.md @@ -17,7 +17,7 @@ List Contacts import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create contacts in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.contacts.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingContactInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Contacts from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoraaccounts/README.md b/docs/sdks/panoraaccounts/README.md index eaa2d488..69a89ba6 100644 --- a/docs/sdks/panoraaccounts/README.md +++ b/docs/sdks/panoraaccounts/README.md @@ -17,7 +17,7 @@ List Accounts import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create accounts in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.accounts.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingAccountInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Accounts from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.accounts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoraatsusers/README.md b/docs/sdks/panoraatsusers/README.md index c89a03e7..6acb70c2 100644 --- a/docs/sdks/panoraatsusers/README.md +++ b/docs/sdks/panoraatsusers/README.md @@ -16,7 +16,7 @@ List Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Users from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoraattachments/README.md b/docs/sdks/panoraattachments/README.md index 20dc4ef2..70b9b155 100644 --- a/docs/sdks/panoraattachments/README.md +++ b/docs/sdks/panoraattachments/README.md @@ -17,7 +17,7 @@ List Attachments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create attachments in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.attachments.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingAttachmentInput: {}, }); @@ -106,13 +107,14 @@ Retrieve attachments from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.attachments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoracompanies/README.md b/docs/sdks/panoracompanies/README.md index 7d8d6322..75588a4c 100644 --- a/docs/sdks/panoracompanies/README.md +++ b/docs/sdks/panoracompanies/README.md @@ -3,11 +3,12 @@ ### Available Operations -* [list](#list) - List Companys +* [list](#list) - List Companies +* [retrieve](#retrieve) - Retrieve Company ## list -List Companys +List Companies ### Example Usage @@ -15,7 +16,7 @@ List Companys import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -34,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisCompanysRequest](../../models/operations/listhriscompanysrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisCompaniesRequest](../../models/operations/listhriscompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -42,7 +43,53 @@ run(); ### Response -**Promise\<[operations.ListHrisCompanysResponseBody](../../models/operations/listhriscompanysresponsebody.md)\>** +**Promise\<[operations.ListHrisCompaniesResponseBody](../../models/operations/listhriscompaniesresponsebody.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | + +## retrieve + +Retrieve a Company from any connected Hris software + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.hris.companies.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.RetrieveHrisCompanyRequest](../../models/operations/retrievehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + +### Response + +**Promise\<[components.UnifiedHrisCompanyOutput](../../models/components/unifiedhriscompanyoutput.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoracontacts/README.md b/docs/sdks/panoracontacts/README.md index f7203ae8..a7f71c5f 100644 --- a/docs/sdks/panoracontacts/README.md +++ b/docs/sdks/panoracontacts/README.md @@ -17,7 +17,7 @@ List CRM Contacts import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,17 +59,48 @@ Create Contacts in any supported CRM ```typescript import { Panora } from "@panora/sdk"; +import { AddressType, EmailAddressType, PhoneType } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.contacts.create({ xConnectionToken: "", + remoteData: false, unifiedCrmContactInput: { - firstName: "Jed", - lastName: "Kuhn", + firstName: "John", + lastName: "Doe", + emailAddresses: [ + { + emailAddress: "Jena.Nienow28@yahoo.com", + emailAddressType: EmailAddressType.Personal, + }, + ], + phoneNumbers: [ + { + phoneNumber: "", + phoneType: PhoneType.Work, + }, + ], + addresses: [ + { + street1: "", + street2: "", + city: "Anytown", + state: "CA", + postalCode: "97398", + country: "USA", + addressType: AddressType.Personal, + ownerType: "", + }, + ], + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -109,13 +140,14 @@ Retrieve Contacts from any connected CRM import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panorafilestorageusers/README.md b/docs/sdks/panorafilestorageusers/README.md index 6eccac25..9585376f 100644 --- a/docs/sdks/panorafilestorageusers/README.md +++ b/docs/sdks/panorafilestorageusers/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Users +* [list](#list) - List Users * [retrieve](#retrieve) - Retrieve Users ## list -List Users +List Users ### Example Usage @@ -16,7 +16,7 @@ List Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Users from any connected Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result @@ -88,7 +89,7 @@ run(); ### Response -**Promise\<[components.UnifiedUserOutput](../../models/components/unifieduseroutput.md)\>** +**Promise\<[components.UnifiedFilestorageUserOutput](../../models/components/unifiedfilestorageuseroutput.md)\>** ### Errors | Error Object | Status Code | Content Type | diff --git a/docs/sdks/panoragroups/README.md b/docs/sdks/panoragroups/README.md index 99d9e408..95578b5f 100644 --- a/docs/sdks/panoragroups/README.md +++ b/docs/sdks/panoragroups/README.md @@ -16,7 +16,7 @@ List Groups import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Groups from any connected Filestorage software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.filestorage.groups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoramarketingautomationcontacts/README.md b/docs/sdks/panoramarketingautomationcontacts/README.md index f6a991f9..4c5a5ac4 100644 --- a/docs/sdks/panoramarketingautomationcontacts/README.md +++ b/docs/sdks/panoramarketingautomationcontacts/README.md @@ -17,7 +17,7 @@ List Contacts import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create a contact in any supported Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.contacts.create({ xConnectionToken: "", + remoteData: false, unifiedMarketingautomationContactInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Contacts from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.contacts.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoramarketingautomationusers/README.md b/docs/sdks/panoramarketingautomationusers/README.md index 643760fa..8f10b293 100644 --- a/docs/sdks/panoramarketingautomationusers/README.md +++ b/docs/sdks/panoramarketingautomationusers/README.md @@ -16,7 +16,7 @@ List Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Users from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoratags/README.md b/docs/sdks/panoratags/README.md index 8e552835..828df249 100644 --- a/docs/sdks/panoratags/README.md +++ b/docs/sdks/panoratags/README.md @@ -16,7 +16,7 @@ List Tags import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Tags from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.tags.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panoraticketingattachments/README.md b/docs/sdks/panoraticketingattachments/README.md index 6089523c..81b3d0ac 100644 --- a/docs/sdks/panoraticketingattachments/README.md +++ b/docs/sdks/panoraticketingattachments/README.md @@ -17,7 +17,7 @@ List Attachments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,18 +61,21 @@ Create Attachments in any supported Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.attachments.create({ xConnectionToken: "", unifiedTicketingAttachmentInput: { - fileName: "your_file_here", - fileUrl: "", - uploader: "", + fileName: "features_planning.pdf", + fileUrl: "https://example.com/features_planning.pdf", + uploader: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + commentId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", fieldMappings: { - "key": "", + "fav_dish": "broccoli", + "fav_color": "red", }, }, }); @@ -113,13 +116,14 @@ Retrieve Attachments from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.attachments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/panorausers/README.md b/docs/sdks/panorausers/README.md index 680cf2f8..3bbace23 100644 --- a/docs/sdks/panorausers/README.md +++ b/docs/sdks/panorausers/README.md @@ -16,7 +16,7 @@ List Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Users from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.users.retrieve({ xConnectionToken: "", - id: "", + id: "b008e199-eda9-4629-bd41-a01b6195864a", + remoteData: true, }); // Handle the result diff --git a/docs/sdks/passthrough/README.md b/docs/sdks/passthrough/README.md index df8ed6cd..a8b62438 100644 --- a/docs/sdks/passthrough/README.md +++ b/docs/sdks/passthrough/README.md @@ -16,7 +16,7 @@ import { Panora } from "@panora/sdk"; import { Method } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -27,6 +27,12 @@ async function run() { passThroughRequestDto: { method: Method.Get, path: "/dev", + data: { + "key": "", + }, + headers: { + "key": "", + }, }, }); diff --git a/docs/sdks/paygroups/README.md b/docs/sdks/paygroups/README.md index f9318482..0420267f 100644 --- a/docs/sdks/paygroups/README.md +++ b/docs/sdks/paygroups/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List PayGroups -* [retrieve](#retrieve) - Retrieve Pay Groups +* [list](#list) - List Pay Groups +* [retrieve](#retrieve) - Retrieve Pay Group ## list -List PayGroups +List Pay Groups ### Example Usage @@ -16,7 +16,7 @@ List PayGroups import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisPaygroupRequest](../../models/operations/listhrispaygrouprequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisPaygroupsRequest](../../models/operations/listhrispaygroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisPaygroupResponseBody](../../models/operations/listhrispaygroupresponsebody.md)\>** +**Promise\<[operations.ListHrisPaygroupsResponseBody](../../models/operations/listhrispaygroupsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Pay Groups from any connected Hris software +Retrieve a Pay Group from any connected Hris software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Pay Groups from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.paygroups.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/payments/README.md b/docs/sdks/payments/README.md index a1c91d64..449878e9 100644 --- a/docs/sdks/payments/README.md +++ b/docs/sdks/payments/README.md @@ -17,7 +17,7 @@ List Payments import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create Payments in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.payments.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingPaymentInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Payments from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.payments.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/payrollruns/README.md b/docs/sdks/payrollruns/README.md index 6c87d5b1..85d70de6 100644 --- a/docs/sdks/payrollruns/README.md +++ b/docs/sdks/payrollruns/README.md @@ -3,11 +3,12 @@ ### Available Operations -* [list](#list) - List PayrollRuns +* [list](#list) - List Payroll Runs +* [retrieve](#retrieve) - Retrieve Payroll Run ## list -List PayrollRuns +List Payroll Runs ### Example Usage @@ -15,7 +16,7 @@ List PayrollRuns import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -48,3 +49,49 @@ run(); | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | + +## retrieve + +Retrieve a Payroll Run from any connected Hris software + +### Example Usage + +```typescript +import { Panora } from "@panora/sdk"; + +const panora = new Panora({ + apiKey: "", +}); + +async function run() { + const result = await panora.hris.payrollruns.retrieve({ + xConnectionToken: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, + }); + + // Handle the result + console.log(result) +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.RetrieveHrisPayrollRunRequest](../../models/operations/retrievehrispayrollrunrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + + +### Response + +**Promise\<[components.UnifiedHrisPayrollrunOutput](../../models/components/unifiedhrispayrollrunoutput.md)\>** +### Errors + +| Error Object | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/phonenumbers/README.md b/docs/sdks/phonenumbers/README.md index 3b704e06..e682bd00 100644 --- a/docs/sdks/phonenumbers/README.md +++ b/docs/sdks/phonenumbers/README.md @@ -16,7 +16,7 @@ List PhoneNumbers import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Phone Numbers from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.phonenumbers.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index 67173337..41b00688 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -17,7 +17,7 @@ List PurchaseOrders import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,12 +61,13 @@ Create Purchase Orders in any supported Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.purchaseorders.create({ xConnectionToken: "", + remoteData: false, unifiedAccountingPurchaseorderInput: {}, }); @@ -106,13 +107,14 @@ Retrieve Purchase Orders from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.purchaseorders.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/rejectreasons/README.md b/docs/sdks/rejectreasons/README.md index 5654c967..5cd82b8e 100644 --- a/docs/sdks/rejectreasons/README.md +++ b/docs/sdks/rejectreasons/README.md @@ -16,7 +16,7 @@ List RejectReasons import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Reject Reasons from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.rejectreasons.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/scorecards/README.md b/docs/sdks/scorecards/README.md index 7c6a3fb8..1f660e7e 100644 --- a/docs/sdks/scorecards/README.md +++ b/docs/sdks/scorecards/README.md @@ -16,7 +16,7 @@ List ScoreCards import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Score Cards from any connected Ats software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ats.scorecards.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/stages/README.md b/docs/sdks/stages/README.md index 65b004ea..15366f7c 100644 --- a/docs/sdks/stages/README.md +++ b/docs/sdks/stages/README.md @@ -16,7 +16,7 @@ List Stages import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Stages from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.stages.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/sync/README.md b/docs/sdks/sync/README.md index 92061f85..f0d92ac4 100644 --- a/docs/sdks/sync/README.md +++ b/docs/sdks/sync/README.md @@ -14,14 +14,15 @@ Retrieve sync status of a certain vertical ```typescript import { Panora } from "@panora/sdk"; +import { Vertical } from "@panora/sdk/models/operations"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { await panora.sync.status({ - vertical: "", + vertical: Vertical.Ticketing, }); @@ -59,7 +60,7 @@ Resync common objects across a vertical import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/docs/sdks/tags/README.md b/docs/sdks/tags/README.md index afcb4a42..f5fd3fed 100644 --- a/docs/sdks/tags/README.md +++ b/docs/sdks/tags/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Tags -* [retrieve](#retrieve) - Retrieve Tags +* [list](#list) - List Tags +* [retrieve](#retrieve) - Retrieve Tag ## list -List Tags +List Tags ### Example Usage @@ -16,7 +16,7 @@ List Tags import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Tags from any connected Ticketing software +Retrieve a Tag from any connected Ticketing software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Tags from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.tags.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/tasks/README.md b/docs/sdks/tasks/README.md index 4796d36f..905d98c3 100644 --- a/docs/sdks/tasks/README.md +++ b/docs/sdks/tasks/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Tasks +* [list](#list) - List Tasks * [create](#create) - Create Tasks * [retrieve](#retrieve) - Retrieve Tasks ## list -List Tasks +List Tasks ### Example Usage @@ -17,7 +17,7 @@ List Tasks import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,18 +59,28 @@ Create Tasks in any supported Crm software ```typescript import { Panora } from "@panora/sdk"; +import { UnifiedCrmTaskInputStatus } from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.tasks.create({ xConnectionToken: "", unifiedCrmTaskInput: { - subject: "", - content: "", - status: "", + subject: "Answer customers", + content: "Prepare email campaign", + status: UnifiedCrmTaskInputStatus.Pending, + dueDate: "2024-10-01T12:00:00Z", + finishedDate: "2024-10-01T12:00:00Z", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + companyId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + dealId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -110,13 +120,14 @@ Retrieve Tasks from any connected Crm software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.crm.tasks.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/taxrates/README.md b/docs/sdks/taxrates/README.md index c8628d48..6a8acb88 100644 --- a/docs/sdks/taxrates/README.md +++ b/docs/sdks/taxrates/README.md @@ -16,7 +16,7 @@ List TaxRates import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Tax Rates from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.taxrates.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/teams/README.md b/docs/sdks/teams/README.md index d6327208..e332bd79 100644 --- a/docs/sdks/teams/README.md +++ b/docs/sdks/teams/README.md @@ -16,7 +16,7 @@ List Teams import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Teams from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.teams.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/templates/README.md b/docs/sdks/templates/README.md index 447ac647..9221d777 100644 --- a/docs/sdks/templates/README.md +++ b/docs/sdks/templates/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Templates +* [list](#list) - List Templates * [create](#create) - Create Template -* [retrieve](#retrieve) - Retrieve Templates +* [retrieve](#retrieve) - Retrieve Template ## list -List Templates +List Templates ### Example Usage @@ -17,7 +17,7 @@ List Templates import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,7 +61,7 @@ Create a template in any supported Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -98,7 +98,7 @@ run(); ## retrieve -Retrieve Templates from any connected Marketingautomation software +Retrieve a Template from any connected Marketingautomation software ### Example Usage @@ -106,13 +106,14 @@ Retrieve Templates from any connected Marketingautomation software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.marketingautomation.templates.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/tickets/README.md b/docs/sdks/tickets/README.md index 5c614a95..a6a94a71 100644 --- a/docs/sdks/tickets/README.md +++ b/docs/sdks/tickets/README.md @@ -17,7 +17,7 @@ List Tickets import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -59,17 +59,59 @@ Create Tickets in any supported Ticketing software ```typescript import { Panora } from "@panora/sdk"; +import { + UnifiedTicketingTicketInputCreatorType, + UnifiedTicketingTicketInputPriority, + UnifiedTicketingTicketInputStatus, + UnifiedTicketingTicketInputType, +} from "@panora/sdk/models/components"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.tickets.create({ xConnectionToken: "", + remoteData: false, unifiedTicketingTicketInput: { - name: "", - description: "Multi-tiered human-resource model", + name: "Customer Service Inquiry", + status: UnifiedTicketingTicketInputStatus.Open, + description: "Help customer", + dueDate: new Date("2024-10-01T12:00:00Z"), + type: UnifiedTicketingTicketInputType.Bug, + parentTicket: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + collections: "[\"801f9ede-c698-4e66-a7fc-48d19eebaa4f\"]", + tags: [ + "my_tag", + "urgent_tag", + ], + completedAt: new Date("2024-10-01T12:00:00Z"), + priority: UnifiedTicketingTicketInputPriority.High, + assignedTo: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + comment: { + body: "Assigned to Eric !", + htmlBody: "

Assigned to Eric !

", + isPrivate: false, + creatorType: UnifiedTicketingTicketInputCreatorType.User, + ticketId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + userId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + }, + accountId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + contactId: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + attachments: [ + "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + ], + fieldMappings: { + "fav_dish": "broccoli", + "fav_color": "red", + }, }, }); @@ -109,13 +151,14 @@ Retrieve Tickets from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.tickets.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/timeoffbalances/README.md b/docs/sdks/timeoffbalances/README.md index 6a0550b9..439d6f3b 100644 --- a/docs/sdks/timeoffbalances/README.md +++ b/docs/sdks/timeoffbalances/README.md @@ -16,7 +16,7 @@ List TimeoffBalances import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -35,7 +35,7 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListHrisTimeoffbalanceRequest](../../models/operations/listhristimeoffbalancerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListHrisTimeoffbalancesRequest](../../models/operations/listhristimeoffbalancesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | @@ -43,7 +43,7 @@ run(); ### Response -**Promise\<[operations.ListHrisTimeoffbalanceResponseBody](../../models/operations/listhristimeoffbalanceresponsebody.md)\>** +**Promise\<[operations.ListHrisTimeoffbalancesResponseBody](../../models/operations/listhristimeoffbalancesresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | @@ -60,13 +60,14 @@ Retrieve Time off Balances from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.timeoffbalances.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/timeoffs/README.md b/docs/sdks/timeoffs/README.md index 7e2a43ff..683c0f65 100644 --- a/docs/sdks/timeoffs/README.md +++ b/docs/sdks/timeoffs/README.md @@ -3,13 +3,13 @@ ### Available Operations -* [list](#list) - List Timeoffs +* [list](#list) - List Time Offs * [create](#create) - Create Timeoffs -* [retrieve](#retrieve) - Retrieve Timeoffs +* [retrieve](#retrieve) - Retrieve Time Off ## list -List Timeoffs +List Time Offs ### Example Usage @@ -17,7 +17,7 @@ List Timeoffs import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -61,7 +61,7 @@ Create Timeoffs in any supported Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -98,7 +98,7 @@ run(); ## retrieve -Retrieve Timeoffs from any connected Hris software +Retrieve a Time Off from any connected Hris software ### Example Usage @@ -106,13 +106,14 @@ Retrieve Timeoffs from any connected Hris software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.hris.timeoffs.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/trackingcategories/README.md b/docs/sdks/trackingcategories/README.md index 4b1b6f19..0710c4aa 100644 --- a/docs/sdks/trackingcategories/README.md +++ b/docs/sdks/trackingcategories/README.md @@ -16,7 +16,7 @@ List TrackingCategorys import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Tracking Categories from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.trackingcategories.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/transactions/README.md b/docs/sdks/transactions/README.md index 7f17f5eb..32050bd7 100644 --- a/docs/sdks/transactions/README.md +++ b/docs/sdks/transactions/README.md @@ -16,7 +16,7 @@ List Transactions import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Transactions from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.transactions.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index 5a97a13e..d6b970f9 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -3,12 +3,12 @@ ### Available Operations -* [list](#list) - List Users -* [retrieve](#retrieve) - Retrieve Users +* [list](#list) - List Users +* [retrieve](#retrieve) - Retrieve User ## list -List Users +List Users ### Example Usage @@ -16,7 +16,7 @@ List Users import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -52,7 +52,7 @@ run(); ## retrieve -Retrieve Users from any connected Ticketing software +Retrieve a User from any connected Ticketing software ### Example Usage @@ -60,13 +60,14 @@ Retrieve Users from any connected Ticketing software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.ticketing.users.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/vendorcredits/README.md b/docs/sdks/vendorcredits/README.md index 8cb22772..d0e0f8c1 100644 --- a/docs/sdks/vendorcredits/README.md +++ b/docs/sdks/vendorcredits/README.md @@ -16,7 +16,7 @@ List VendorCredits import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,13 +60,14 @@ Retrieve Vendor Credits from any connected Accounting software import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.accounting.vendorcredits.retrieve({ xConnectionToken: "", - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", + remoteData: false, }); // Handle the result diff --git a/docs/sdks/webhooks/README.md b/docs/sdks/webhooks/README.md index 4f908074..f0bda15f 100644 --- a/docs/sdks/webhooks/README.md +++ b/docs/sdks/webhooks/README.md @@ -19,7 +19,7 @@ List webhooks import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { @@ -60,14 +60,15 @@ Add webhook metadata import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.webhooks.create({ - url: "http://limp-pastry.org", + url: "https://acme.com/webhook_receiver", + description: "Webhook to receive connection events", scope: [ - "", + "connection.created", ], }); @@ -107,12 +108,12 @@ Delete Webhook import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.webhooks.delete({ - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -151,12 +152,12 @@ Update webhook status import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { const result = await panora.webhooks.updateStatus({ - id: "", + id: "801f9ede-c698-4e66-a7fc-48d19eebaa4f", }); // Handle the result @@ -195,7 +196,7 @@ Verify payload signature of the webhook import { Panora } from "@panora/sdk"; const panora = new Panora({ - apiKey: process.env.API_KEY, + apiKey: "", }); async function run() { diff --git a/jsr.json b/jsr.json index 2ac9cfc7..00f6e4ac 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@panora/sdk", - "version": "0.4.2", + "version": "0.5.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index f1cd3e26..61033153 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@panora/sdk", - "version": "0.4.2", + "version": "0.5.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@panora/sdk", - "version": "0.4.2", + "version": "0.5.0", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index f5e15133..d93506d1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@panora/sdk", - "version": "0.4.2", + "version": "0.5.0", "author": "Speakeasy", "main": "./index.js", "sideEffects": false, diff --git a/src/lib/config.ts b/src/lib/config.ts index 49abd676..85741e4a 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -63,7 +63,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "1.0", - sdkVersion: "0.4.2", - genVersion: "2.385.1", - userAgent: "speakeasy-sdk/typescript 0.4.2 2.385.1 1.0 @panora/sdk", + sdkVersion: "0.5.0", + genVersion: "2.385.2", + userAgent: "speakeasy-sdk/typescript 0.5.0 2.385.2 1.0 @panora/sdk", } as const; diff --git a/src/models/components/address.ts b/src/models/components/address.ts index f33d0456..21e7712b 100644 --- a/src/models/components/address.ts +++ b/src/models/components/address.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The address type. Authorized values are either PERSONAL or WORK. + */ +export enum AddressType { + Personal = "PERSONAL", + Work = "WORK", +} + export type Address = { /** * The street @@ -33,13 +41,32 @@ export type Address = { /** * The address type. Authorized values are either PERSONAL or WORK. */ - addressType: string | null; + addressType: AddressType | null; /** * The owner type of the address */ ownerType: string | null; }; +/** @internal */ +export const AddressType$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(AddressType); + +/** @internal */ +export const AddressType$outboundSchema: z.ZodNativeEnum = + AddressType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AddressType$ { + /** @deprecated use `AddressType$inboundSchema` instead. */ + export const inboundSchema = AddressType$inboundSchema; + /** @deprecated use `AddressType$outboundSchema` instead. */ + export const outboundSchema = AddressType$outboundSchema; +} + /** @internal */ export const Address$inboundSchema: z.ZodType = z .object({ @@ -49,7 +76,7 @@ export const Address$inboundSchema: z.ZodType = state: z.nullable(z.string()), postal_code: z.nullable(z.string()), country: z.nullable(z.string()), - address_type: z.nullable(z.string()), + address_type: z.nullable(AddressType$inboundSchema), owner_type: z.nullable(z.string()), }) .transform((v) => { @@ -83,7 +110,7 @@ export const Address$outboundSchema: z.ZodType { diff --git a/src/models/components/createbatchlinkeduserdto.ts b/src/models/components/createbatchlinkeduserdto.ts index c7f2a588..7644744d 100644 --- a/src/models/components/createbatchlinkeduserdto.ts +++ b/src/models/components/createbatchlinkeduserdto.ts @@ -6,7 +6,13 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; export type CreateBatchLinkedUserDto = { + /** + * The ids of the users in the context of your own software + */ linkedUserOriginIds: Array | null; + /** + * Your company alias + */ alias: string | null; }; diff --git a/src/models/components/createlinkeduserdto.ts b/src/models/components/createlinkeduserdto.ts index 4fd21fa5..6d0305f2 100644 --- a/src/models/components/createlinkeduserdto.ts +++ b/src/models/components/createlinkeduserdto.ts @@ -6,7 +6,13 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; export type CreateLinkedUserDto = { - linkedUserOriginId: string | null; + /** + * The id of the user in the context of your own software + */ + linkedUserOriginId: string; + /** + * Your company alias + */ alias: string | null; }; @@ -17,7 +23,7 @@ export const CreateLinkedUserDto$inboundSchema: z.ZodType< unknown > = z .object({ - linked_user_origin_id: z.nullable(z.string()), + linked_user_origin_id: z.string(), alias: z.nullable(z.string()), }) .transform((v) => { @@ -28,7 +34,7 @@ export const CreateLinkedUserDto$inboundSchema: z.ZodType< /** @internal */ export type CreateLinkedUserDto$Outbound = { - linked_user_origin_id: string | null; + linked_user_origin_id: string; alias: string | null; }; @@ -39,7 +45,7 @@ export const CreateLinkedUserDto$outboundSchema: z.ZodType< CreateLinkedUserDto > = z .object({ - linkedUserOriginId: z.nullable(z.string()), + linkedUserOriginId: z.string(), alias: z.nullable(z.string()), }) .transform((v) => { diff --git a/src/models/components/customfieldcreatedto.ts b/src/models/components/customfieldcreatedto.ts index fee93a91..fb4a8d2c 100644 --- a/src/models/components/customfieldcreatedto.ts +++ b/src/models/components/customfieldcreatedto.ts @@ -5,16 +5,96 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +export enum CustomFieldCreateDtoObjectTypeOwner { + Company = "company", + Contact = "contact", + Deal = "deal", + Lead = "lead", + Note = "note", + Task = "task", + Engagement = "engagement", + Stage = "stage", + User = "user", +} + +/** + * The data type of the custom field + */ +export enum CustomFieldCreateDtoDataType { + String = "string", + Number = "number", +} + export type CustomFieldCreateDto = { - objectTypeOwner: string | null; + objectTypeOwner: CustomFieldCreateDtoObjectTypeOwner | null; + /** + * The name of the custom field + */ name: string | null; + /** + * The description of the custom field + */ description: string | null; - dataType: string | null; + /** + * The data type of the custom field + */ + dataType: CustomFieldCreateDtoDataType | null; + /** + * The source custom field ID + */ sourceCustomFieldId: string | null; + /** + * The name of the source software/provider + */ sourceProvider: string | null; + /** + * The linked user ID + */ linkedUserId: string | null; }; +/** @internal */ +export const CustomFieldCreateDtoObjectTypeOwner$inboundSchema: z.ZodNativeEnum< + typeof CustomFieldCreateDtoObjectTypeOwner +> = z.nativeEnum(CustomFieldCreateDtoObjectTypeOwner); + +/** @internal */ +export const CustomFieldCreateDtoObjectTypeOwner$outboundSchema: z.ZodNativeEnum< + typeof CustomFieldCreateDtoObjectTypeOwner +> = CustomFieldCreateDtoObjectTypeOwner$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateDtoObjectTypeOwner$ { + /** @deprecated use `CustomFieldCreateDtoObjectTypeOwner$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateDtoObjectTypeOwner$inboundSchema; + /** @deprecated use `CustomFieldCreateDtoObjectTypeOwner$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCreateDtoObjectTypeOwner$outboundSchema; +} + +/** @internal */ +export const CustomFieldCreateDtoDataType$inboundSchema: z.ZodNativeEnum< + typeof CustomFieldCreateDtoDataType +> = z.nativeEnum(CustomFieldCreateDtoDataType); + +/** @internal */ +export const CustomFieldCreateDtoDataType$outboundSchema: z.ZodNativeEnum< + typeof CustomFieldCreateDtoDataType +> = CustomFieldCreateDtoDataType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateDtoDataType$ { + /** @deprecated use `CustomFieldCreateDtoDataType$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateDtoDataType$inboundSchema; + /** @deprecated use `CustomFieldCreateDtoDataType$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCreateDtoDataType$outboundSchema; +} + /** @internal */ export const CustomFieldCreateDto$inboundSchema: z.ZodType< CustomFieldCreateDto, @@ -22,10 +102,10 @@ export const CustomFieldCreateDto$inboundSchema: z.ZodType< unknown > = z .object({ - object_type_owner: z.nullable(z.string()), + object_type_owner: z.nullable(CustomFieldCreateDtoObjectTypeOwner$inboundSchema), name: z.nullable(z.string()), description: z.nullable(z.string()), - data_type: z.nullable(z.string()), + data_type: z.nullable(CustomFieldCreateDtoDataType$inboundSchema), source_custom_field_id: z.nullable(z.string()), source_provider: z.nullable(z.string()), linked_user_id: z.nullable(z.string()), @@ -58,10 +138,10 @@ export const CustomFieldCreateDto$outboundSchema: z.ZodType< CustomFieldCreateDto > = z .object({ - objectTypeOwner: z.nullable(z.string()), + objectTypeOwner: z.nullable(CustomFieldCreateDtoObjectTypeOwner$outboundSchema), name: z.nullable(z.string()), description: z.nullable(z.string()), - dataType: z.nullable(z.string()), + dataType: z.nullable(CustomFieldCreateDtoDataType$outboundSchema), sourceCustomFieldId: z.nullable(z.string()), sourceProvider: z.nullable(z.string()), linkedUserId: z.nullable(z.string()), diff --git a/src/models/components/customfieldresponse.ts b/src/models/components/customfieldresponse.ts index c7d59cee..26c798fa 100644 --- a/src/models/components/customfieldresponse.ts +++ b/src/models/components/customfieldresponse.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * Attribute Data Type + */ +export enum CustomFieldResponseDataType { + String = "string", + Number = "number", +} + export type CustomFieldResponse = { /** * Attribute Id @@ -29,7 +37,7 @@ export type CustomFieldResponse = { /** * Attribute Data Type */ - dataType: string | null; + dataType: CustomFieldResponseDataType | null; /** * Attribute Remote Id */ @@ -39,11 +47,11 @@ export type CustomFieldResponse = { */ source: string | null; /** - * Attribute Id Entity + * Attribute Entity Id */ idEntity: string | null; /** - * Attribute Id Project + * Attribute Project Id */ idProject: string | null; /** @@ -51,7 +59,7 @@ export type CustomFieldResponse = { */ scope: string | null; /** - * Attribute Id Consumer + * Attribute Consumer Id */ idConsumer: string | null; /** @@ -64,6 +72,27 @@ export type CustomFieldResponse = { modifiedAt: Date | null; }; +/** @internal */ +export const CustomFieldResponseDataType$inboundSchema: z.ZodNativeEnum< + typeof CustomFieldResponseDataType +> = z.nativeEnum(CustomFieldResponseDataType); + +/** @internal */ +export const CustomFieldResponseDataType$outboundSchema: z.ZodNativeEnum< + typeof CustomFieldResponseDataType +> = CustomFieldResponseDataType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldResponseDataType$ { + /** @deprecated use `CustomFieldResponseDataType$inboundSchema` instead. */ + export const inboundSchema = CustomFieldResponseDataType$inboundSchema; + /** @deprecated use `CustomFieldResponseDataType$outboundSchema` instead. */ + export const outboundSchema = CustomFieldResponseDataType$outboundSchema; +} + /** @internal */ export const CustomFieldResponse$inboundSchema: z.ZodType< CustomFieldResponse, @@ -76,7 +105,7 @@ export const CustomFieldResponse$inboundSchema: z.ZodType< ressource_owner_type: z.nullable(z.string()), slug: z.nullable(z.string()), description: z.nullable(z.string()), - data_type: z.nullable(z.string()), + data_type: z.nullable(CustomFieldResponseDataType$inboundSchema), remote_id: z.nullable(z.string()), source: z.nullable(z.string()), id_entity: z.nullable(z.string()), @@ -140,7 +169,7 @@ export const CustomFieldResponse$outboundSchema: z.ZodType< ressourceOwnerType: z.nullable(z.string()), slug: z.nullable(z.string()), description: z.nullable(z.string()), - dataType: z.nullable(z.string()), + dataType: z.nullable(CustomFieldResponseDataType$outboundSchema), remoteId: z.nullable(z.string()), source: z.nullable(z.string()), idEntity: z.nullable(z.string()), diff --git a/src/models/components/definetargetfielddto.ts b/src/models/components/definetargetfielddto.ts index 26730c71..74705b63 100644 --- a/src/models/components/definetargetfielddto.ts +++ b/src/models/components/definetargetfielddto.ts @@ -5,13 +5,78 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +export enum ObjectTypeOwner { + Company = "company", + Contact = "contact", + Deal = "deal", + Lead = "lead", + Note = "note", + Task = "task", + Engagement = "engagement", + Stage = "stage", + User = "user", +} + +/** + * The data type of the target field + */ +export enum DataType { + String = "string", + Number = "number", +} + export type DefineTargetFieldDto = { - objectTypeOwner: string | null; + objectTypeOwner: ObjectTypeOwner | null; + /** + * The name of the target field + */ name: string | null; + /** + * The description of the target field + */ description: string | null; - dataType: string | null; + /** + * The data type of the target field + */ + dataType: DataType | null; }; +/** @internal */ +export const ObjectTypeOwner$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(ObjectTypeOwner); + +/** @internal */ +export const ObjectTypeOwner$outboundSchema: z.ZodNativeEnum = + ObjectTypeOwner$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ObjectTypeOwner$ { + /** @deprecated use `ObjectTypeOwner$inboundSchema` instead. */ + export const inboundSchema = ObjectTypeOwner$inboundSchema; + /** @deprecated use `ObjectTypeOwner$outboundSchema` instead. */ + export const outboundSchema = ObjectTypeOwner$outboundSchema; +} + +/** @internal */ +export const DataType$inboundSchema: z.ZodNativeEnum = z.nativeEnum(DataType); + +/** @internal */ +export const DataType$outboundSchema: z.ZodNativeEnum = DataType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace DataType$ { + /** @deprecated use `DataType$inboundSchema` instead. */ + export const inboundSchema = DataType$inboundSchema; + /** @deprecated use `DataType$outboundSchema` instead. */ + export const outboundSchema = DataType$outboundSchema; +} + /** @internal */ export const DefineTargetFieldDto$inboundSchema: z.ZodType< DefineTargetFieldDto, @@ -19,10 +84,10 @@ export const DefineTargetFieldDto$inboundSchema: z.ZodType< unknown > = z .object({ - object_type_owner: z.nullable(z.string()), + object_type_owner: z.nullable(ObjectTypeOwner$inboundSchema), name: z.nullable(z.string()), description: z.nullable(z.string()), - data_type: z.nullable(z.string()), + data_type: z.nullable(DataType$inboundSchema), }) .transform((v) => { return remap$(v, { @@ -46,10 +111,10 @@ export const DefineTargetFieldDto$outboundSchema: z.ZodType< DefineTargetFieldDto > = z .object({ - objectTypeOwner: z.nullable(z.string()), + objectTypeOwner: z.nullable(ObjectTypeOwner$outboundSchema), name: z.nullable(z.string()), description: z.nullable(z.string()), - dataType: z.nullable(z.string()), + dataType: z.nullable(DataType$outboundSchema), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/email.ts b/src/models/components/email.ts index 6b83980a..b14778d5 100644 --- a/src/models/components/email.ts +++ b/src/models/components/email.ts @@ -5,6 +5,22 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The email address type. Authorized values are either PERSONAL or WORK. + */ +export enum EmailAddressType { + Personal = "PERSONAL", + Work = "WORK", +} + +/** + * The owner type of an email + */ +export enum OwnerType { + Company = "COMPANY", + Contact = "CONTACT", +} + export type Email = { /** * The email address @@ -13,19 +29,55 @@ export type Email = { /** * The email address type. Authorized values are either PERSONAL or WORK. */ - emailAddressType: string | null; + emailAddressType: EmailAddressType | null; /** * The owner type of an email */ - ownerType?: string | null | undefined; + ownerType?: OwnerType | null | undefined; }; +/** @internal */ +export const EmailAddressType$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(EmailAddressType); + +/** @internal */ +export const EmailAddressType$outboundSchema: z.ZodNativeEnum = + EmailAddressType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace EmailAddressType$ { + /** @deprecated use `EmailAddressType$inboundSchema` instead. */ + export const inboundSchema = EmailAddressType$inboundSchema; + /** @deprecated use `EmailAddressType$outboundSchema` instead. */ + export const outboundSchema = EmailAddressType$outboundSchema; +} + +/** @internal */ +export const OwnerType$inboundSchema: z.ZodNativeEnum = z.nativeEnum(OwnerType); + +/** @internal */ +export const OwnerType$outboundSchema: z.ZodNativeEnum = OwnerType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OwnerType$ { + /** @deprecated use `OwnerType$inboundSchema` instead. */ + export const inboundSchema = OwnerType$inboundSchema; + /** @deprecated use `OwnerType$outboundSchema` instead. */ + export const outboundSchema = OwnerType$outboundSchema; +} + /** @internal */ export const Email$inboundSchema: z.ZodType = z .object({ email_address: z.nullable(z.string()), - email_address_type: z.nullable(z.string()), - owner_type: z.nullable(z.string()).optional(), + email_address_type: z.nullable(EmailAddressType$inboundSchema), + owner_type: z.nullable(OwnerType$inboundSchema).optional(), }) .transform((v) => { return remap$(v, { @@ -46,8 +98,8 @@ export type Email$Outbound = { export const Email$outboundSchema: z.ZodType = z .object({ emailAddress: z.nullable(z.string()), - emailAddressType: z.nullable(z.string()), - ownerType: z.nullable(z.string()).optional(), + emailAddressType: z.nullable(EmailAddressType$outboundSchema), + ownerType: z.nullable(OwnerType$outboundSchema).optional(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/index.ts b/src/models/components/index.ts index c46207aa..a8c84b1b 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -65,7 +65,6 @@ export * from "./unifiedatsrejectreasonoutput.js"; export * from "./unifiedatsscorecardoutput.js"; export * from "./unifiedatstagoutput.js"; export * from "./unifiedatsuseroutput.js"; -export * from "./unifiedcampaignoutput.js"; export * from "./unifiedcrmcompanyinput.js"; export * from "./unifiedcrmcompanyoutput.js"; export * from "./unifiedcrmcontactinput.js"; @@ -86,6 +85,7 @@ export * from "./unifiedfilestoragefileoutput.js"; export * from "./unifiedfilestoragefolderinput.js"; export * from "./unifiedfilestoragefolderoutput.js"; export * from "./unifiedfilestoragegroupoutput.js"; +export * from "./unifiedfilestorageuseroutput.js"; export * from "./unifiedhrisbankinfooutput.js"; export * from "./unifiedhrisbenefitoutput.js"; export * from "./unifiedhriscompanyoutput.js"; @@ -107,6 +107,7 @@ export * from "./unifiedmarketingautomationactionoutput.js"; export * from "./unifiedmarketingautomationautomationinput.js"; export * from "./unifiedmarketingautomationautomationoutput.js"; export * from "./unifiedmarketingautomationcampaigninput.js"; +export * from "./unifiedmarketingautomationcampaignoutput.js"; export * from "./unifiedmarketingautomationcontactinput.js"; export * from "./unifiedmarketingautomationcontactoutput.js"; export * from "./unifiedmarketingautomationemailoutput.js"; @@ -129,7 +130,6 @@ export * from "./unifiedticketingteamoutput.js"; export * from "./unifiedticketingticketinput.js"; export * from "./unifiedticketingticketoutput.js"; export * from "./unifiedticketinguseroutput.js"; -export * from "./unifieduseroutput.js"; export * from "./url.js"; export * from "./webhookdto.js"; export * from "./webhookresponse.js"; diff --git a/src/models/components/mapfieldtoproviderdto.ts b/src/models/components/mapfieldtoproviderdto.ts index 03cc43a1..b22fc397 100644 --- a/src/models/components/mapfieldtoproviderdto.ts +++ b/src/models/components/mapfieldtoproviderdto.ts @@ -7,19 +7,19 @@ import * as z from "zod"; export type MapFieldToProviderDto = { /** - * Attribute Id + * The attribute ID */ attributeId: string | null; /** - * Attribute Id + * The source custom field ID */ sourceCustomFieldId: string | null; /** - * Attribute Id + * The source provider */ sourceProvider: string | null; /** - * Attribute Id + * The linked user ID */ linkedUserId: string | null; }; diff --git a/src/models/components/passthroughrequestdto.ts b/src/models/components/passthroughrequestdto.ts index ca3736eb..9da2bbbe 100644 --- a/src/models/components/passthroughrequestdto.ts +++ b/src/models/components/passthroughrequestdto.ts @@ -17,8 +17,8 @@ export type Data = { [k: string]: any } | Array<{ [k: string]: any }>; export type PassThroughRequestDto = { method: Method; path: string | null; - data?: { [k: string]: any } | Array<{ [k: string]: any }> | null | undefined; - headers?: { [k: string]: any } | null | undefined; + data: { [k: string]: any } | Array<{ [k: string]: any }> | null; + headers: { [k: string]: any } | null; }; /** @internal */ @@ -74,16 +74,16 @@ export const PassThroughRequestDto$inboundSchema: z.ZodType< > = z.object({ method: Method$inboundSchema, path: z.nullable(z.string()), - data: z.nullable(z.union([z.record(z.any()), z.array(z.record(z.any()))])).optional(), - headers: z.nullable(z.record(z.any())).optional(), + data: z.nullable(z.union([z.record(z.any()), z.array(z.record(z.any()))])), + headers: z.nullable(z.record(z.any())), }); /** @internal */ export type PassThroughRequestDto$Outbound = { method: string; path: string | null; - data?: { [k: string]: any } | Array<{ [k: string]: any }> | null | undefined; - headers?: { [k: string]: any } | null | undefined; + data: { [k: string]: any } | Array<{ [k: string]: any }> | null; + headers: { [k: string]: any } | null; }; /** @internal */ @@ -94,8 +94,8 @@ export const PassThroughRequestDto$outboundSchema: z.ZodType< > = z.object({ method: Method$outboundSchema, path: z.nullable(z.string()), - data: z.nullable(z.union([z.record(z.any()), z.array(z.record(z.any()))])).optional(), - headers: z.nullable(z.record(z.any())).optional(), + data: z.nullable(z.union([z.record(z.any()), z.array(z.record(z.any()))])), + headers: z.nullable(z.record(z.any())), }); /** diff --git a/src/models/components/phone.ts b/src/models/components/phone.ts index 1e1186b2..b106e775 100644 --- a/src/models/components/phone.ts +++ b/src/models/components/phone.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The phone type. Authorized values are either MOBILE or WORK + */ +export enum PhoneType { + Mobile = "MOBILE", + Work = "WORK", +} + export type Phone = { /** * The phone number starting with a plus (+) followed by the country code (e.g +336676778890 for France) @@ -13,18 +21,35 @@ export type Phone = { /** * The phone type. Authorized values are either MOBILE or WORK */ - phoneType: string | null; + phoneType: PhoneType | null; /** * The owner type of a phone number */ ownerType?: string | null | undefined; }; +/** @internal */ +export const PhoneType$inboundSchema: z.ZodNativeEnum = z.nativeEnum(PhoneType); + +/** @internal */ +export const PhoneType$outboundSchema: z.ZodNativeEnum = PhoneType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace PhoneType$ { + /** @deprecated use `PhoneType$inboundSchema` instead. */ + export const inboundSchema = PhoneType$inboundSchema; + /** @deprecated use `PhoneType$outboundSchema` instead. */ + export const outboundSchema = PhoneType$outboundSchema; +} + /** @internal */ export const Phone$inboundSchema: z.ZodType = z .object({ phone_number: z.nullable(z.string()), - phone_type: z.nullable(z.string()), + phone_type: z.nullable(PhoneType$inboundSchema), owner_type: z.nullable(z.string()).optional(), }) .transform((v) => { @@ -46,7 +71,7 @@ export type Phone$Outbound = { export const Phone$outboundSchema: z.ZodType = z .object({ phoneNumber: z.nullable(z.string()), - phoneType: z.nullable(z.string()), + phoneType: z.nullable(PhoneType$outboundSchema), ownerType: z.nullable(z.string()).optional(), }) .transform((v) => { diff --git a/src/models/components/unifiedatsactivityinput.ts b/src/models/components/unifiedatsactivityinput.ts index 13eb469c..d210a94e 100644 --- a/src/models/components/unifiedatsactivityinput.ts +++ b/src/models/components/unifiedatsactivityinput.ts @@ -5,11 +5,29 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The type of activity + */ +export enum UnifiedAtsActivityInputActivityType { + Note = "NOTE", + Email = "EMAIL", + Other = "OTHER", +} + +/** + * The visibility of the activity + */ +export enum UnifiedAtsActivityInputVisibility { + AdminOnly = "ADMIN_ONLY", + Public = "PUBLIC", + Private = "PRIVATE", +} + export type UnifiedAtsActivityInput = { /** * The type of activity */ - activityType?: string | null | undefined; + activityType?: UnifiedAtsActivityInputActivityType | null | undefined; /** * The subject of the activity */ @@ -21,7 +39,7 @@ export type UnifiedAtsActivityInput = { /** * The visibility of the activity */ - visibility?: string | null | undefined; + visibility?: UnifiedAtsActivityInputVisibility | null | undefined; /** * The UUID of the candidate */ @@ -36,6 +54,48 @@ export type UnifiedAtsActivityInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedAtsActivityInputActivityType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsActivityInputActivityType +> = z.nativeEnum(UnifiedAtsActivityInputActivityType); + +/** @internal */ +export const UnifiedAtsActivityInputActivityType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsActivityInputActivityType +> = UnifiedAtsActivityInputActivityType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsActivityInputActivityType$ { + /** @deprecated use `UnifiedAtsActivityInputActivityType$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsActivityInputActivityType$inboundSchema; + /** @deprecated use `UnifiedAtsActivityInputActivityType$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsActivityInputActivityType$outboundSchema; +} + +/** @internal */ +export const UnifiedAtsActivityInputVisibility$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsActivityInputVisibility +> = z.nativeEnum(UnifiedAtsActivityInputVisibility); + +/** @internal */ +export const UnifiedAtsActivityInputVisibility$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsActivityInputVisibility +> = UnifiedAtsActivityInputVisibility$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsActivityInputVisibility$ { + /** @deprecated use `UnifiedAtsActivityInputVisibility$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsActivityInputVisibility$inboundSchema; + /** @deprecated use `UnifiedAtsActivityInputVisibility$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsActivityInputVisibility$outboundSchema; +} + /** @internal */ export const UnifiedAtsActivityInput$inboundSchema: z.ZodType< UnifiedAtsActivityInput, @@ -43,10 +103,10 @@ export const UnifiedAtsActivityInput$inboundSchema: z.ZodType< unknown > = z .object({ - activity_type: z.nullable(z.string()).optional(), + activity_type: z.nullable(UnifiedAtsActivityInputActivityType$inboundSchema).optional(), subject: z.nullable(z.string()).optional(), body: z.nullable(z.string()).optional(), - visibility: z.nullable(z.string()).optional(), + visibility: z.nullable(UnifiedAtsActivityInputVisibility$inboundSchema).optional(), candidate_id: z.nullable(z.string()).optional(), remote_created_at: z .nullable( @@ -85,10 +145,10 @@ export const UnifiedAtsActivityInput$outboundSchema: z.ZodType< UnifiedAtsActivityInput > = z .object({ - activityType: z.nullable(z.string()).optional(), + activityType: z.nullable(UnifiedAtsActivityInputActivityType$outboundSchema).optional(), subject: z.nullable(z.string()).optional(), body: z.nullable(z.string()).optional(), - visibility: z.nullable(z.string()).optional(), + visibility: z.nullable(UnifiedAtsActivityInputVisibility$outboundSchema).optional(), candidateId: z.nullable(z.string()).optional(), remoteCreatedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), fieldMappings: z.nullable(z.record(z.any())).optional(), diff --git a/src/models/components/unifiedatsactivityoutput.ts b/src/models/components/unifiedatsactivityoutput.ts index 48e52a68..388c1298 100644 --- a/src/models/components/unifiedatsactivityoutput.ts +++ b/src/models/components/unifiedatsactivityoutput.ts @@ -5,11 +5,29 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The type of activity + */ +export enum ActivityType { + Note = "NOTE", + Email = "EMAIL", + Other = "OTHER", +} + +/** + * The visibility of the activity + */ +export enum Visibility { + AdminOnly = "ADMIN_ONLY", + Public = "PUBLIC", + Private = "PRIVATE", +} + export type UnifiedAtsActivityOutput = { /** * The type of activity */ - activityType?: string | null | undefined; + activityType?: ActivityType | null | undefined; /** * The subject of the activity */ @@ -21,7 +39,7 @@ export type UnifiedAtsActivityOutput = { /** * The visibility of the activity */ - visibility?: string | null | undefined; + visibility?: Visibility | null | undefined; /** * The UUID of the candidate */ @@ -56,6 +74,44 @@ export type UnifiedAtsActivityOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const ActivityType$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(ActivityType); + +/** @internal */ +export const ActivityType$outboundSchema: z.ZodNativeEnum = + ActivityType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ActivityType$ { + /** @deprecated use `ActivityType$inboundSchema` instead. */ + export const inboundSchema = ActivityType$inboundSchema; + /** @deprecated use `ActivityType$outboundSchema` instead. */ + export const outboundSchema = ActivityType$outboundSchema; +} + +/** @internal */ +export const Visibility$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(Visibility); + +/** @internal */ +export const Visibility$outboundSchema: z.ZodNativeEnum = + Visibility$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Visibility$ { + /** @deprecated use `Visibility$inboundSchema` instead. */ + export const inboundSchema = Visibility$inboundSchema; + /** @deprecated use `Visibility$outboundSchema` instead. */ + export const outboundSchema = Visibility$outboundSchema; +} + /** @internal */ export const UnifiedAtsActivityOutput$inboundSchema: z.ZodType< UnifiedAtsActivityOutput, @@ -63,10 +119,10 @@ export const UnifiedAtsActivityOutput$inboundSchema: z.ZodType< unknown > = z .object({ - activity_type: z.nullable(z.string()).optional(), + activity_type: z.nullable(ActivityType$inboundSchema).optional(), subject: z.nullable(z.string()).optional(), body: z.nullable(z.string()).optional(), - visibility: z.nullable(z.string()).optional(), + visibility: z.nullable(Visibility$inboundSchema).optional(), candidate_id: z.nullable(z.string()).optional(), remote_created_at: z .nullable( @@ -133,10 +189,10 @@ export const UnifiedAtsActivityOutput$outboundSchema: z.ZodType< UnifiedAtsActivityOutput > = z .object({ - activityType: z.nullable(z.string()).optional(), + activityType: z.nullable(ActivityType$outboundSchema).optional(), subject: z.nullable(z.string()).optional(), body: z.nullable(z.string()).optional(), - visibility: z.nullable(z.string()).optional(), + visibility: z.nullable(Visibility$outboundSchema).optional(), candidateId: z.nullable(z.string()).optional(), remoteCreatedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), fieldMappings: z.nullable(z.record(z.any())).optional(), diff --git a/src/models/components/unifiedatsattachmentinput.ts b/src/models/components/unifiedatsattachmentinput.ts index 594d54a4..746bc8c3 100644 --- a/src/models/components/unifiedatsattachmentinput.ts +++ b/src/models/components/unifiedatsattachmentinput.ts @@ -5,6 +5,16 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The type of the file + */ +export enum UnifiedAtsAttachmentInputAttachmentType { + Resume = "RESUME", + CoverLetter = "COVER_LETTER", + OfferLetter = "OFFER_LETTER", + Other = "OTHER", +} + export type UnifiedAtsAttachmentInput = { /** * The URL of the file @@ -17,7 +27,7 @@ export type UnifiedAtsAttachmentInput = { /** * The type of the file */ - attachmentType?: string | null | undefined; + attachmentType?: UnifiedAtsAttachmentInputAttachmentType | null | undefined; /** * The remote creation date of the attachment */ @@ -36,6 +46,27 @@ export type UnifiedAtsAttachmentInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedAtsAttachmentInputAttachmentType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsAttachmentInputAttachmentType +> = z.nativeEnum(UnifiedAtsAttachmentInputAttachmentType); + +/** @internal */ +export const UnifiedAtsAttachmentInputAttachmentType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsAttachmentInputAttachmentType +> = UnifiedAtsAttachmentInputAttachmentType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsAttachmentInputAttachmentType$ { + /** @deprecated use `UnifiedAtsAttachmentInputAttachmentType$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsAttachmentInputAttachmentType$inboundSchema; + /** @deprecated use `UnifiedAtsAttachmentInputAttachmentType$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsAttachmentInputAttachmentType$outboundSchema; +} + /** @internal */ export const UnifiedAtsAttachmentInput$inboundSchema: z.ZodType< UnifiedAtsAttachmentInput, @@ -45,7 +76,9 @@ export const UnifiedAtsAttachmentInput$inboundSchema: z.ZodType< .object({ file_url: z.nullable(z.string()).optional(), file_name: z.nullable(z.string()).optional(), - attachment_type: z.nullable(z.string()).optional(), + attachment_type: z + .nullable(UnifiedAtsAttachmentInputAttachmentType$inboundSchema) + .optional(), remote_created_at: z .nullable( z @@ -97,7 +130,9 @@ export const UnifiedAtsAttachmentInput$outboundSchema: z.ZodType< .object({ fileUrl: z.nullable(z.string()).optional(), fileName: z.nullable(z.string()).optional(), - attachmentType: z.nullable(z.string()).optional(), + attachmentType: z + .nullable(UnifiedAtsAttachmentInputAttachmentType$outboundSchema) + .optional(), remoteCreatedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), remoteModifiedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), candidateId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatsattachmentoutput.ts b/src/models/components/unifiedatsattachmentoutput.ts index 2499d9af..e0303478 100644 --- a/src/models/components/unifiedatsattachmentoutput.ts +++ b/src/models/components/unifiedatsattachmentoutput.ts @@ -5,6 +5,16 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The type of the file + */ +export enum AttachmentType { + Resume = "RESUME", + CoverLetter = "COVER_LETTER", + OfferLetter = "OFFER_LETTER", + Other = "OTHER", +} + export type UnifiedAtsAttachmentOutput = { /** * The URL of the file @@ -17,7 +27,7 @@ export type UnifiedAtsAttachmentOutput = { /** * The type of the file */ - attachmentType?: string | null | undefined; + attachmentType?: AttachmentType | null | undefined; /** * The remote creation date of the attachment */ @@ -56,6 +66,25 @@ export type UnifiedAtsAttachmentOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const AttachmentType$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(AttachmentType); + +/** @internal */ +export const AttachmentType$outboundSchema: z.ZodNativeEnum = + AttachmentType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AttachmentType$ { + /** @deprecated use `AttachmentType$inboundSchema` instead. */ + export const inboundSchema = AttachmentType$inboundSchema; + /** @deprecated use `AttachmentType$outboundSchema` instead. */ + export const outboundSchema = AttachmentType$outboundSchema; +} + /** @internal */ export const UnifiedAtsAttachmentOutput$inboundSchema: z.ZodType< UnifiedAtsAttachmentOutput, @@ -65,7 +94,7 @@ export const UnifiedAtsAttachmentOutput$inboundSchema: z.ZodType< .object({ file_url: z.nullable(z.string()).optional(), file_name: z.nullable(z.string()).optional(), - attachment_type: z.nullable(z.string()).optional(), + attachment_type: z.nullable(AttachmentType$inboundSchema).optional(), remote_created_at: z .nullable( z @@ -145,7 +174,7 @@ export const UnifiedAtsAttachmentOutput$outboundSchema: z.ZodType< .object({ fileUrl: z.nullable(z.string()).optional(), fileName: z.nullable(z.string()).optional(), - attachmentType: z.nullable(z.string()).optional(), + attachmentType: z.nullable(AttachmentType$outboundSchema).optional(), remoteCreatedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), remoteModifiedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), candidateId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatseeocsoutput.ts b/src/models/components/unifiedatseeocsoutput.ts index 625117a1..07ab4ad2 100644 --- a/src/models/components/unifiedatseeocsoutput.ts +++ b/src/models/components/unifiedatseeocsoutput.ts @@ -5,6 +5,49 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The race of the candidate + */ +export enum Race { + AmericanIndianOrAlaskanNative = "AMERICAN_INDIAN_OR_ALASKAN_NATIVE", + Asian = "ASIAN", + BlackOrAfricanAmerican = "BLACK_OR_AFRICAN_AMERICAN", + HispanicOrLatino = "HISPANIC_OR_LATINO", + White = "WHITE", + NativeHawaiianOrOtherPacificIslander = "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER", + TwoOrMoreRaces = "TWO_OR_MORE_RACES", + DeclineToSelfIdentify = "DECLINE_TO_SELF_IDENTIFY", +} + +/** + * The gender of the candidate + */ +export enum Gender { + Male = "MALE", + Female = "FEMALE", + NonBinary = "NON_BINARY", + Other = "OTHER", + DeclineToSelfIdentify = "DECLINE_TO_SELF_IDENTIFY", +} + +/** + * The veteran status of the candidate + */ +export enum VeteranStatus { + IAmNotAProtectedVeteran = "I_AM_NOT_A_PROTECTED_VETERAN", + IIdentifyAsOneOrMoreOfTheClassificationsOfAProtectedVeteran = "I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN", + IDontWishToAnswer = "I_DONT_WISH_TO_ANSWER", +} + +/** + * The disability status of the candidate + */ +export enum DisabilityStatus { + YesIHaveADisabilityOrPreviouslyHadADisability = "YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY", + NoIDontHaveADisability = "NO_I_DONT_HAVE_A_DISABILITY", + IDontWishToAnswer = "I_DONT_WISH_TO_ANSWER", +} + export type UnifiedAtsEeocsOutput = { /** * The UUID of the candidate @@ -17,19 +60,19 @@ export type UnifiedAtsEeocsOutput = { /** * The race of the candidate */ - race?: string | null | undefined; + race?: Race | null | undefined; /** * The gender of the candidate */ - gender?: string | null | undefined; + gender?: Gender | null | undefined; /** * The veteran status of the candidate */ - veteranStatus?: string | null | undefined; + veteranStatus?: VeteranStatus | null | undefined; /** * The disability status of the candidate */ - disabilityStatus?: string | null | undefined; + disabilityStatus?: DisabilityStatus | null | undefined; /** * The custom field mappings of the object between the remote 3rd party & Panora */ @@ -56,6 +99,78 @@ export type UnifiedAtsEeocsOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const Race$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Race); + +/** @internal */ +export const Race$outboundSchema: z.ZodNativeEnum = Race$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Race$ { + /** @deprecated use `Race$inboundSchema` instead. */ + export const inboundSchema = Race$inboundSchema; + /** @deprecated use `Race$outboundSchema` instead. */ + export const outboundSchema = Race$outboundSchema; +} + +/** @internal */ +export const Gender$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Gender); + +/** @internal */ +export const Gender$outboundSchema: z.ZodNativeEnum = Gender$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Gender$ { + /** @deprecated use `Gender$inboundSchema` instead. */ + export const inboundSchema = Gender$inboundSchema; + /** @deprecated use `Gender$outboundSchema` instead. */ + export const outboundSchema = Gender$outboundSchema; +} + +/** @internal */ +export const VeteranStatus$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(VeteranStatus); + +/** @internal */ +export const VeteranStatus$outboundSchema: z.ZodNativeEnum = + VeteranStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace VeteranStatus$ { + /** @deprecated use `VeteranStatus$inboundSchema` instead. */ + export const inboundSchema = VeteranStatus$inboundSchema; + /** @deprecated use `VeteranStatus$outboundSchema` instead. */ + export const outboundSchema = VeteranStatus$outboundSchema; +} + +/** @internal */ +export const DisabilityStatus$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(DisabilityStatus); + +/** @internal */ +export const DisabilityStatus$outboundSchema: z.ZodNativeEnum = + DisabilityStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace DisabilityStatus$ { + /** @deprecated use `DisabilityStatus$inboundSchema` instead. */ + export const inboundSchema = DisabilityStatus$inboundSchema; + /** @deprecated use `DisabilityStatus$outboundSchema` instead. */ + export const outboundSchema = DisabilityStatus$outboundSchema; +} + /** @internal */ export const UnifiedAtsEeocsOutput$inboundSchema: z.ZodType< UnifiedAtsEeocsOutput, @@ -72,10 +187,10 @@ export const UnifiedAtsEeocsOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - race: z.nullable(z.string()).optional(), - gender: z.nullable(z.string()).optional(), - veteran_status: z.nullable(z.string()).optional(), - disability_status: z.nullable(z.string()).optional(), + race: z.nullable(Race$inboundSchema).optional(), + gender: z.nullable(Gender$inboundSchema).optional(), + veteran_status: z.nullable(VeteranStatus$inboundSchema).optional(), + disability_status: z.nullable(DisabilityStatus$inboundSchema).optional(), field_mappings: z.nullable(z.record(z.any())).optional(), id: z.nullable(z.string()).optional(), remote_id: z.nullable(z.string()).optional(), @@ -136,10 +251,10 @@ export const UnifiedAtsEeocsOutput$outboundSchema: z.ZodType< .object({ candidateId: z.nullable(z.string()).optional(), submittedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - race: z.nullable(z.string()).optional(), - gender: z.nullable(z.string()).optional(), - veteranStatus: z.nullable(z.string()).optional(), - disabilityStatus: z.nullable(z.string()).optional(), + race: z.nullable(Race$outboundSchema).optional(), + gender: z.nullable(Gender$outboundSchema).optional(), + veteranStatus: z.nullable(VeteranStatus$outboundSchema).optional(), + disabilityStatus: z.nullable(DisabilityStatus$outboundSchema).optional(), fieldMappings: z.nullable(z.record(z.any())).optional(), id: z.nullable(z.string()).optional(), remoteId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatsinterviewinput.ts b/src/models/components/unifiedatsinterviewinput.ts index 50e32a87..5b560b0c 100644 --- a/src/models/components/unifiedatsinterviewinput.ts +++ b/src/models/components/unifiedatsinterviewinput.ts @@ -5,11 +5,20 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the interview + */ +export enum UnifiedAtsInterviewInputStatus { + Scheduled = "SCHEDULED", + AwaitingFeedback = "AWAITING_FEEDBACK", + Completed = "COMPLETED", +} + export type UnifiedAtsInterviewInput = { /** * The status of the interview */ - status?: string | null | undefined; + status?: UnifiedAtsInterviewInputStatus | null | undefined; /** * The UUID of the application */ @@ -52,6 +61,27 @@ export type UnifiedAtsInterviewInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedAtsInterviewInputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsInterviewInputStatus +> = z.nativeEnum(UnifiedAtsInterviewInputStatus); + +/** @internal */ +export const UnifiedAtsInterviewInputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsInterviewInputStatus +> = UnifiedAtsInterviewInputStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsInterviewInputStatus$ { + /** @deprecated use `UnifiedAtsInterviewInputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsInterviewInputStatus$inboundSchema; + /** @deprecated use `UnifiedAtsInterviewInputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsInterviewInputStatus$outboundSchema; +} + /** @internal */ export const UnifiedAtsInterviewInput$inboundSchema: z.ZodType< UnifiedAtsInterviewInput, @@ -59,7 +89,7 @@ export const UnifiedAtsInterviewInput$inboundSchema: z.ZodType< unknown > = z .object({ - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsInterviewInputStatus$inboundSchema).optional(), application_id: z.nullable(z.string()).optional(), job_interview_stage_id: z.nullable(z.string()).optional(), organized_by: z.nullable(z.string()).optional(), @@ -134,7 +164,7 @@ export const UnifiedAtsInterviewInput$outboundSchema: z.ZodType< UnifiedAtsInterviewInput > = z .object({ - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsInterviewInputStatus$outboundSchema).optional(), applicationId: z.nullable(z.string()).optional(), jobInterviewStageId: z.nullable(z.string()).optional(), organizedBy: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatsinterviewoutput.ts b/src/models/components/unifiedatsinterviewoutput.ts index 37525962..fd118f80 100644 --- a/src/models/components/unifiedatsinterviewoutput.ts +++ b/src/models/components/unifiedatsinterviewoutput.ts @@ -5,11 +5,20 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the interview + */ +export enum UnifiedAtsInterviewOutputStatus { + Scheduled = "SCHEDULED", + AwaitingFeedback = "AWAITING_FEEDBACK", + Completed = "COMPLETED", +} + export type UnifiedAtsInterviewOutput = { /** * The status of the interview */ - status?: string | null | undefined; + status?: UnifiedAtsInterviewOutputStatus | null | undefined; /** * The UUID of the application */ @@ -72,6 +81,27 @@ export type UnifiedAtsInterviewOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const UnifiedAtsInterviewOutputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsInterviewOutputStatus +> = z.nativeEnum(UnifiedAtsInterviewOutputStatus); + +/** @internal */ +export const UnifiedAtsInterviewOutputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsInterviewOutputStatus +> = UnifiedAtsInterviewOutputStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsInterviewOutputStatus$ { + /** @deprecated use `UnifiedAtsInterviewOutputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsInterviewOutputStatus$inboundSchema; + /** @deprecated use `UnifiedAtsInterviewOutputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsInterviewOutputStatus$outboundSchema; +} + /** @internal */ export const UnifiedAtsInterviewOutput$inboundSchema: z.ZodType< UnifiedAtsInterviewOutput, @@ -79,7 +109,7 @@ export const UnifiedAtsInterviewOutput$inboundSchema: z.ZodType< unknown > = z .object({ - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsInterviewOutputStatus$inboundSchema).optional(), application_id: z.nullable(z.string()).optional(), job_interview_stage_id: z.nullable(z.string()).optional(), organized_by: z.nullable(z.string()).optional(), @@ -182,7 +212,7 @@ export const UnifiedAtsInterviewOutput$outboundSchema: z.ZodType< UnifiedAtsInterviewOutput > = z .object({ - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsInterviewOutputStatus$outboundSchema).optional(), applicationId: z.nullable(z.string()).optional(), jobInterviewStageId: z.nullable(z.string()).optional(), organizedBy: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatsjoboutput.ts b/src/models/components/unifiedatsjoboutput.ts index 6ff25d16..70c8894c 100644 --- a/src/models/components/unifiedatsjoboutput.ts +++ b/src/models/components/unifiedatsjoboutput.ts @@ -5,6 +5,26 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the job + */ +export enum UnifiedAtsJobOutputStatus { + Open = "OPEN", + Closed = "CLOSED", + Draft = "DRAFT", + Archived = "ARCHIVED", + Pending = "PENDING", +} + +/** + * The type of the job + */ +export enum UnifiedAtsJobOutputType { + Posting = "POSTING", + Requisition = "REQUISITION", + Profile = "PROFILE", +} + export type UnifiedAtsJobOutput = { /** * The name of the job @@ -21,11 +41,11 @@ export type UnifiedAtsJobOutput = { /** * The status of the job */ - status?: string | null | undefined; + status?: UnifiedAtsJobOutputStatus | null | undefined; /** * The type of the job */ - type?: string | null | undefined; + type?: UnifiedAtsJobOutputType | null | undefined; /** * Whether the job is confidential */ @@ -80,6 +100,48 @@ export type UnifiedAtsJobOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const UnifiedAtsJobOutputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsJobOutputStatus +> = z.nativeEnum(UnifiedAtsJobOutputStatus); + +/** @internal */ +export const UnifiedAtsJobOutputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsJobOutputStatus +> = UnifiedAtsJobOutputStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsJobOutputStatus$ { + /** @deprecated use `UnifiedAtsJobOutputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsJobOutputStatus$inboundSchema; + /** @deprecated use `UnifiedAtsJobOutputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsJobOutputStatus$outboundSchema; +} + +/** @internal */ +export const UnifiedAtsJobOutputType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsJobOutputType +> = z.nativeEnum(UnifiedAtsJobOutputType); + +/** @internal */ +export const UnifiedAtsJobOutputType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsJobOutputType +> = UnifiedAtsJobOutputType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsJobOutputType$ { + /** @deprecated use `UnifiedAtsJobOutputType$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsJobOutputType$inboundSchema; + /** @deprecated use `UnifiedAtsJobOutputType$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsJobOutputType$outboundSchema; +} + /** @internal */ export const UnifiedAtsJobOutput$inboundSchema: z.ZodType< UnifiedAtsJobOutput, @@ -90,8 +152,8 @@ export const UnifiedAtsJobOutput$inboundSchema: z.ZodType< name: z.nullable(z.string()).optional(), description: z.nullable(z.string()).optional(), code: z.nullable(z.string()).optional(), - status: z.nullable(z.string()).optional(), - type: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsJobOutputStatus$inboundSchema).optional(), + type: z.nullable(UnifiedAtsJobOutputType$inboundSchema).optional(), confidential: z.nullable(z.boolean()).optional(), departments: z.nullable(z.array(z.string())).optional(), offices: z.nullable(z.array(z.string())).optional(), @@ -178,8 +240,8 @@ export const UnifiedAtsJobOutput$outboundSchema: z.ZodType< name: z.nullable(z.string()).optional(), description: z.nullable(z.string()).optional(), code: z.nullable(z.string()).optional(), - status: z.nullable(z.string()).optional(), - type: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsJobOutputStatus$outboundSchema).optional(), + type: z.nullable(UnifiedAtsJobOutputType$outboundSchema).optional(), confidential: z.nullable(z.boolean()).optional(), departments: z.nullable(z.array(z.string())).optional(), offices: z.nullable(z.array(z.string())).optional(), diff --git a/src/models/components/unifiedatsofferoutput.ts b/src/models/components/unifiedatsofferoutput.ts index 17e5eab5..a1c7d6b3 100644 --- a/src/models/components/unifiedatsofferoutput.ts +++ b/src/models/components/unifiedatsofferoutput.ts @@ -5,6 +5,21 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the offer + */ +export enum UnifiedAtsOfferOutputStatus { + Draft = "DRAFT", + ApprovalSent = "APPROVAL_SENT", + Approved = "APPROVED", + Sent = "SENT", + SentManually = "SENT_MANUALLY", + Opened = "OPENED", + Denied = "DENIED", + Signed = "SIGNED", + Deprecated = "DEPRECATED", +} + /** * The created date of the object */ @@ -39,7 +54,7 @@ export type UnifiedAtsOfferOutput = { /** * The status of the offer */ - status?: string | null | undefined; + status?: UnifiedAtsOfferOutputStatus | null | undefined; /** * The UUID of the application */ @@ -70,6 +85,27 @@ export type UnifiedAtsOfferOutput = { modifiedAt?: UnifiedAtsOfferOutputModifiedAt | null | undefined; }; +/** @internal */ +export const UnifiedAtsOfferOutputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsOfferOutputStatus +> = z.nativeEnum(UnifiedAtsOfferOutputStatus); + +/** @internal */ +export const UnifiedAtsOfferOutputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedAtsOfferOutputStatus +> = UnifiedAtsOfferOutputStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedAtsOfferOutputStatus$ { + /** @deprecated use `UnifiedAtsOfferOutputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedAtsOfferOutputStatus$inboundSchema; + /** @deprecated use `UnifiedAtsOfferOutputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedAtsOfferOutputStatus$outboundSchema; +} + /** @internal */ export const UnifiedAtsOfferOutputCreatedAt$inboundSchema: z.ZodType< UnifiedAtsOfferOutputCreatedAt, @@ -170,7 +206,7 @@ export const UnifiedAtsOfferOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsOfferOutputStatus$inboundSchema).optional(), application_id: z.nullable(z.string()).optional(), field_mappings: z.nullable(z.record(z.any())).optional(), id: z.nullable(z.string()).optional(), @@ -228,7 +264,7 @@ export const UnifiedAtsOfferOutput$outboundSchema: z.ZodType< closedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), sentAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), startDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedAtsOfferOutputStatus$outboundSchema).optional(), applicationId: z.nullable(z.string()).optional(), fieldMappings: z.nullable(z.record(z.any())).optional(), id: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatsscorecardoutput.ts b/src/models/components/unifiedatsscorecardoutput.ts index 13db59b3..6a94492c 100644 --- a/src/models/components/unifiedatsscorecardoutput.ts +++ b/src/models/components/unifiedatsscorecardoutput.ts @@ -5,11 +5,22 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The overall recommendation + */ +export enum OverallRecommendation { + DefinitelyNo = "DEFINITELY_NO", + No = "NO", + Yes = "YES", + StrongYes = "STRONG_YES", + NoDecision = "NO_DECISION", +} + export type UnifiedAtsScorecardOutput = { /** * The overall recommendation */ - overallRecommendation?: string | null | undefined; + overallRecommendation?: OverallRecommendation | null | undefined; /** * The UUID of the application */ @@ -21,11 +32,11 @@ export type UnifiedAtsScorecardOutput = { /** * The remote creation date of the scorecard */ - remoteCreatedAt?: string | null | undefined; + remoteCreatedAt?: Date | null | undefined; /** * The submission date of the scorecard */ - submittedAt?: string | null | undefined; + submittedAt?: Date | null | undefined; /** * The custom field mappings of the object between the remote 3rd party & Panora */ @@ -52,6 +63,25 @@ export type UnifiedAtsScorecardOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const OverallRecommendation$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(OverallRecommendation); + +/** @internal */ +export const OverallRecommendation$outboundSchema: z.ZodNativeEnum = + OverallRecommendation$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OverallRecommendation$ { + /** @deprecated use `OverallRecommendation$inboundSchema` instead. */ + export const inboundSchema = OverallRecommendation$inboundSchema; + /** @deprecated use `OverallRecommendation$outboundSchema` instead. */ + export const outboundSchema = OverallRecommendation$outboundSchema; +} + /** @internal */ export const UnifiedAtsScorecardOutput$inboundSchema: z.ZodType< UnifiedAtsScorecardOutput, @@ -59,11 +89,25 @@ export const UnifiedAtsScorecardOutput$inboundSchema: z.ZodType< unknown > = z .object({ - overall_recommendation: z.nullable(z.string()).optional(), + overall_recommendation: z.nullable(OverallRecommendation$inboundSchema).optional(), application_id: z.nullable(z.string()).optional(), interview_id: z.nullable(z.string()).optional(), - remote_created_at: z.nullable(z.string()).optional(), - submitted_at: z.nullable(z.string()).optional(), + remote_created_at: z + .nullable( + z + .string() + .datetime({ offset: true }) + .transform((v) => new Date(v)) + ) + .optional(), + submitted_at: z + .nullable( + z + .string() + .datetime({ offset: true }) + .transform((v) => new Date(v)) + ) + .optional(), field_mappings: z.nullable(z.record(z.any())).optional(), id: z.string().optional(), remote_id: z.nullable(z.string()).optional(), @@ -122,11 +166,11 @@ export const UnifiedAtsScorecardOutput$outboundSchema: z.ZodType< UnifiedAtsScorecardOutput > = z .object({ - overallRecommendation: z.nullable(z.string()).optional(), + overallRecommendation: z.nullable(OverallRecommendation$outboundSchema).optional(), applicationId: z.nullable(z.string()).optional(), interviewId: z.nullable(z.string()).optional(), - remoteCreatedAt: z.nullable(z.string()).optional(), - submittedAt: z.nullable(z.string()).optional(), + remoteCreatedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), + submittedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), fieldMappings: z.nullable(z.record(z.any())).optional(), id: z.string().optional(), remoteId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedatsuseroutput.ts b/src/models/components/unifiedatsuseroutput.ts index 8fe6895e..ba623102 100644 --- a/src/models/components/unifiedatsuseroutput.ts +++ b/src/models/components/unifiedatsuseroutput.ts @@ -5,6 +5,17 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The access role of the user + */ +export enum AccessRole { + SuperAdmin = "SUPER_ADMIN", + Admin = "ADMIN", + TeamMember = "TEAM_MEMBER", + LimitedTeamMember = "LIMITED_TEAM_MEMBER", + Interviewer = "INTERVIEWER", +} + export type UnifiedAtsUserOutput = { /** * The first name of the user @@ -25,7 +36,7 @@ export type UnifiedAtsUserOutput = { /** * The access role of the user */ - accessRole?: string | null | undefined; + accessRole?: AccessRole | null | undefined; /** * The remote creation date of the user */ @@ -60,6 +71,25 @@ export type UnifiedAtsUserOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const AccessRole$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(AccessRole); + +/** @internal */ +export const AccessRole$outboundSchema: z.ZodNativeEnum = + AccessRole$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AccessRole$ { + /** @deprecated use `AccessRole$inboundSchema` instead. */ + export const inboundSchema = AccessRole$inboundSchema; + /** @deprecated use `AccessRole$outboundSchema` instead. */ + export const outboundSchema = AccessRole$outboundSchema; +} + /** @internal */ export const UnifiedAtsUserOutput$inboundSchema: z.ZodType< UnifiedAtsUserOutput, @@ -71,7 +101,7 @@ export const UnifiedAtsUserOutput$inboundSchema: z.ZodType< last_name: z.nullable(z.string()).optional(), email: z.nullable(z.string()).optional(), disabled: z.nullable(z.boolean()).optional(), - access_role: z.nullable(z.string()).optional(), + access_role: z.nullable(AccessRole$inboundSchema).optional(), remote_created_at: z .nullable( z @@ -152,7 +182,7 @@ export const UnifiedAtsUserOutput$outboundSchema: z.ZodType< lastName: z.nullable(z.string()).optional(), email: z.nullable(z.string()).optional(), disabled: z.nullable(z.boolean()).optional(), - accessRole: z.nullable(z.string()).optional(), + accessRole: z.nullable(AccessRole$outboundSchema).optional(), remoteCreatedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), remoteModifiedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), fieldMappings: z.nullable(z.record(z.any())).optional(), diff --git a/src/models/components/unifiedcampaignoutput.ts b/src/models/components/unifiedcampaignoutput.ts deleted file mode 100644 index d833f3e8..00000000 --- a/src/models/components/unifiedcampaignoutput.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; - -export type UnifiedCampaignOutput = {}; - -/** @internal */ -export const UnifiedCampaignOutput$inboundSchema: z.ZodType< - UnifiedCampaignOutput, - z.ZodTypeDef, - unknown -> = z.object({}); - -/** @internal */ -export type UnifiedCampaignOutput$Outbound = {}; - -/** @internal */ -export const UnifiedCampaignOutput$outboundSchema: z.ZodType< - UnifiedCampaignOutput$Outbound, - z.ZodTypeDef, - UnifiedCampaignOutput -> = z.object({}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UnifiedCampaignOutput$ { - /** @deprecated use `UnifiedCampaignOutput$inboundSchema` instead. */ - export const inboundSchema = UnifiedCampaignOutput$inboundSchema; - /** @deprecated use `UnifiedCampaignOutput$outboundSchema` instead. */ - export const outboundSchema = UnifiedCampaignOutput$outboundSchema; - /** @deprecated use `UnifiedCampaignOutput$Outbound` instead. */ - export type Outbound = UnifiedCampaignOutput$Outbound; -} diff --git a/src/models/components/unifiedcrmcompanyinput.ts b/src/models/components/unifiedcrmcompanyinput.ts index 4680936c..bd44ee05 100644 --- a/src/models/components/unifiedcrmcompanyinput.ts +++ b/src/models/components/unifiedcrmcompanyinput.ts @@ -13,6 +13,159 @@ import { Email, Email$inboundSchema, Email$Outbound, Email$outboundSchema } from import { Phone, Phone$inboundSchema, Phone$Outbound, Phone$outboundSchema } from "./phone.js"; import * as z from "zod"; +/** + * The industry of the company. Authorized values can be found in the Industry enum. + */ +export enum UnifiedCrmCompanyInputIndustry { + Accounting = "ACCOUNTING", + AirlinesAviation = "AIRLINES_AVIATION", + AlternativeDisputeResolution = "ALTERNATIVE_DISPUTE_RESOLUTION", + AlternativeMedicine = "ALTERNATIVE_MEDICINE", + Animation = "ANIMATION", + ApparelFashion = "APPAREL_FASHION", + ArchitecturePlanning = "ARCHITECTURE_PLANNING", + ArtsAndCrafts = "ARTS_AND_CRAFTS", + Automotive = "AUTOMOTIVE", + AviationAerospace = "AVIATION_AEROSPACE", + Banking = "BANKING", + Biotechnology = "BIOTECHNOLOGY", + BroadcastMedia = "BROADCAST_MEDIA", + BuildingMaterials = "BUILDING_MATERIALS", + BusinessSuppliesAndEquipment = "BUSINESS_SUPPLIES_AND_EQUIPMENT", + CapitalMarkets = "CAPITAL_MARKETS", + Chemicals = "CHEMICALS", + CivicSocialOrganization = "CIVIC_SOCIAL_ORGANIZATION", + CivilEngineering = "CIVIL_ENGINEERING", + CommercialRealEstate = "COMMERCIAL_REAL_ESTATE", + ComputerNetworkSecurity = "COMPUTER_NETWORK_SECURITY", + ComputerGames = "COMPUTER_GAMES", + ComputerHardware = "COMPUTER_HARDWARE", + ComputerNetworking = "COMPUTER_NETWORKING", + ComputerSoftware = "COMPUTER_SOFTWARE", + Internet = "INTERNET", + Construction = "CONSTRUCTION", + ConsumerElectronics = "CONSUMER_ELECTRONICS", + ConsumerGoods = "CONSUMER_GOODS", + ConsumerServices = "CONSUMER_SERVICES", + Cosmetics = "COSMETICS", + Dairy = "DAIRY", + DefenseSpace = "DEFENSE_SPACE", + Design = "DESIGN", + EducationManagement = "EDUCATION_MANAGEMENT", + ELearning = "E_LEARNING", + ElectricalElectronicManufacturing = "ELECTRICAL_ELECTRONIC_MANUFACTURING", + Entertainment = "ENTERTAINMENT", + EnvironmentalServices = "ENVIRONMENTAL_SERVICES", + EventsServices = "EVENTS_SERVICES", + ExecutiveOffice = "EXECUTIVE_OFFICE", + FacilitiesServices = "FACILITIES_SERVICES", + Farming = "FARMING", + FinancialServices = "FINANCIAL_SERVICES", + FineArt = "FINE_ART", + Fishery = "FISHERY", + FoodBeverages = "FOOD_BEVERAGES", + FoodProduction = "FOOD_PRODUCTION", + FundRaising = "FUND_RAISING", + Furniture = "FURNITURE", + GamblingCasinos = "GAMBLING_CASINOS", + GlassCeramicsConcrete = "GLASS_CERAMICS_CONCRETE", + GovernmentAdministration = "GOVERNMENT_ADMINISTRATION", + GovernmentRelations = "GOVERNMENT_RELATIONS", + GraphicDesign = "GRAPHIC_DESIGN", + HealthWellnessAndFitness = "HEALTH_WELLNESS_AND_FITNESS", + HigherEducation = "HIGHER_EDUCATION", + HospitalHealthCare = "HOSPITAL_HEALTH_CARE", + Hospitality = "HOSPITALITY", + HumanResources = "HUMAN_RESOURCES", + ImportAndExport = "IMPORT_AND_EXPORT", + IndividualFamilyServices = "INDIVIDUAL_FAMILY_SERVICES", + IndustrialAutomation = "INDUSTRIAL_AUTOMATION", + InformationServices = "INFORMATION_SERVICES", + InformationTechnologyAndServices = "INFORMATION_TECHNOLOGY_AND_SERVICES", + Insurance = "INSURANCE", + InternationalAffairs = "INTERNATIONAL_AFFAIRS", + InternationalTradeAndDevelopment = "INTERNATIONAL_TRADE_AND_DEVELOPMENT", + InvestmentBanking = "INVESTMENT_BANKING", + InvestmentManagement = "INVESTMENT_MANAGEMENT", + Judiciary = "JUDICIARY", + LawEnforcement = "LAW_ENFORCEMENT", + LawPractice = "LAW_PRACTICE", + LegalServices = "LEGAL_SERVICES", + LegislativeOffice = "LEGISLATIVE_OFFICE", + LeisureTravelTourism = "LEISURE_TRAVEL_TOURISM", + Libraries = "LIBRARIES", + LogisticsAndSupplyChain = "LOGISTICS_AND_SUPPLY_CHAIN", + LuxuryGoodsJewelry = "LUXURY_GOODS_JEWELRY", + Machinery = "MACHINERY", + ManagementConsulting = "MANAGEMENT_CONSULTING", + Maritime = "MARITIME", + MarketResearch = "MARKET_RESEARCH", + MarketingAndAdvertising = "MARKETING_AND_ADVERTISING", + MechanicalOrIndustrialEngineering = "MECHANICAL_OR_INDUSTRIAL_ENGINEERING", + MediaProduction = "MEDIA_PRODUCTION", + MedicalDevices = "MEDICAL_DEVICES", + MedicalPractice = "MEDICAL_PRACTICE", + MentalHealthCare = "MENTAL_HEALTH_CARE", + Military = "MILITARY", + MiningMetals = "MINING_METALS", + MotionPicturesAndFilm = "MOTION_PICTURES_AND_FILM", + MuseumsAndInstitutions = "MUSEUMS_AND_INSTITUTIONS", + Music = "MUSIC", + Nanotechnology = "NANOTECHNOLOGY", + Newspapers = "NEWSPAPERS", + NonProfitOrganizationManagement = "NON_PROFIT_ORGANIZATION_MANAGEMENT", + OilEnergy = "OIL_ENERGY", + OnlineMedia = "ONLINE_MEDIA", + OutsourcingOffshoring = "OUTSOURCING_OFFSHORING", + PackageFreightDelivery = "PACKAGE_FREIGHT_DELIVERY", + PackagingAndContainers = "PACKAGING_AND_CONTAINERS", + PaperForestProducts = "PAPER_FOREST_PRODUCTS", + PerformingArts = "PERFORMING_ARTS", + Pharmaceuticals = "PHARMACEUTICALS", + Philanthropy = "PHILANTHROPY", + Photography = "PHOTOGRAPHY", + Plastics = "PLASTICS", + PoliticalOrganization = "POLITICAL_ORGANIZATION", + PrimarySecondaryEducation = "PRIMARY_SECONDARY_EDUCATION", + Printing = "PRINTING", + ProfessionalTrainingCoaching = "PROFESSIONAL_TRAINING_COACHING", + ProgramDevelopment = "PROGRAM_DEVELOPMENT", + PublicPolicy = "PUBLIC_POLICY", + PublicRelationsAndCommunications = "PUBLIC_RELATIONS_AND_COMMUNICATIONS", + PublicSafety = "PUBLIC_SAFETY", + Publishing = "PUBLISHING", + RailroadManufacture = "RAILROAD_MANUFACTURE", + Ranching = "RANCHING", + RealEstate = "REAL_ESTATE", + RecreationalFacilitiesAndServices = "RECREATIONAL_FACILITIES_AND_SERVICES", + ReligiousInstitutions = "RELIGIOUS_INSTITUTIONS", + RenewablesEnvironment = "RENEWABLES_ENVIRONMENT", + Research = "RESEARCH", + Restaurants = "RESTAURANTS", + Retail = "RETAIL", + SecurityAndInvestigations = "SECURITY_AND_INVESTIGATIONS", + Semiconductors = "SEMICONDUCTORS", + Shipbuilding = "SHIPBUILDING", + SportingGoods = "SPORTING_GOODS", + Sports = "SPORTS", + StaffingAndRecruiting = "STAFFING_AND_RECRUITING", + Supermarkets = "SUPERMARKETS", + Telecommunications = "TELECOMMUNICATIONS", + Textiles = "TEXTILES", + ThinkTanks = "THINK_TANKS", + Tobacco = "TOBACCO", + TranslationAndLocalization = "TRANSLATION_AND_LOCALIZATION", + TransportationTruckingRailroad = "TRANSPORTATION_TRUCKING_RAILROAD", + Utilities = "UTILITIES", + VentureCapitalPrivateEquity = "VENTURE_CAPITAL_PRIVATE_EQUITY", + Veterinary = "VETERINARY", + Warehousing = "WAREHOUSING", + Wholesale = "WHOLESALE", + WineAndSpirits = "WINE_AND_SPIRITS", + Wireless = "WIRELESS", + WritingAndEditing = "WRITING_AND_EDITING", +} + export type UnifiedCrmCompanyInput = { /** * The name of the company @@ -21,7 +174,7 @@ export type UnifiedCrmCompanyInput = { /** * The industry of the company. Authorized values can be found in the Industry enum. */ - industry?: string | null | undefined; + industry?: UnifiedCrmCompanyInputIndustry | null | undefined; /** * The number of employees of the company */ @@ -48,6 +201,27 @@ export type UnifiedCrmCompanyInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedCrmCompanyInputIndustry$inboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmCompanyInputIndustry +> = z.nativeEnum(UnifiedCrmCompanyInputIndustry); + +/** @internal */ +export const UnifiedCrmCompanyInputIndustry$outboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmCompanyInputIndustry +> = UnifiedCrmCompanyInputIndustry$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedCrmCompanyInputIndustry$ { + /** @deprecated use `UnifiedCrmCompanyInputIndustry$inboundSchema` instead. */ + export const inboundSchema = UnifiedCrmCompanyInputIndustry$inboundSchema; + /** @deprecated use `UnifiedCrmCompanyInputIndustry$outboundSchema` instead. */ + export const outboundSchema = UnifiedCrmCompanyInputIndustry$outboundSchema; +} + /** @internal */ export const UnifiedCrmCompanyInput$inboundSchema: z.ZodType< UnifiedCrmCompanyInput, @@ -56,7 +230,7 @@ export const UnifiedCrmCompanyInput$inboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - industry: z.nullable(z.string()).optional(), + industry: z.nullable(UnifiedCrmCompanyInputIndustry$inboundSchema).optional(), number_of_employees: z.nullable(z.number()).optional(), user_id: z.nullable(z.string()).optional(), email_addresses: z.nullable(z.array(Email$inboundSchema)).optional(), @@ -94,7 +268,7 @@ export const UnifiedCrmCompanyInput$outboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - industry: z.nullable(z.string()).optional(), + industry: z.nullable(UnifiedCrmCompanyInputIndustry$outboundSchema).optional(), numberOfEmployees: z.nullable(z.number()).optional(), userId: z.nullable(z.string()).optional(), emailAddresses: z.nullable(z.array(Email$outboundSchema)).optional(), diff --git a/src/models/components/unifiedcrmcompanyoutput.ts b/src/models/components/unifiedcrmcompanyoutput.ts index 85457ef0..6e2f54f3 100644 --- a/src/models/components/unifiedcrmcompanyoutput.ts +++ b/src/models/components/unifiedcrmcompanyoutput.ts @@ -13,6 +13,159 @@ import { Email, Email$inboundSchema, Email$Outbound, Email$outboundSchema } from import { Phone, Phone$inboundSchema, Phone$Outbound, Phone$outboundSchema } from "./phone.js"; import * as z from "zod"; +/** + * The industry of the company. Authorized values can be found in the Industry enum. + */ +export enum Industry { + Accounting = "ACCOUNTING", + AirlinesAviation = "AIRLINES_AVIATION", + AlternativeDisputeResolution = "ALTERNATIVE_DISPUTE_RESOLUTION", + AlternativeMedicine = "ALTERNATIVE_MEDICINE", + Animation = "ANIMATION", + ApparelFashion = "APPAREL_FASHION", + ArchitecturePlanning = "ARCHITECTURE_PLANNING", + ArtsAndCrafts = "ARTS_AND_CRAFTS", + Automotive = "AUTOMOTIVE", + AviationAerospace = "AVIATION_AEROSPACE", + Banking = "BANKING", + Biotechnology = "BIOTECHNOLOGY", + BroadcastMedia = "BROADCAST_MEDIA", + BuildingMaterials = "BUILDING_MATERIALS", + BusinessSuppliesAndEquipment = "BUSINESS_SUPPLIES_AND_EQUIPMENT", + CapitalMarkets = "CAPITAL_MARKETS", + Chemicals = "CHEMICALS", + CivicSocialOrganization = "CIVIC_SOCIAL_ORGANIZATION", + CivilEngineering = "CIVIL_ENGINEERING", + CommercialRealEstate = "COMMERCIAL_REAL_ESTATE", + ComputerNetworkSecurity = "COMPUTER_NETWORK_SECURITY", + ComputerGames = "COMPUTER_GAMES", + ComputerHardware = "COMPUTER_HARDWARE", + ComputerNetworking = "COMPUTER_NETWORKING", + ComputerSoftware = "COMPUTER_SOFTWARE", + Internet = "INTERNET", + Construction = "CONSTRUCTION", + ConsumerElectronics = "CONSUMER_ELECTRONICS", + ConsumerGoods = "CONSUMER_GOODS", + ConsumerServices = "CONSUMER_SERVICES", + Cosmetics = "COSMETICS", + Dairy = "DAIRY", + DefenseSpace = "DEFENSE_SPACE", + Design = "DESIGN", + EducationManagement = "EDUCATION_MANAGEMENT", + ELearning = "E_LEARNING", + ElectricalElectronicManufacturing = "ELECTRICAL_ELECTRONIC_MANUFACTURING", + Entertainment = "ENTERTAINMENT", + EnvironmentalServices = "ENVIRONMENTAL_SERVICES", + EventsServices = "EVENTS_SERVICES", + ExecutiveOffice = "EXECUTIVE_OFFICE", + FacilitiesServices = "FACILITIES_SERVICES", + Farming = "FARMING", + FinancialServices = "FINANCIAL_SERVICES", + FineArt = "FINE_ART", + Fishery = "FISHERY", + FoodBeverages = "FOOD_BEVERAGES", + FoodProduction = "FOOD_PRODUCTION", + FundRaising = "FUND_RAISING", + Furniture = "FURNITURE", + GamblingCasinos = "GAMBLING_CASINOS", + GlassCeramicsConcrete = "GLASS_CERAMICS_CONCRETE", + GovernmentAdministration = "GOVERNMENT_ADMINISTRATION", + GovernmentRelations = "GOVERNMENT_RELATIONS", + GraphicDesign = "GRAPHIC_DESIGN", + HealthWellnessAndFitness = "HEALTH_WELLNESS_AND_FITNESS", + HigherEducation = "HIGHER_EDUCATION", + HospitalHealthCare = "HOSPITAL_HEALTH_CARE", + Hospitality = "HOSPITALITY", + HumanResources = "HUMAN_RESOURCES", + ImportAndExport = "IMPORT_AND_EXPORT", + IndividualFamilyServices = "INDIVIDUAL_FAMILY_SERVICES", + IndustrialAutomation = "INDUSTRIAL_AUTOMATION", + InformationServices = "INFORMATION_SERVICES", + InformationTechnologyAndServices = "INFORMATION_TECHNOLOGY_AND_SERVICES", + Insurance = "INSURANCE", + InternationalAffairs = "INTERNATIONAL_AFFAIRS", + InternationalTradeAndDevelopment = "INTERNATIONAL_TRADE_AND_DEVELOPMENT", + InvestmentBanking = "INVESTMENT_BANKING", + InvestmentManagement = "INVESTMENT_MANAGEMENT", + Judiciary = "JUDICIARY", + LawEnforcement = "LAW_ENFORCEMENT", + LawPractice = "LAW_PRACTICE", + LegalServices = "LEGAL_SERVICES", + LegislativeOffice = "LEGISLATIVE_OFFICE", + LeisureTravelTourism = "LEISURE_TRAVEL_TOURISM", + Libraries = "LIBRARIES", + LogisticsAndSupplyChain = "LOGISTICS_AND_SUPPLY_CHAIN", + LuxuryGoodsJewelry = "LUXURY_GOODS_JEWELRY", + Machinery = "MACHINERY", + ManagementConsulting = "MANAGEMENT_CONSULTING", + Maritime = "MARITIME", + MarketResearch = "MARKET_RESEARCH", + MarketingAndAdvertising = "MARKETING_AND_ADVERTISING", + MechanicalOrIndustrialEngineering = "MECHANICAL_OR_INDUSTRIAL_ENGINEERING", + MediaProduction = "MEDIA_PRODUCTION", + MedicalDevices = "MEDICAL_DEVICES", + MedicalPractice = "MEDICAL_PRACTICE", + MentalHealthCare = "MENTAL_HEALTH_CARE", + Military = "MILITARY", + MiningMetals = "MINING_METALS", + MotionPicturesAndFilm = "MOTION_PICTURES_AND_FILM", + MuseumsAndInstitutions = "MUSEUMS_AND_INSTITUTIONS", + Music = "MUSIC", + Nanotechnology = "NANOTECHNOLOGY", + Newspapers = "NEWSPAPERS", + NonProfitOrganizationManagement = "NON_PROFIT_ORGANIZATION_MANAGEMENT", + OilEnergy = "OIL_ENERGY", + OnlineMedia = "ONLINE_MEDIA", + OutsourcingOffshoring = "OUTSOURCING_OFFSHORING", + PackageFreightDelivery = "PACKAGE_FREIGHT_DELIVERY", + PackagingAndContainers = "PACKAGING_AND_CONTAINERS", + PaperForestProducts = "PAPER_FOREST_PRODUCTS", + PerformingArts = "PERFORMING_ARTS", + Pharmaceuticals = "PHARMACEUTICALS", + Philanthropy = "PHILANTHROPY", + Photography = "PHOTOGRAPHY", + Plastics = "PLASTICS", + PoliticalOrganization = "POLITICAL_ORGANIZATION", + PrimarySecondaryEducation = "PRIMARY_SECONDARY_EDUCATION", + Printing = "PRINTING", + ProfessionalTrainingCoaching = "PROFESSIONAL_TRAINING_COACHING", + ProgramDevelopment = "PROGRAM_DEVELOPMENT", + PublicPolicy = "PUBLIC_POLICY", + PublicRelationsAndCommunications = "PUBLIC_RELATIONS_AND_COMMUNICATIONS", + PublicSafety = "PUBLIC_SAFETY", + Publishing = "PUBLISHING", + RailroadManufacture = "RAILROAD_MANUFACTURE", + Ranching = "RANCHING", + RealEstate = "REAL_ESTATE", + RecreationalFacilitiesAndServices = "RECREATIONAL_FACILITIES_AND_SERVICES", + ReligiousInstitutions = "RELIGIOUS_INSTITUTIONS", + RenewablesEnvironment = "RENEWABLES_ENVIRONMENT", + Research = "RESEARCH", + Restaurants = "RESTAURANTS", + Retail = "RETAIL", + SecurityAndInvestigations = "SECURITY_AND_INVESTIGATIONS", + Semiconductors = "SEMICONDUCTORS", + Shipbuilding = "SHIPBUILDING", + SportingGoods = "SPORTING_GOODS", + Sports = "SPORTS", + StaffingAndRecruiting = "STAFFING_AND_RECRUITING", + Supermarkets = "SUPERMARKETS", + Telecommunications = "TELECOMMUNICATIONS", + Textiles = "TEXTILES", + ThinkTanks = "THINK_TANKS", + Tobacco = "TOBACCO", + TranslationAndLocalization = "TRANSLATION_AND_LOCALIZATION", + TransportationTruckingRailroad = "TRANSPORTATION_TRUCKING_RAILROAD", + Utilities = "UTILITIES", + VentureCapitalPrivateEquity = "VENTURE_CAPITAL_PRIVATE_EQUITY", + Veterinary = "VETERINARY", + Warehousing = "WAREHOUSING", + Wholesale = "WHOLESALE", + WineAndSpirits = "WINE_AND_SPIRITS", + Wireless = "WIRELESS", + WritingAndEditing = "WRITING_AND_EDITING", +} + /** * The created date of the object */ @@ -31,7 +184,7 @@ export type UnifiedCrmCompanyOutput = { /** * The industry of the company. Authorized values can be found in the Industry enum. */ - industry?: string | null | undefined; + industry?: Industry | null | undefined; /** * The number of employees of the company */ @@ -78,6 +231,23 @@ export type UnifiedCrmCompanyOutput = { modifiedAt?: ModifiedAt | null | undefined; }; +/** @internal */ +export const Industry$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Industry); + +/** @internal */ +export const Industry$outboundSchema: z.ZodNativeEnum = Industry$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Industry$ { + /** @deprecated use `Industry$inboundSchema` instead. */ + export const inboundSchema = Industry$inboundSchema; + /** @deprecated use `Industry$outboundSchema` instead. */ + export const outboundSchema = Industry$outboundSchema; +} + /** @internal */ export const CreatedAt$inboundSchema: z.ZodType = z.object({}); @@ -132,7 +302,7 @@ export const UnifiedCrmCompanyOutput$inboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - industry: z.nullable(z.string()).optional(), + industry: z.nullable(Industry$inboundSchema).optional(), number_of_employees: z.nullable(z.number()).optional(), user_id: z.nullable(z.string()).optional(), email_addresses: z.nullable(z.array(Email$inboundSchema)).optional(), @@ -184,7 +354,7 @@ export const UnifiedCrmCompanyOutput$outboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - industry: z.nullable(z.string()).optional(), + industry: z.nullable(Industry$outboundSchema).optional(), numberOfEmployees: z.nullable(z.number()).optional(), userId: z.nullable(z.string()).optional(), emailAddresses: z.nullable(z.array(Email$outboundSchema)).optional(), diff --git a/src/models/components/unifiedcrmengagementinput.ts b/src/models/components/unifiedcrmengagementinput.ts index 50dfadd7..4b0c3c66 100644 --- a/src/models/components/unifiedcrmengagementinput.ts +++ b/src/models/components/unifiedcrmengagementinput.ts @@ -5,6 +5,23 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The direction of the engagement. Authorized values are INBOUND or OUTBOUND + */ +export enum UnifiedCrmEngagementInputDirection { + Inbound = "INBOUND", + Outbound = "OUTBOUND", +} + +/** + * The type of the engagement. Authorized values are EMAIL, CALL or MEETING + */ +export enum UnifiedCrmEngagementInputType { + Email = "EMAIL", + Call = "CALL", + Meeting = "MEETING", +} + export type UnifiedCrmEngagementInput = { /** * The content of the engagement @@ -13,7 +30,7 @@ export type UnifiedCrmEngagementInput = { /** * The direction of the engagement. Authorized values are INBOUND or OUTBOUND */ - direction?: string | null | undefined; + direction?: UnifiedCrmEngagementInputDirection | null | undefined; /** * The subject of the engagement */ @@ -29,7 +46,7 @@ export type UnifiedCrmEngagementInput = { /** * The type of the engagement. Authorized values are EMAIL, CALL or MEETING */ - type: string | null; + type: UnifiedCrmEngagementInputType | null; /** * The UUID of the user tied to the engagement */ @@ -48,6 +65,48 @@ export type UnifiedCrmEngagementInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedCrmEngagementInputDirection$inboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmEngagementInputDirection +> = z.nativeEnum(UnifiedCrmEngagementInputDirection); + +/** @internal */ +export const UnifiedCrmEngagementInputDirection$outboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmEngagementInputDirection +> = UnifiedCrmEngagementInputDirection$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedCrmEngagementInputDirection$ { + /** @deprecated use `UnifiedCrmEngagementInputDirection$inboundSchema` instead. */ + export const inboundSchema = UnifiedCrmEngagementInputDirection$inboundSchema; + /** @deprecated use `UnifiedCrmEngagementInputDirection$outboundSchema` instead. */ + export const outboundSchema = UnifiedCrmEngagementInputDirection$outboundSchema; +} + +/** @internal */ +export const UnifiedCrmEngagementInputType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmEngagementInputType +> = z.nativeEnum(UnifiedCrmEngagementInputType); + +/** @internal */ +export const UnifiedCrmEngagementInputType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmEngagementInputType +> = UnifiedCrmEngagementInputType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedCrmEngagementInputType$ { + /** @deprecated use `UnifiedCrmEngagementInputType$inboundSchema` instead. */ + export const inboundSchema = UnifiedCrmEngagementInputType$inboundSchema; + /** @deprecated use `UnifiedCrmEngagementInputType$outboundSchema` instead. */ + export const outboundSchema = UnifiedCrmEngagementInputType$outboundSchema; +} + /** @internal */ export const UnifiedCrmEngagementInput$inboundSchema: z.ZodType< UnifiedCrmEngagementInput, @@ -56,7 +115,7 @@ export const UnifiedCrmEngagementInput$inboundSchema: z.ZodType< > = z .object({ content: z.nullable(z.string()).optional(), - direction: z.nullable(z.string()).optional(), + direction: z.nullable(UnifiedCrmEngagementInputDirection$inboundSchema).optional(), subject: z.nullable(z.string()).optional(), start_at: z .nullable( @@ -74,7 +133,7 @@ export const UnifiedCrmEngagementInput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - type: z.nullable(z.string()), + type: z.nullable(UnifiedCrmEngagementInputType$inboundSchema), user_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), contacts: z.nullable(z.array(z.string())).optional(), @@ -112,11 +171,11 @@ export const UnifiedCrmEngagementInput$outboundSchema: z.ZodType< > = z .object({ content: z.nullable(z.string()).optional(), - direction: z.nullable(z.string()).optional(), + direction: z.nullable(UnifiedCrmEngagementInputDirection$outboundSchema).optional(), subject: z.nullable(z.string()).optional(), startAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), endTime: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - type: z.nullable(z.string()), + type: z.nullable(UnifiedCrmEngagementInputType$outboundSchema), userId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), contacts: z.nullable(z.array(z.string())).optional(), diff --git a/src/models/components/unifiedcrmengagementoutput.ts b/src/models/components/unifiedcrmengagementoutput.ts index ebf1d711..8574e838 100644 --- a/src/models/components/unifiedcrmengagementoutput.ts +++ b/src/models/components/unifiedcrmengagementoutput.ts @@ -5,6 +5,23 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The direction of the engagement. Authorized values are INBOUND or OUTBOUND + */ +export enum Direction { + Inbound = "INBOUND", + Outbound = "OUTBOUND", +} + +/** + * The type of the engagement. Authorized values are EMAIL, CALL or MEETING + */ +export enum UnifiedCrmEngagementOutputType { + Email = "EMAIL", + Call = "CALL", + Meeting = "MEETING", +} + export type UnifiedCrmEngagementOutput = { /** * The content of the engagement @@ -13,7 +30,7 @@ export type UnifiedCrmEngagementOutput = { /** * The direction of the engagement. Authorized values are INBOUND or OUTBOUND */ - direction?: string | null | undefined; + direction?: Direction | null | undefined; /** * The subject of the engagement */ @@ -29,7 +46,7 @@ export type UnifiedCrmEngagementOutput = { /** * The type of the engagement. Authorized values are EMAIL, CALL or MEETING */ - type: string | null; + type: UnifiedCrmEngagementOutputType | null; /** * The UUID of the user tied to the engagement */ @@ -68,6 +85,44 @@ export type UnifiedCrmEngagementOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const Direction$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Direction); + +/** @internal */ +export const Direction$outboundSchema: z.ZodNativeEnum = Direction$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Direction$ { + /** @deprecated use `Direction$inboundSchema` instead. */ + export const inboundSchema = Direction$inboundSchema; + /** @deprecated use `Direction$outboundSchema` instead. */ + export const outboundSchema = Direction$outboundSchema; +} + +/** @internal */ +export const UnifiedCrmEngagementOutputType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmEngagementOutputType +> = z.nativeEnum(UnifiedCrmEngagementOutputType); + +/** @internal */ +export const UnifiedCrmEngagementOutputType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmEngagementOutputType +> = UnifiedCrmEngagementOutputType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedCrmEngagementOutputType$ { + /** @deprecated use `UnifiedCrmEngagementOutputType$inboundSchema` instead. */ + export const inboundSchema = UnifiedCrmEngagementOutputType$inboundSchema; + /** @deprecated use `UnifiedCrmEngagementOutputType$outboundSchema` instead. */ + export const outboundSchema = UnifiedCrmEngagementOutputType$outboundSchema; +} + /** @internal */ export const UnifiedCrmEngagementOutput$inboundSchema: z.ZodType< UnifiedCrmEngagementOutput, @@ -76,7 +131,7 @@ export const UnifiedCrmEngagementOutput$inboundSchema: z.ZodType< > = z .object({ content: z.nullable(z.string()).optional(), - direction: z.nullable(z.string()).optional(), + direction: z.nullable(Direction$inboundSchema).optional(), subject: z.nullable(z.string()).optional(), start_at: z .nullable( @@ -94,7 +149,7 @@ export const UnifiedCrmEngagementOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - type: z.nullable(z.string()), + type: z.nullable(UnifiedCrmEngagementOutputType$inboundSchema), user_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), contacts: z.nullable(z.array(z.string())).optional(), @@ -160,11 +215,11 @@ export const UnifiedCrmEngagementOutput$outboundSchema: z.ZodType< > = z .object({ content: z.nullable(z.string()).optional(), - direction: z.nullable(z.string()).optional(), + direction: z.nullable(Direction$outboundSchema).optional(), subject: z.nullable(z.string()).optional(), startAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), endTime: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - type: z.nullable(z.string()), + type: z.nullable(UnifiedCrmEngagementOutputType$outboundSchema), userId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), contacts: z.nullable(z.array(z.string())).optional(), diff --git a/src/models/components/unifiedcrmnoteinput.ts b/src/models/components/unifiedcrmnoteinput.ts index 8bc55cc2..5a2d8726 100644 --- a/src/models/components/unifiedcrmnoteinput.ts +++ b/src/models/components/unifiedcrmnoteinput.ts @@ -11,7 +11,7 @@ export type UnifiedCrmNoteInput = { */ content: string | null; /** - * The UUID of the user tied the note + * The UUID of the user tied to the note */ userId?: string | null | undefined; /** @@ -19,7 +19,7 @@ export type UnifiedCrmNoteInput = { */ companyId?: string | null | undefined; /** - * The UUID fo the contact tied to the note + * The UUID of the contact tied to the note */ contactId?: string | null | undefined; /** diff --git a/src/models/components/unifiedcrmnoteoutput.ts b/src/models/components/unifiedcrmnoteoutput.ts index 86f5c527..29572cd0 100644 --- a/src/models/components/unifiedcrmnoteoutput.ts +++ b/src/models/components/unifiedcrmnoteoutput.ts @@ -11,7 +11,7 @@ export type UnifiedCrmNoteOutput = { */ content: string | null; /** - * The UUID of the user tied the note + * The UUID of the user tied to the note */ userId?: string | null | undefined; /** @@ -19,7 +19,7 @@ export type UnifiedCrmNoteOutput = { */ companyId?: string | null | undefined; /** - * The UUID fo the contact tied to the note + * The UUID of the contact tied to the note */ contactId?: string | null | undefined; /** @@ -35,7 +35,7 @@ export type UnifiedCrmNoteOutput = { */ id?: string | null | undefined; /** - * The id of the note in the context of the Crm 3rd Party + * The ID of the note in the context of the Crm 3rd Party */ remoteId?: string | null | undefined; /** diff --git a/src/models/components/unifiedcrmstageoutput.ts b/src/models/components/unifiedcrmstageoutput.ts index d0dfb300..aa87683a 100644 --- a/src/models/components/unifiedcrmstageoutput.ts +++ b/src/models/components/unifiedcrmstageoutput.ts @@ -29,7 +29,7 @@ export type UnifiedCrmStageOutput = { */ id?: string | null | undefined; /** - * The id of the stage in the context of the Crm 3rd Party + * The ID of the stage in the context of the Crm 3rd Party */ remoteId?: string | null | undefined; /** diff --git a/src/models/components/unifiedcrmtaskinput.ts b/src/models/components/unifiedcrmtaskinput.ts index 6efdaa37..6cd04104 100644 --- a/src/models/components/unifiedcrmtaskinput.ts +++ b/src/models/components/unifiedcrmtaskinput.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the task. Authorized values are PENDING, COMPLETED. + */ +export enum UnifiedCrmTaskInputStatus { + Pending = "PENDING", + Completed = "COMPLETED", +} + export type UnifiedCrmTaskInput = { /** * The subject of the task @@ -17,15 +25,15 @@ export type UnifiedCrmTaskInput = { /** * The status of the task. Authorized values are PENDING, COMPLETED. */ - status: string | null; + status: UnifiedCrmTaskInputStatus | null; /** * The due date of the task */ - dueDate?: Date | null | undefined; + dueDate?: string | null | undefined; /** * The finished date of the task */ - finishedDate?: Date | null | undefined; + finishedDate?: string | null | undefined; /** * The UUID of the user tied to the task */ @@ -44,6 +52,27 @@ export type UnifiedCrmTaskInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedCrmTaskInputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmTaskInputStatus +> = z.nativeEnum(UnifiedCrmTaskInputStatus); + +/** @internal */ +export const UnifiedCrmTaskInputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmTaskInputStatus +> = UnifiedCrmTaskInputStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedCrmTaskInputStatus$ { + /** @deprecated use `UnifiedCrmTaskInputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedCrmTaskInputStatus$inboundSchema; + /** @deprecated use `UnifiedCrmTaskInputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedCrmTaskInputStatus$outboundSchema; +} + /** @internal */ export const UnifiedCrmTaskInput$inboundSchema: z.ZodType< UnifiedCrmTaskInput, @@ -53,23 +82,9 @@ export const UnifiedCrmTaskInput$inboundSchema: z.ZodType< .object({ subject: z.nullable(z.string()), content: z.nullable(z.string()), - status: z.nullable(z.string()), - due_date: z - .nullable( - z - .string() - .datetime({ offset: true }) - .transform((v) => new Date(v)) - ) - .optional(), - finished_date: z - .nullable( - z - .string() - .datetime({ offset: true }) - .transform((v) => new Date(v)) - ) - .optional(), + status: z.nullable(UnifiedCrmTaskInputStatus$inboundSchema), + due_date: z.nullable(z.string()).optional(), + finished_date: z.nullable(z.string()).optional(), user_id: z.nullable(z.string()).optional(), company_id: z.nullable(z.string()).optional(), deal_id: z.nullable(z.string()).optional(), @@ -108,9 +123,9 @@ export const UnifiedCrmTaskInput$outboundSchema: z.ZodType< .object({ subject: z.nullable(z.string()), content: z.nullable(z.string()), - status: z.nullable(z.string()), - dueDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - finishedDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), + status: z.nullable(UnifiedCrmTaskInputStatus$outboundSchema), + dueDate: z.nullable(z.string()).optional(), + finishedDate: z.nullable(z.string()).optional(), userId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), dealId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedcrmtaskoutput.ts b/src/models/components/unifiedcrmtaskoutput.ts index f75f00eb..f68560cb 100644 --- a/src/models/components/unifiedcrmtaskoutput.ts +++ b/src/models/components/unifiedcrmtaskoutput.ts @@ -6,14 +6,12 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; /** - * The created date of the object + * The status of the task. Authorized values are PENDING, COMPLETED. */ -export type UnifiedCrmTaskOutputCreatedAt = {}; - -/** - * The modified date of the object - */ -export type UnifiedCrmTaskOutputModifiedAt = {}; +export enum UnifiedCrmTaskOutputStatus { + Pending = "PENDING", + Completed = "COMPLETED", +} export type UnifiedCrmTaskOutput = { /** @@ -27,15 +25,15 @@ export type UnifiedCrmTaskOutput = { /** * The status of the task. Authorized values are PENDING, COMPLETED. */ - status: string | null; + status: UnifiedCrmTaskOutputStatus | null; /** * The due date of the task */ - dueDate?: Date | null | undefined; + dueDate?: string | null | undefined; /** * The finished date of the task */ - finishedDate?: Date | null | undefined; + finishedDate?: string | null | undefined; /** * The UUID of the user tied to the task */ @@ -57,7 +55,7 @@ export type UnifiedCrmTaskOutput = { */ id?: string | null | undefined; /** - * The id of the task in the context of the Crm 3rd Party + * The ID of the task in the context of the Crm 3rd Party */ remoteId?: string | null | undefined; /** @@ -67,71 +65,32 @@ export type UnifiedCrmTaskOutput = { /** * The created date of the object */ - createdAt?: UnifiedCrmTaskOutputCreatedAt | null | undefined; + createdAt?: Date | null | undefined; /** * The modified date of the object */ - modifiedAt?: UnifiedCrmTaskOutputModifiedAt | null | undefined; + modifiedAt?: Date | null | undefined; }; /** @internal */ -export const UnifiedCrmTaskOutputCreatedAt$inboundSchema: z.ZodType< - UnifiedCrmTaskOutputCreatedAt, - z.ZodTypeDef, - unknown -> = z.object({}); - -/** @internal */ -export type UnifiedCrmTaskOutputCreatedAt$Outbound = {}; +export const UnifiedCrmTaskOutputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmTaskOutputStatus +> = z.nativeEnum(UnifiedCrmTaskOutputStatus); /** @internal */ -export const UnifiedCrmTaskOutputCreatedAt$outboundSchema: z.ZodType< - UnifiedCrmTaskOutputCreatedAt$Outbound, - z.ZodTypeDef, - UnifiedCrmTaskOutputCreatedAt -> = z.object({}); +export const UnifiedCrmTaskOutputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedCrmTaskOutputStatus +> = UnifiedCrmTaskOutputStatus$inboundSchema; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace UnifiedCrmTaskOutputCreatedAt$ { - /** @deprecated use `UnifiedCrmTaskOutputCreatedAt$inboundSchema` instead. */ - export const inboundSchema = UnifiedCrmTaskOutputCreatedAt$inboundSchema; - /** @deprecated use `UnifiedCrmTaskOutputCreatedAt$outboundSchema` instead. */ - export const outboundSchema = UnifiedCrmTaskOutputCreatedAt$outboundSchema; - /** @deprecated use `UnifiedCrmTaskOutputCreatedAt$Outbound` instead. */ - export type Outbound = UnifiedCrmTaskOutputCreatedAt$Outbound; -} - -/** @internal */ -export const UnifiedCrmTaskOutputModifiedAt$inboundSchema: z.ZodType< - UnifiedCrmTaskOutputModifiedAt, - z.ZodTypeDef, - unknown -> = z.object({}); - -/** @internal */ -export type UnifiedCrmTaskOutputModifiedAt$Outbound = {}; - -/** @internal */ -export const UnifiedCrmTaskOutputModifiedAt$outboundSchema: z.ZodType< - UnifiedCrmTaskOutputModifiedAt$Outbound, - z.ZodTypeDef, - UnifiedCrmTaskOutputModifiedAt -> = z.object({}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace UnifiedCrmTaskOutputModifiedAt$ { - /** @deprecated use `UnifiedCrmTaskOutputModifiedAt$inboundSchema` instead. */ - export const inboundSchema = UnifiedCrmTaskOutputModifiedAt$inboundSchema; - /** @deprecated use `UnifiedCrmTaskOutputModifiedAt$outboundSchema` instead. */ - export const outboundSchema = UnifiedCrmTaskOutputModifiedAt$outboundSchema; - /** @deprecated use `UnifiedCrmTaskOutputModifiedAt$Outbound` instead. */ - export type Outbound = UnifiedCrmTaskOutputModifiedAt$Outbound; +export namespace UnifiedCrmTaskOutputStatus$ { + /** @deprecated use `UnifiedCrmTaskOutputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedCrmTaskOutputStatus$inboundSchema; + /** @deprecated use `UnifiedCrmTaskOutputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedCrmTaskOutputStatus$outboundSchema; } /** @internal */ @@ -143,8 +102,17 @@ export const UnifiedCrmTaskOutput$inboundSchema: z.ZodType< .object({ subject: z.nullable(z.string()), content: z.nullable(z.string()), - status: z.nullable(z.string()), - due_date: z + status: z.nullable(UnifiedCrmTaskOutputStatus$inboundSchema), + due_date: z.nullable(z.string()).optional(), + finished_date: z.nullable(z.string()).optional(), + user_id: z.nullable(z.string()).optional(), + company_id: z.nullable(z.string()).optional(), + deal_id: z.nullable(z.string()).optional(), + field_mappings: z.nullable(z.record(z.any())).optional(), + id: z.nullable(z.string()).optional(), + remote_id: z.nullable(z.string()).optional(), + remote_data: z.nullable(z.record(z.any())).optional(), + created_at: z .nullable( z .string() @@ -152,7 +120,7 @@ export const UnifiedCrmTaskOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - finished_date: z + modified_at: z .nullable( z .string() @@ -160,19 +128,6 @@ export const UnifiedCrmTaskOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - user_id: z.nullable(z.string()).optional(), - company_id: z.nullable(z.string()).optional(), - deal_id: z.nullable(z.string()).optional(), - field_mappings: z.nullable(z.record(z.any())).optional(), - id: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), - remote_data: z.nullable(z.record(z.any())).optional(), - created_at: z - .nullable(z.lazy(() => UnifiedCrmTaskOutputCreatedAt$inboundSchema)) - .optional(), - modified_at: z - .nullable(z.lazy(() => UnifiedCrmTaskOutputModifiedAt$inboundSchema)) - .optional(), }) .transform((v) => { return remap$(v, { @@ -203,8 +158,8 @@ export type UnifiedCrmTaskOutput$Outbound = { id?: string | null | undefined; remote_id?: string | null | undefined; remote_data?: { [k: string]: any } | null | undefined; - created_at?: UnifiedCrmTaskOutputCreatedAt$Outbound | null | undefined; - modified_at?: UnifiedCrmTaskOutputModifiedAt$Outbound | null | undefined; + created_at?: string | null | undefined; + modified_at?: string | null | undefined; }; /** @internal */ @@ -216,9 +171,9 @@ export const UnifiedCrmTaskOutput$outboundSchema: z.ZodType< .object({ subject: z.nullable(z.string()), content: z.nullable(z.string()), - status: z.nullable(z.string()), - dueDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - finishedDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), + status: z.nullable(UnifiedCrmTaskOutputStatus$outboundSchema), + dueDate: z.nullable(z.string()).optional(), + finishedDate: z.nullable(z.string()).optional(), userId: z.nullable(z.string()).optional(), companyId: z.nullable(z.string()).optional(), dealId: z.nullable(z.string()).optional(), @@ -226,12 +181,8 @@ export const UnifiedCrmTaskOutput$outboundSchema: z.ZodType< id: z.nullable(z.string()).optional(), remoteId: z.nullable(z.string()).optional(), remoteData: z.nullable(z.record(z.any())).optional(), - createdAt: z - .nullable(z.lazy(() => UnifiedCrmTaskOutputCreatedAt$outboundSchema)) - .optional(), - modifiedAt: z - .nullable(z.lazy(() => UnifiedCrmTaskOutputModifiedAt$outboundSchema)) - .optional(), + createdAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), + modifiedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/unifiedfilestoragefolderoutput.ts b/src/models/components/unifiedfilestoragefolderoutput.ts index a2cea886..5674bd16 100644 --- a/src/models/components/unifiedfilestoragefolderoutput.ts +++ b/src/models/components/unifiedfilestoragefolderoutput.ts @@ -47,7 +47,7 @@ export type UnifiedFilestorageFolderOutput = { */ id?: string | null | undefined; /** - * The id of the folder in the context of the 3rd Party + * The remote ID of the folder in the context of the 3rd Party */ remoteId?: string | null | undefined; /** @@ -55,11 +55,11 @@ export type UnifiedFilestorageFolderOutput = { */ remoteData?: { [k: string]: any } | null | undefined; /** - * The created date of the object + * The created date of the folder */ createdAt?: Date | null | undefined; /** - * The modified date of the object + * The modified date of the folder */ modifiedAt?: Date | null | undefined; }; diff --git a/src/models/components/unifieduseroutput.ts b/src/models/components/unifiedfilestorageuseroutput.ts similarity index 56% rename from src/models/components/unifieduseroutput.ts rename to src/models/components/unifiedfilestorageuseroutput.ts index fcfdfa03..5ac92218 100644 --- a/src/models/components/unifieduseroutput.ts +++ b/src/models/components/unifiedfilestorageuseroutput.ts @@ -5,7 +5,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; -export type UnifiedUserOutput = { +export type UnifiedFilestorageUserOutput = { /** * The name of the user */ @@ -45,46 +45,49 @@ export type UnifiedUserOutput = { }; /** @internal */ -export const UnifiedUserOutput$inboundSchema: z.ZodType = - z - .object({ - name: z.nullable(z.string()), - email: z.nullable(z.string()), - is_me: z.nullable(z.boolean()), - field_mappings: z.nullable(z.record(z.any())).optional(), - id: z.nullable(z.string()).optional(), - remote_id: z.nullable(z.string()).optional(), - remote_data: z.nullable(z.record(z.any())).optional(), - created_at: z - .nullable( - z - .string() - .datetime({ offset: true }) - .transform((v) => new Date(v)) - ) - .optional(), - modified_at: z - .nullable( - z - .string() - .datetime({ offset: true }) - .transform((v) => new Date(v)) - ) - .optional(), - }) - .transform((v) => { - return remap$(v, { - is_me: "isMe", - field_mappings: "fieldMappings", - remote_id: "remoteId", - remote_data: "remoteData", - created_at: "createdAt", - modified_at: "modifiedAt", - }); +export const UnifiedFilestorageUserOutput$inboundSchema: z.ZodType< + UnifiedFilestorageUserOutput, + z.ZodTypeDef, + unknown +> = z + .object({ + name: z.nullable(z.string()), + email: z.nullable(z.string()), + is_me: z.nullable(z.boolean()), + field_mappings: z.nullable(z.record(z.any())).optional(), + id: z.nullable(z.string()).optional(), + remote_id: z.nullable(z.string()).optional(), + remote_data: z.nullable(z.record(z.any())).optional(), + created_at: z + .nullable( + z + .string() + .datetime({ offset: true }) + .transform((v) => new Date(v)) + ) + .optional(), + modified_at: z + .nullable( + z + .string() + .datetime({ offset: true }) + .transform((v) => new Date(v)) + ) + .optional(), + }) + .transform((v) => { + return remap$(v, { + is_me: "isMe", + field_mappings: "fieldMappings", + remote_id: "remoteId", + remote_data: "remoteData", + created_at: "createdAt", + modified_at: "modifiedAt", }); + }); /** @internal */ -export type UnifiedUserOutput$Outbound = { +export type UnifiedFilestorageUserOutput$Outbound = { name: string | null; email: string | null; is_me: boolean | null; @@ -97,10 +100,10 @@ export type UnifiedUserOutput$Outbound = { }; /** @internal */ -export const UnifiedUserOutput$outboundSchema: z.ZodType< - UnifiedUserOutput$Outbound, +export const UnifiedFilestorageUserOutput$outboundSchema: z.ZodType< + UnifiedFilestorageUserOutput$Outbound, z.ZodTypeDef, - UnifiedUserOutput + UnifiedFilestorageUserOutput > = z .object({ name: z.nullable(z.string()), @@ -128,11 +131,11 @@ export const UnifiedUserOutput$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace UnifiedUserOutput$ { - /** @deprecated use `UnifiedUserOutput$inboundSchema` instead. */ - export const inboundSchema = UnifiedUserOutput$inboundSchema; - /** @deprecated use `UnifiedUserOutput$outboundSchema` instead. */ - export const outboundSchema = UnifiedUserOutput$outboundSchema; - /** @deprecated use `UnifiedUserOutput$Outbound` instead. */ - export type Outbound = UnifiedUserOutput$Outbound; +export namespace UnifiedFilestorageUserOutput$ { + /** @deprecated use `UnifiedFilestorageUserOutput$inboundSchema` instead. */ + export const inboundSchema = UnifiedFilestorageUserOutput$inboundSchema; + /** @deprecated use `UnifiedFilestorageUserOutput$outboundSchema` instead. */ + export const outboundSchema = UnifiedFilestorageUserOutput$outboundSchema; + /** @deprecated use `UnifiedFilestorageUserOutput$Outbound` instead. */ + export type Outbound = UnifiedFilestorageUserOutput$Outbound; } diff --git a/src/models/components/unifiedmarketingautomationcampaignoutput.ts b/src/models/components/unifiedmarketingautomationcampaignoutput.ts new file mode 100644 index 00000000..fec19c5e --- /dev/null +++ b/src/models/components/unifiedmarketingautomationcampaignoutput.ts @@ -0,0 +1,37 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; + +export type UnifiedMarketingautomationCampaignOutput = {}; + +/** @internal */ +export const UnifiedMarketingautomationCampaignOutput$inboundSchema: z.ZodType< + UnifiedMarketingautomationCampaignOutput, + z.ZodTypeDef, + unknown +> = z.object({}); + +/** @internal */ +export type UnifiedMarketingautomationCampaignOutput$Outbound = {}; + +/** @internal */ +export const UnifiedMarketingautomationCampaignOutput$outboundSchema: z.ZodType< + UnifiedMarketingautomationCampaignOutput$Outbound, + z.ZodTypeDef, + UnifiedMarketingautomationCampaignOutput +> = z.object({}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedMarketingautomationCampaignOutput$ { + /** @deprecated use `UnifiedMarketingautomationCampaignOutput$inboundSchema` instead. */ + export const inboundSchema = UnifiedMarketingautomationCampaignOutput$inboundSchema; + /** @deprecated use `UnifiedMarketingautomationCampaignOutput$outboundSchema` instead. */ + export const outboundSchema = UnifiedMarketingautomationCampaignOutput$outboundSchema; + /** @deprecated use `UnifiedMarketingautomationCampaignOutput$Outbound` instead. */ + export type Outbound = UnifiedMarketingautomationCampaignOutput$Outbound; +} diff --git a/src/models/components/unifiedticketingaccountoutput.ts b/src/models/components/unifiedticketingaccountoutput.ts index 4b47f9d1..e4182d17 100644 --- a/src/models/components/unifiedticketingaccountoutput.ts +++ b/src/models/components/unifiedticketingaccountoutput.ts @@ -23,7 +23,7 @@ export type UnifiedTicketingAccountOutput = { */ id?: string | null | undefined; /** - * The id of the account in the context of the 3rd Party + * The remote ID of the account in the context of the 3rd Party */ remoteId?: string | null | undefined; /** @@ -31,11 +31,11 @@ export type UnifiedTicketingAccountOutput = { */ remoteData?: { [k: string]: any } | null | undefined; /** - * The created date of the object + * The created date of the account */ createdAt?: Date | null | undefined; /** - * The modified date of the object + * The modified date of the account */ modifiedAt?: Date | null | undefined; }; diff --git a/src/models/components/unifiedticketingattachmentinput.ts b/src/models/components/unifiedticketingattachmentinput.ts index 16dc104c..d30334bd 100644 --- a/src/models/components/unifiedticketingattachmentinput.ts +++ b/src/models/components/unifiedticketingattachmentinput.ts @@ -29,7 +29,7 @@ export type UnifiedTicketingAttachmentInput = { /** * The custom field mappings of the attachment between the remote 3rd party & Panora */ - fieldMappings: { [k: string]: any } | null; + fieldMappings?: { [k: string]: any } | null | undefined; }; /** @internal */ @@ -44,7 +44,7 @@ export const UnifiedTicketingAttachmentInput$inboundSchema: z.ZodType< uploader: z.nullable(z.string()), ticket_id: z.nullable(z.string()).optional(), comment_id: z.nullable(z.string()).optional(), - field_mappings: z.nullable(z.record(z.any())), + field_mappings: z.nullable(z.record(z.any())).optional(), }) .transform((v) => { return remap$(v, { @@ -63,7 +63,7 @@ export type UnifiedTicketingAttachmentInput$Outbound = { uploader: string | null; ticket_id?: string | null | undefined; comment_id?: string | null | undefined; - field_mappings: { [k: string]: any } | null; + field_mappings?: { [k: string]: any } | null | undefined; }; /** @internal */ @@ -78,7 +78,7 @@ export const UnifiedTicketingAttachmentInput$outboundSchema: z.ZodType< uploader: z.nullable(z.string()), ticketId: z.nullable(z.string()).optional(), commentId: z.nullable(z.string()).optional(), - fieldMappings: z.nullable(z.record(z.any())), + fieldMappings: z.nullable(z.record(z.any())).optional(), }) .transform((v) => { return remap$(v, { diff --git a/src/models/components/unifiedticketingcollectionoutput.ts b/src/models/components/unifiedticketingcollectionoutput.ts index 46eadb49..5eabd13c 100644 --- a/src/models/components/unifiedticketingcollectionoutput.ts +++ b/src/models/components/unifiedticketingcollectionoutput.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The type of the collection. Authorized values are either PROJECT or LIST + */ +export enum CollectionType { + Project = "PROJECT", + List = "LIST", +} + export type UnifiedTicketingCollectionOutput = { /** * The name of the collection @@ -17,7 +25,7 @@ export type UnifiedTicketingCollectionOutput = { /** * The type of the collection. Authorized values are either PROJECT or LIST */ - collectionType?: string | null | undefined; + collectionType?: CollectionType | null | undefined; /** * The UUID of the collection */ @@ -40,6 +48,25 @@ export type UnifiedTicketingCollectionOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const CollectionType$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(CollectionType); + +/** @internal */ +export const CollectionType$outboundSchema: z.ZodNativeEnum = + CollectionType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CollectionType$ { + /** @deprecated use `CollectionType$inboundSchema` instead. */ + export const inboundSchema = CollectionType$inboundSchema; + /** @deprecated use `CollectionType$outboundSchema` instead. */ + export const outboundSchema = CollectionType$outboundSchema; +} + /** @internal */ export const UnifiedTicketingCollectionOutput$inboundSchema: z.ZodType< UnifiedTicketingCollectionOutput, @@ -49,7 +76,7 @@ export const UnifiedTicketingCollectionOutput$inboundSchema: z.ZodType< .object({ name: z.nullable(z.string()), description: z.nullable(z.string()).optional(), - collection_type: z.nullable(z.string()).optional(), + collection_type: z.nullable(CollectionType$inboundSchema).optional(), id: z.nullable(z.string()).optional(), remote_id: z.nullable(z.string()).optional(), remote_data: z.nullable(z.record(z.any())).optional(), @@ -101,7 +128,7 @@ export const UnifiedTicketingCollectionOutput$outboundSchema: z.ZodType< .object({ name: z.nullable(z.string()), description: z.nullable(z.string()).optional(), - collectionType: z.nullable(z.string()).optional(), + collectionType: z.nullable(CollectionType$outboundSchema).optional(), id: z.nullable(z.string()).optional(), remoteId: z.nullable(z.string()).optional(), remoteData: z.nullable(z.record(z.any())).optional(), diff --git a/src/models/components/unifiedticketingcommentinput.ts b/src/models/components/unifiedticketingcommentinput.ts index 232638c7..bfe3d259 100644 --- a/src/models/components/unifiedticketingcommentinput.ts +++ b/src/models/components/unifiedticketingcommentinput.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The creator type of the comment. Authorized values are either USER or CONTACT + */ +export enum UnifiedTicketingCommentInputCreatorType { + User = "USER", + Contact = "CONTACT", +} + export type UnifiedTicketingCommentInput = { /** * The body of the comment @@ -21,7 +29,7 @@ export type UnifiedTicketingCommentInput = { /** * The creator type of the comment. Authorized values are either USER or CONTACT */ - creatorType?: string | null | undefined; + creatorType?: UnifiedTicketingCommentInputCreatorType | null | undefined; /** * The UUID of the ticket the comment is tied to */ @@ -40,6 +48,27 @@ export type UnifiedTicketingCommentInput = { attachments?: Array | null | undefined; }; +/** @internal */ +export const UnifiedTicketingCommentInputCreatorType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingCommentInputCreatorType +> = z.nativeEnum(UnifiedTicketingCommentInputCreatorType); + +/** @internal */ +export const UnifiedTicketingCommentInputCreatorType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingCommentInputCreatorType +> = UnifiedTicketingCommentInputCreatorType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedTicketingCommentInputCreatorType$ { + /** @deprecated use `UnifiedTicketingCommentInputCreatorType$inboundSchema` instead. */ + export const inboundSchema = UnifiedTicketingCommentInputCreatorType$inboundSchema; + /** @deprecated use `UnifiedTicketingCommentInputCreatorType$outboundSchema` instead. */ + export const outboundSchema = UnifiedTicketingCommentInputCreatorType$outboundSchema; +} + /** @internal */ export const UnifiedTicketingCommentInput$inboundSchema: z.ZodType< UnifiedTicketingCommentInput, @@ -50,7 +79,7 @@ export const UnifiedTicketingCommentInput$inboundSchema: z.ZodType< body: z.nullable(z.string()), html_body: z.nullable(z.string()).optional(), is_private: z.nullable(z.boolean()).optional(), - creator_type: z.nullable(z.string()).optional(), + creator_type: z.nullable(UnifiedTicketingCommentInputCreatorType$inboundSchema).optional(), ticket_id: z.nullable(z.string()).optional(), contact_id: z.nullable(z.string()).optional(), user_id: z.nullable(z.string()).optional(), @@ -89,7 +118,7 @@ export const UnifiedTicketingCommentInput$outboundSchema: z.ZodType< body: z.nullable(z.string()), htmlBody: z.nullable(z.string()).optional(), isPrivate: z.nullable(z.boolean()).optional(), - creatorType: z.nullable(z.string()).optional(), + creatorType: z.nullable(UnifiedTicketingCommentInputCreatorType$outboundSchema).optional(), ticketId: z.nullable(z.string()).optional(), contactId: z.nullable(z.string()).optional(), userId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedticketingcommentoutput.ts b/src/models/components/unifiedticketingcommentoutput.ts index 2ea767eb..ec3e66fc 100644 --- a/src/models/components/unifiedticketingcommentoutput.ts +++ b/src/models/components/unifiedticketingcommentoutput.ts @@ -5,6 +5,14 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The creator type of the comment. Authorized values are either USER or CONTACT + */ +export enum CreatorType { + User = "USER", + Contact = "CONTACT", +} + export type UnifiedTicketingCommentOutput = { /** * The body of the comment @@ -21,7 +29,7 @@ export type UnifiedTicketingCommentOutput = { /** * The creator type of the comment. Authorized values are either USER or CONTACT */ - creatorType?: string | null | undefined; + creatorType?: CreatorType | null | undefined; /** * The UUID of the ticket the comment is tied to */ @@ -60,6 +68,25 @@ export type UnifiedTicketingCommentOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const CreatorType$inboundSchema: z.ZodNativeEnum = + z.nativeEnum(CreatorType); + +/** @internal */ +export const CreatorType$outboundSchema: z.ZodNativeEnum = + CreatorType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CreatorType$ { + /** @deprecated use `CreatorType$inboundSchema` instead. */ + export const inboundSchema = CreatorType$inboundSchema; + /** @deprecated use `CreatorType$outboundSchema` instead. */ + export const outboundSchema = CreatorType$outboundSchema; +} + /** @internal */ export const UnifiedTicketingCommentOutput$inboundSchema: z.ZodType< UnifiedTicketingCommentOutput, @@ -70,7 +97,7 @@ export const UnifiedTicketingCommentOutput$inboundSchema: z.ZodType< body: z.nullable(z.string()), html_body: z.nullable(z.string()).optional(), is_private: z.nullable(z.boolean()).optional(), - creator_type: z.nullable(z.string()).optional(), + creator_type: z.nullable(CreatorType$inboundSchema).optional(), ticket_id: z.nullable(z.string()).optional(), contact_id: z.nullable(z.string()).optional(), user_id: z.nullable(z.string()).optional(), @@ -137,7 +164,7 @@ export const UnifiedTicketingCommentOutput$outboundSchema: z.ZodType< body: z.nullable(z.string()), htmlBody: z.nullable(z.string()).optional(), isPrivate: z.nullable(z.boolean()).optional(), - creatorType: z.nullable(z.string()).optional(), + creatorType: z.nullable(CreatorType$outboundSchema).optional(), ticketId: z.nullable(z.string()).optional(), contactId: z.nullable(z.string()).optional(), userId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedticketingcontactoutput.ts b/src/models/components/unifiedticketingcontactoutput.ts index 435a2b99..228aae93 100644 --- a/src/models/components/unifiedticketingcontactoutput.ts +++ b/src/models/components/unifiedticketingcontactoutput.ts @@ -31,7 +31,7 @@ export type UnifiedTicketingContactOutput = { */ id?: string | undefined; /** - * The id of the contact in the context of the 3rd Party + * The remote ID of the contact in the context of the 3rd Party */ remoteId?: string | null | undefined; /** diff --git a/src/models/components/unifiedticketingtagoutput.ts b/src/models/components/unifiedticketingtagoutput.ts index 9209100b..68785c71 100644 --- a/src/models/components/unifiedticketingtagoutput.ts +++ b/src/models/components/unifiedticketingtagoutput.ts @@ -19,7 +19,7 @@ export type UnifiedTicketingTagOutput = { */ id?: string | null | undefined; /** - * The id of the tag in the context of the 3rd Party + * The remote ID of the tag in the context of the 3rd Party */ remoteId?: string | null | undefined; /** @@ -27,11 +27,11 @@ export type UnifiedTicketingTagOutput = { */ remoteData?: { [k: string]: any } | null | undefined; /** - * The created date of the object + * The created date of the tag */ createdAt?: Date | null | undefined; /** - * The modified date of the object + * The modified date of the tag */ modifiedAt?: Date | null | undefined; }; diff --git a/src/models/components/unifiedticketingticketinput.ts b/src/models/components/unifiedticketingticketinput.ts index 8ee81417..2a8f1042 100644 --- a/src/models/components/unifiedticketingticketinput.ts +++ b/src/models/components/unifiedticketingticketinput.ts @@ -5,6 +5,41 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the ticket. Authorized values are OPEN or CLOSED. + */ +export enum UnifiedTicketingTicketInputStatus { + Open = "OPEN", + Closed = "CLOSED", +} + +/** + * The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK + */ +export enum UnifiedTicketingTicketInputType { + Bug = "BUG", + Subtask = "SUBTASK", + Task = "TASK", + ToDo = "TO-DO", +} + +/** + * The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. + */ +export enum UnifiedTicketingTicketInputPriority { + High = "HIGH", + Medium = "MEDIUM", + Low = "LOW", +} + +/** + * The creator type of the comment. Authorized values are either USER or CONTACT + */ +export enum UnifiedTicketingTicketInputCreatorType { + User = "USER", + Contact = "CONTACT", +} + /** * The comment of the ticket */ @@ -24,7 +59,7 @@ export type UnifiedTicketingTicketInputComment = { /** * The creator type of the comment. Authorized values are either USER or CONTACT */ - creatorType?: string | null | undefined; + creatorType?: UnifiedTicketingTicketInputCreatorType | null | undefined; /** * The UUID of the ticket the comment is tied to */ @@ -51,7 +86,7 @@ export type UnifiedTicketingTicketInput = { /** * The status of the ticket. Authorized values are OPEN or CLOSED. */ - status?: string | null | undefined; + status?: UnifiedTicketingTicketInputStatus | null | undefined; /** * The description of the ticket */ @@ -63,7 +98,7 @@ export type UnifiedTicketingTicketInput = { /** * The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK */ - type?: string | null | undefined; + type?: UnifiedTicketingTicketInputType | null | undefined; /** * The UUID of the parent ticket */ @@ -83,7 +118,7 @@ export type UnifiedTicketingTicketInput = { /** * The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. */ - priority?: string | null | undefined; + priority?: UnifiedTicketingTicketInputPriority | null | undefined; /** * The users UUIDs the ticket is assigned to */ @@ -101,7 +136,7 @@ export type UnifiedTicketingTicketInput = { */ contactId?: string | null | undefined; /** - * The attachments UUIDs tied to the ticket + * The attachements UUIDs tied to the ticket */ attachments?: Array | null | undefined; /** @@ -110,6 +145,90 @@ export type UnifiedTicketingTicketInput = { fieldMappings?: { [k: string]: any } | null | undefined; }; +/** @internal */ +export const UnifiedTicketingTicketInputStatus$inboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputStatus +> = z.nativeEnum(UnifiedTicketingTicketInputStatus); + +/** @internal */ +export const UnifiedTicketingTicketInputStatus$outboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputStatus +> = UnifiedTicketingTicketInputStatus$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedTicketingTicketInputStatus$ { + /** @deprecated use `UnifiedTicketingTicketInputStatus$inboundSchema` instead. */ + export const inboundSchema = UnifiedTicketingTicketInputStatus$inboundSchema; + /** @deprecated use `UnifiedTicketingTicketInputStatus$outboundSchema` instead. */ + export const outboundSchema = UnifiedTicketingTicketInputStatus$outboundSchema; +} + +/** @internal */ +export const UnifiedTicketingTicketInputType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputType +> = z.nativeEnum(UnifiedTicketingTicketInputType); + +/** @internal */ +export const UnifiedTicketingTicketInputType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputType +> = UnifiedTicketingTicketInputType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedTicketingTicketInputType$ { + /** @deprecated use `UnifiedTicketingTicketInputType$inboundSchema` instead. */ + export const inboundSchema = UnifiedTicketingTicketInputType$inboundSchema; + /** @deprecated use `UnifiedTicketingTicketInputType$outboundSchema` instead. */ + export const outboundSchema = UnifiedTicketingTicketInputType$outboundSchema; +} + +/** @internal */ +export const UnifiedTicketingTicketInputPriority$inboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputPriority +> = z.nativeEnum(UnifiedTicketingTicketInputPriority); + +/** @internal */ +export const UnifiedTicketingTicketInputPriority$outboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputPriority +> = UnifiedTicketingTicketInputPriority$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedTicketingTicketInputPriority$ { + /** @deprecated use `UnifiedTicketingTicketInputPriority$inboundSchema` instead. */ + export const inboundSchema = UnifiedTicketingTicketInputPriority$inboundSchema; + /** @deprecated use `UnifiedTicketingTicketInputPriority$outboundSchema` instead. */ + export const outboundSchema = UnifiedTicketingTicketInputPriority$outboundSchema; +} + +/** @internal */ +export const UnifiedTicketingTicketInputCreatorType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputCreatorType +> = z.nativeEnum(UnifiedTicketingTicketInputCreatorType); + +/** @internal */ +export const UnifiedTicketingTicketInputCreatorType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketInputCreatorType +> = UnifiedTicketingTicketInputCreatorType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedTicketingTicketInputCreatorType$ { + /** @deprecated use `UnifiedTicketingTicketInputCreatorType$inboundSchema` instead. */ + export const inboundSchema = UnifiedTicketingTicketInputCreatorType$inboundSchema; + /** @deprecated use `UnifiedTicketingTicketInputCreatorType$outboundSchema` instead. */ + export const outboundSchema = UnifiedTicketingTicketInputCreatorType$outboundSchema; +} + /** @internal */ export const UnifiedTicketingTicketInputComment$inboundSchema: z.ZodType< UnifiedTicketingTicketInputComment, @@ -120,7 +239,7 @@ export const UnifiedTicketingTicketInputComment$inboundSchema: z.ZodType< body: z.nullable(z.string()), html_body: z.nullable(z.string()).optional(), is_private: z.nullable(z.boolean()).optional(), - creator_type: z.nullable(z.string()).optional(), + creator_type: z.nullable(UnifiedTicketingTicketInputCreatorType$inboundSchema).optional(), ticket_id: z.nullable(z.string()).optional(), contact_id: z.nullable(z.string()).optional(), user_id: z.nullable(z.string()).optional(), @@ -159,7 +278,7 @@ export const UnifiedTicketingTicketInputComment$outboundSchema: z.ZodType< body: z.nullable(z.string()), htmlBody: z.nullable(z.string()).optional(), isPrivate: z.nullable(z.boolean()).optional(), - creatorType: z.nullable(z.string()).optional(), + creatorType: z.nullable(UnifiedTicketingTicketInputCreatorType$outboundSchema).optional(), ticketId: z.nullable(z.string()).optional(), contactId: z.nullable(z.string()).optional(), userId: z.nullable(z.string()).optional(), @@ -197,7 +316,7 @@ export const UnifiedTicketingTicketInput$inboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedTicketingTicketInputStatus$inboundSchema).optional(), description: z.nullable(z.string()), due_date: z .nullable( @@ -207,7 +326,7 @@ export const UnifiedTicketingTicketInput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - type: z.nullable(z.string()).optional(), + type: z.nullable(UnifiedTicketingTicketInputType$inboundSchema).optional(), parent_ticket: z.nullable(z.string()).optional(), collections: z.nullable(z.string()).optional(), tags: z.nullable(z.array(z.string())).optional(), @@ -219,7 +338,7 @@ export const UnifiedTicketingTicketInput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - priority: z.nullable(z.string()).optional(), + priority: z.nullable(UnifiedTicketingTicketInputPriority$inboundSchema).optional(), assigned_to: z.nullable(z.array(z.string())).optional(), comment: z .nullable(z.lazy(() => UnifiedTicketingTicketInputComment$inboundSchema)) @@ -269,15 +388,15 @@ export const UnifiedTicketingTicketInput$outboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - status: z.nullable(z.string()).optional(), + status: z.nullable(UnifiedTicketingTicketInputStatus$outboundSchema).optional(), description: z.nullable(z.string()), dueDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - type: z.nullable(z.string()).optional(), + type: z.nullable(UnifiedTicketingTicketInputType$outboundSchema).optional(), parentTicket: z.nullable(z.string()).optional(), collections: z.nullable(z.string()).optional(), tags: z.nullable(z.array(z.string())).optional(), completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - priority: z.nullable(z.string()).optional(), + priority: z.nullable(UnifiedTicketingTicketInputPriority$outboundSchema).optional(), assignedTo: z.nullable(z.array(z.string())).optional(), comment: z .nullable(z.lazy(() => UnifiedTicketingTicketInputComment$outboundSchema)) diff --git a/src/models/components/unifiedticketingticketoutput.ts b/src/models/components/unifiedticketingticketoutput.ts index eaa56ecb..12a64913 100644 --- a/src/models/components/unifiedticketingticketoutput.ts +++ b/src/models/components/unifiedticketingticketoutput.ts @@ -5,6 +5,41 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; +/** + * The status of the ticket. Authorized values are OPEN or CLOSED. + */ +export enum Status { + Open = "OPEN", + Closed = "CLOSED", +} + +/** + * The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK + */ +export enum Type { + Bug = "BUG", + Subtask = "SUBTASK", + Task = "TASK", + ToDo = "TO-DO", +} + +/** + * The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. + */ +export enum Priority { + High = "HIGH", + Medium = "MEDIUM", + Low = "LOW", +} + +/** + * The creator type of the comment. Authorized values are either USER or CONTACT + */ +export enum UnifiedTicketingTicketOutputCreatorType { + User = "USER", + Contact = "CONTACT", +} + /** * The comment of the ticket */ @@ -24,7 +59,7 @@ export type Comment = { /** * The creator type of the comment. Authorized values are either USER or CONTACT */ - creatorType?: string | null | undefined; + creatorType?: UnifiedTicketingTicketOutputCreatorType | null | undefined; /** * The UUID of the ticket the comment is tied to */ @@ -51,7 +86,7 @@ export type UnifiedTicketingTicketOutput = { /** * The status of the ticket. Authorized values are OPEN or CLOSED. */ - status?: string | null | undefined; + status?: Status | null | undefined; /** * The description of the ticket */ @@ -63,7 +98,7 @@ export type UnifiedTicketingTicketOutput = { /** * The type of the ticket. Authorized values are PROBLEM, QUESTION, or TASK */ - type?: string | null | undefined; + type?: Type | null | undefined; /** * The UUID of the parent ticket */ @@ -83,7 +118,7 @@ export type UnifiedTicketingTicketOutput = { /** * The priority of the ticket. Authorized values are HIGH, MEDIUM or LOW. */ - priority?: string | null | undefined; + priority?: Priority | null | undefined; /** * The users UUIDs the ticket is assigned to */ @@ -101,7 +136,7 @@ export type UnifiedTicketingTicketOutput = { */ contactId?: string | null | undefined; /** - * The attachments UUIDs tied to the ticket + * The attachements UUIDs tied to the ticket */ attachments?: Array | null | undefined; /** @@ -130,13 +165,85 @@ export type UnifiedTicketingTicketOutput = { modifiedAt?: Date | null | undefined; }; +/** @internal */ +export const Status$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Status); + +/** @internal */ +export const Status$outboundSchema: z.ZodNativeEnum = Status$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Status$ { + /** @deprecated use `Status$inboundSchema` instead. */ + export const inboundSchema = Status$inboundSchema; + /** @deprecated use `Status$outboundSchema` instead. */ + export const outboundSchema = Status$outboundSchema; +} + +/** @internal */ +export const Type$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Type); + +/** @internal */ +export const Type$outboundSchema: z.ZodNativeEnum = Type$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Type$ { + /** @deprecated use `Type$inboundSchema` instead. */ + export const inboundSchema = Type$inboundSchema; + /** @deprecated use `Type$outboundSchema` instead. */ + export const outboundSchema = Type$outboundSchema; +} + +/** @internal */ +export const Priority$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Priority); + +/** @internal */ +export const Priority$outboundSchema: z.ZodNativeEnum = Priority$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Priority$ { + /** @deprecated use `Priority$inboundSchema` instead. */ + export const inboundSchema = Priority$inboundSchema; + /** @deprecated use `Priority$outboundSchema` instead. */ + export const outboundSchema = Priority$outboundSchema; +} + +/** @internal */ +export const UnifiedTicketingTicketOutputCreatorType$inboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketOutputCreatorType +> = z.nativeEnum(UnifiedTicketingTicketOutputCreatorType); + +/** @internal */ +export const UnifiedTicketingTicketOutputCreatorType$outboundSchema: z.ZodNativeEnum< + typeof UnifiedTicketingTicketOutputCreatorType +> = UnifiedTicketingTicketOutputCreatorType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace UnifiedTicketingTicketOutputCreatorType$ { + /** @deprecated use `UnifiedTicketingTicketOutputCreatorType$inboundSchema` instead. */ + export const inboundSchema = UnifiedTicketingTicketOutputCreatorType$inboundSchema; + /** @deprecated use `UnifiedTicketingTicketOutputCreatorType$outboundSchema` instead. */ + export const outboundSchema = UnifiedTicketingTicketOutputCreatorType$outboundSchema; +} + /** @internal */ export const Comment$inboundSchema: z.ZodType = z .object({ body: z.nullable(z.string()), html_body: z.nullable(z.string()).optional(), is_private: z.nullable(z.boolean()).optional(), - creator_type: z.nullable(z.string()).optional(), + creator_type: z.nullable(UnifiedTicketingTicketOutputCreatorType$inboundSchema).optional(), ticket_id: z.nullable(z.string()).optional(), contact_id: z.nullable(z.string()).optional(), user_id: z.nullable(z.string()).optional(), @@ -171,7 +278,7 @@ export const Comment$outboundSchema: z.ZodType = z .object({ name: z.nullable(z.string()), - status: z.nullable(z.string()).optional(), + status: z.nullable(Status$inboundSchema).optional(), description: z.nullable(z.string()), due_date: z .nullable( @@ -219,7 +326,7 @@ export const UnifiedTicketingTicketOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - type: z.nullable(z.string()).optional(), + type: z.nullable(Type$inboundSchema).optional(), parent_ticket: z.nullable(z.string()).optional(), collections: z.nullable(z.string()).optional(), tags: z.nullable(z.array(z.string())).optional(), @@ -231,7 +338,7 @@ export const UnifiedTicketingTicketOutput$inboundSchema: z.ZodType< .transform((v) => new Date(v)) ) .optional(), - priority: z.nullable(z.string()).optional(), + priority: z.nullable(Priority$inboundSchema).optional(), assigned_to: z.nullable(z.array(z.string())).optional(), comment: z.nullable(z.lazy(() => Comment$inboundSchema)).optional(), account_id: z.nullable(z.string()).optional(), @@ -307,15 +414,15 @@ export const UnifiedTicketingTicketOutput$outboundSchema: z.ZodType< > = z .object({ name: z.nullable(z.string()), - status: z.nullable(z.string()).optional(), + status: z.nullable(Status$outboundSchema).optional(), description: z.nullable(z.string()), dueDate: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - type: z.nullable(z.string()).optional(), + type: z.nullable(Type$outboundSchema).optional(), parentTicket: z.nullable(z.string()).optional(), collections: z.nullable(z.string()).optional(), tags: z.nullable(z.array(z.string())).optional(), completedAt: z.nullable(z.date().transform((v) => v.toISOString())).optional(), - priority: z.nullable(z.string()).optional(), + priority: z.nullable(Priority$outboundSchema).optional(), assignedTo: z.nullable(z.array(z.string())).optional(), comment: z.nullable(z.lazy(() => Comment$outboundSchema)).optional(), accountId: z.nullable(z.string()).optional(), diff --git a/src/models/components/unifiedticketinguseroutput.ts b/src/models/components/unifiedticketinguseroutput.ts index c81085ee..dcc9491c 100644 --- a/src/models/components/unifiedticketinguseroutput.ts +++ b/src/models/components/unifiedticketinguseroutput.ts @@ -25,7 +25,7 @@ export type UnifiedTicketingUserOutput = { /** * The custom field mappings of the user between the remote 3rd party & Panora */ - fieldMappings: { [k: string]: any } | null; + fieldMappings?: { [k: string]: any } | null | undefined; /** * The UUID of the user */ @@ -59,7 +59,7 @@ export const UnifiedTicketingUserOutput$inboundSchema: z.ZodType< email_address: z.nullable(z.string()), teams: z.nullable(z.array(z.string())).optional(), account_id: z.nullable(z.string()).optional(), - field_mappings: z.nullable(z.record(z.any())), + field_mappings: z.nullable(z.record(z.any())).optional(), id: z.nullable(z.string()).optional(), remote_id: z.nullable(z.string()).optional(), remote_data: z.nullable(z.record(z.any())).optional(), @@ -98,7 +98,7 @@ export type UnifiedTicketingUserOutput$Outbound = { email_address: string | null; teams?: Array | null | undefined; account_id?: string | null | undefined; - field_mappings: { [k: string]: any } | null; + field_mappings?: { [k: string]: any } | null | undefined; id?: string | null | undefined; remote_id?: string | null | undefined; remote_data?: { [k: string]: any } | null | undefined; @@ -117,7 +117,7 @@ export const UnifiedTicketingUserOutput$outboundSchema: z.ZodType< emailAddress: z.nullable(z.string()), teams: z.nullable(z.array(z.string())).optional(), accountId: z.nullable(z.string()).optional(), - fieldMappings: z.nullable(z.record(z.any())), + fieldMappings: z.nullable(z.record(z.any())).optional(), id: z.nullable(z.string()).optional(), remoteId: z.nullable(z.string()).optional(), remoteData: z.nullable(z.record(z.any())).optional(), diff --git a/src/models/components/webhookdto.ts b/src/models/components/webhookdto.ts index f69e9cda..aef85041 100644 --- a/src/models/components/webhookdto.ts +++ b/src/models/components/webhookdto.ts @@ -12,7 +12,7 @@ export type WebhookDto = { /** * The description of the webhook. */ - description?: string | null | undefined; + description: string | null; /** * The events that the webhook listen to. */ @@ -22,14 +22,14 @@ export type WebhookDto = { /** @internal */ export const WebhookDto$inboundSchema: z.ZodType = z.object({ url: z.nullable(z.string()), - description: z.nullable(z.string()).optional(), + description: z.nullable(z.string()), scope: z.nullable(z.array(z.string())), }); /** @internal */ export type WebhookDto$Outbound = { url: string | null; - description?: string | null | undefined; + description: string | null; scope: Array | null; }; @@ -37,7 +37,7 @@ export type WebhookDto$Outbound = { export const WebhookDto$outboundSchema: z.ZodType = z.object({ url: z.nullable(z.string()), - description: z.nullable(z.string()).optional(), + description: z.nullable(z.string()), scope: z.nullable(z.array(z.string())), }); diff --git a/src/models/components/webhookresponse.ts b/src/models/components/webhookresponse.ts index a00cff52..dcb78241 100644 --- a/src/models/components/webhookresponse.ts +++ b/src/models/components/webhookresponse.ts @@ -21,13 +21,13 @@ export type WebhookResponse = { /** * The secret of the webhook. */ - secret: string | null; + secret: string; /** * The status of the webhook. */ active: boolean | null; /** - * The created date of the webhook. + * The created date of the webhook. */ createdAt: Date | null; /** @@ -50,7 +50,7 @@ export const WebhookResponse$inboundSchema: z.ZodType | null; @@ -100,7 +100,7 @@ export const WebhookResponse$outboundSchema: z.ZodType< idWebhookEndpoint: z.nullable(z.string()), endpointDescription: z.nullable(z.string()), url: z.nullable(z.string()), - secret: z.nullable(z.string()), + secret: z.string(), active: z.nullable(z.boolean()), createdAt: z.nullable(z.date().transform((v) => v.toISOString())), scope: z.nullable(z.array(z.string())), diff --git a/src/models/operations/delete.ts b/src/models/operations/delete.ts index cd2bb02e..d5874f29 100644 --- a/src/models/operations/delete.ts +++ b/src/models/operations/delete.ts @@ -5,6 +5,9 @@ import * as z from "zod"; export type DeleteRequest = { + /** + * id of the webhook to delete. + */ id: string; }; diff --git a/src/models/operations/index.ts b/src/models/operations/index.ts index 72973799..9c5753b1 100644 --- a/src/models/operations/index.ts +++ b/src/models/operations/index.ts @@ -84,22 +84,22 @@ export * from "./listfilestoragefolder.js"; export * from "./listfilestoragegroup.js"; export * from "./listfilestorageusers.js"; export * from "./listhrisbankinfo.js"; -export * from "./listhrisbenefit.js"; -export * from "./listhriscompanys.js"; +export * from "./listhrisbenefits.js"; +export * from "./listhriscompanies.js"; export * from "./listhrisdependents.js"; -export * from "./listhrisemployee.js"; export * from "./listhrisemployeepayrollrun.js"; -export * from "./listhrisemployerbenefit.js"; -export * from "./listhrisemployment.js"; -export * from "./listhrisgroup.js"; -export * from "./listhrislocation.js"; -export * from "./listhrispaygroup.js"; +export * from "./listhrisemployees.js"; +export * from "./listhrisemployerbenefits.js"; +export * from "./listhrisemployments.js"; +export * from "./listhrisgroups.js"; +export * from "./listhrislocations.js"; +export * from "./listhrispaygroups.js"; export * from "./listhrispayrollruns.js"; -export * from "./listhristimeoffbalance.js"; +export * from "./listhristimeoffbalances.js"; export * from "./listhristimeoffs.js"; export * from "./listmarketingautomationaction.js"; -export * from "./listmarketingautomationautomation.js"; -export * from "./listmarketingautomationcampaign.js"; +export * from "./listmarketingautomationautomations.js"; +export * from "./listmarketingautomationcampaigns.js"; export * from "./listmarketingautomationcontacts.js"; export * from "./listmarketingautomationemails.js"; export * from "./listmarketingautomationevents.js"; @@ -169,6 +169,7 @@ export * from "./retrievefilestoragegroup.js"; export * from "./retrievefilestorageuser.js"; export * from "./retrievehrisbankinfo.js"; export * from "./retrievehrisbenefit.js"; +export * from "./retrievehriscompany.js"; export * from "./retrievehrisdependent.js"; export * from "./retrievehrisemployee.js"; export * from "./retrievehrisemployeepayrollrun.js"; @@ -177,6 +178,7 @@ export * from "./retrievehrisemployment.js"; export * from "./retrievehrisgroup.js"; export * from "./retrievehrislocation.js"; export * from "./retrievehrispaygroup.js"; +export * from "./retrievehrispayrollrun.js"; export * from "./retrievehristimeoff.js"; export * from "./retrievehristimeoffbalance.js"; export * from "./retrievelinkeduser.js"; diff --git a/src/models/operations/listaccountingaccounts.ts b/src/models/operations/listaccountingaccounts.ts index 4568a450..58f130cc 100644 --- a/src/models/operations/listaccountingaccounts.ts +++ b/src/models/operations/listaccountingaccounts.ts @@ -40,7 +40,7 @@ export const ListAccountingAccountsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingAccountsRequest$inboundSchema: z.ZodType< export type ListAccountingAccountsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingAccountsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingaddress.ts b/src/models/operations/listaccountingaddress.ts index aed27405..dd48bd94 100644 --- a/src/models/operations/listaccountingaddress.ts +++ b/src/models/operations/listaccountingaddress.ts @@ -40,7 +40,7 @@ export const ListAccountingAddressRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingAddressRequest$inboundSchema: z.ZodType< export type ListAccountingAddressRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingAddressRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingattachments.ts b/src/models/operations/listaccountingattachments.ts index 1eaffa3b..e83c6819 100644 --- a/src/models/operations/listaccountingattachments.ts +++ b/src/models/operations/listaccountingattachments.ts @@ -40,7 +40,7 @@ export const ListAccountingAttachmentsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingAttachmentsRequest$inboundSchema: z.ZodType< export type ListAccountingAttachmentsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingAttachmentsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingbalancesheets.ts b/src/models/operations/listaccountingbalancesheets.ts index cda2a072..b9dfae7b 100644 --- a/src/models/operations/listaccountingbalancesheets.ts +++ b/src/models/operations/listaccountingbalancesheets.ts @@ -40,7 +40,7 @@ export const ListAccountingBalanceSheetsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingBalanceSheetsRequest$inboundSchema: z.ZodType< export type ListAccountingBalanceSheetsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingBalanceSheetsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingcashflowstatement.ts b/src/models/operations/listaccountingcashflowstatement.ts index 1c06f342..3143eff5 100644 --- a/src/models/operations/listaccountingcashflowstatement.ts +++ b/src/models/operations/listaccountingcashflowstatement.ts @@ -40,7 +40,7 @@ export const ListAccountingCashflowStatementRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingCashflowStatementRequest$inboundSchema: z.ZodType< export type ListAccountingCashflowStatementRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingCashflowStatementRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingcompanyinfos.ts b/src/models/operations/listaccountingcompanyinfos.ts index 55d0ed18..35e79edd 100644 --- a/src/models/operations/listaccountingcompanyinfos.ts +++ b/src/models/operations/listaccountingcompanyinfos.ts @@ -40,7 +40,7 @@ export const ListAccountingCompanyInfosRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingCompanyInfosRequest$inboundSchema: z.ZodType< export type ListAccountingCompanyInfosRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingCompanyInfosRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingcontacts.ts b/src/models/operations/listaccountingcontacts.ts index 917244a4..2d441681 100644 --- a/src/models/operations/listaccountingcontacts.ts +++ b/src/models/operations/listaccountingcontacts.ts @@ -40,7 +40,7 @@ export const ListAccountingContactsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingContactsRequest$inboundSchema: z.ZodType< export type ListAccountingContactsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingContactsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingcreditnote.ts b/src/models/operations/listaccountingcreditnote.ts index cbc82d1e..bddb5186 100644 --- a/src/models/operations/listaccountingcreditnote.ts +++ b/src/models/operations/listaccountingcreditnote.ts @@ -40,7 +40,7 @@ export const ListAccountingCreditNoteRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingCreditNoteRequest$inboundSchema: z.ZodType< export type ListAccountingCreditNoteRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingCreditNoteRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingexpense.ts b/src/models/operations/listaccountingexpense.ts index 8fb72b71..e85d7149 100644 --- a/src/models/operations/listaccountingexpense.ts +++ b/src/models/operations/listaccountingexpense.ts @@ -40,7 +40,7 @@ export const ListAccountingExpenseRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingExpenseRequest$inboundSchema: z.ZodType< export type ListAccountingExpenseRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingExpenseRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingincomestatement.ts b/src/models/operations/listaccountingincomestatement.ts index 331dfe90..8f05069e 100644 --- a/src/models/operations/listaccountingincomestatement.ts +++ b/src/models/operations/listaccountingincomestatement.ts @@ -40,7 +40,7 @@ export const ListAccountingIncomeStatementRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingIncomeStatementRequest$inboundSchema: z.ZodType< export type ListAccountingIncomeStatementRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingIncomeStatementRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountinginvoice.ts b/src/models/operations/listaccountinginvoice.ts index 18e8167a..d8d39a1c 100644 --- a/src/models/operations/listaccountinginvoice.ts +++ b/src/models/operations/listaccountinginvoice.ts @@ -40,7 +40,7 @@ export const ListAccountingInvoiceRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingInvoiceRequest$inboundSchema: z.ZodType< export type ListAccountingInvoiceRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingInvoiceRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingitem.ts b/src/models/operations/listaccountingitem.ts index 8f72c807..fecc1472 100644 --- a/src/models/operations/listaccountingitem.ts +++ b/src/models/operations/listaccountingitem.ts @@ -40,7 +40,7 @@ export const ListAccountingItemRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingItemRequest$inboundSchema: z.ZodType< export type ListAccountingItemRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingItemRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingjournalentry.ts b/src/models/operations/listaccountingjournalentry.ts index 55dc67d1..5a734d07 100644 --- a/src/models/operations/listaccountingjournalentry.ts +++ b/src/models/operations/listaccountingjournalentry.ts @@ -40,7 +40,7 @@ export const ListAccountingJournalEntryRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingJournalEntryRequest$inboundSchema: z.ZodType< export type ListAccountingJournalEntryRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingJournalEntryRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingpayment.ts b/src/models/operations/listaccountingpayment.ts index ffdb1a77..b5df897a 100644 --- a/src/models/operations/listaccountingpayment.ts +++ b/src/models/operations/listaccountingpayment.ts @@ -40,7 +40,7 @@ export const ListAccountingPaymentRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingPaymentRequest$inboundSchema: z.ZodType< export type ListAccountingPaymentRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingPaymentRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingphonenumber.ts b/src/models/operations/listaccountingphonenumber.ts index f91f1aaf..cb82e1c4 100644 --- a/src/models/operations/listaccountingphonenumber.ts +++ b/src/models/operations/listaccountingphonenumber.ts @@ -40,7 +40,7 @@ export const ListAccountingPhonenumberRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingPhonenumberRequest$inboundSchema: z.ZodType< export type ListAccountingPhonenumberRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingPhonenumberRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingpurchaseorder.ts b/src/models/operations/listaccountingpurchaseorder.ts index 5919b399..8c00a004 100644 --- a/src/models/operations/listaccountingpurchaseorder.ts +++ b/src/models/operations/listaccountingpurchaseorder.ts @@ -40,7 +40,7 @@ export const ListAccountingPurchaseOrderRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingPurchaseOrderRequest$inboundSchema: z.ZodType< export type ListAccountingPurchaseOrderRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingPurchaseOrderRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingtaxrate.ts b/src/models/operations/listaccountingtaxrate.ts index a8769180..feadbc98 100644 --- a/src/models/operations/listaccountingtaxrate.ts +++ b/src/models/operations/listaccountingtaxrate.ts @@ -40,7 +40,7 @@ export const ListAccountingTaxRateRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingTaxRateRequest$inboundSchema: z.ZodType< export type ListAccountingTaxRateRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingTaxRateRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingtrackingcategorys.ts b/src/models/operations/listaccountingtrackingcategorys.ts index e12de722..23f0e79a 100644 --- a/src/models/operations/listaccountingtrackingcategorys.ts +++ b/src/models/operations/listaccountingtrackingcategorys.ts @@ -40,7 +40,7 @@ export const ListAccountingTrackingCategorysRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingTrackingCategorysRequest$inboundSchema: z.ZodType< export type ListAccountingTrackingCategorysRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingTrackingCategorysRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingtransaction.ts b/src/models/operations/listaccountingtransaction.ts index 0445e78d..57078a25 100644 --- a/src/models/operations/listaccountingtransaction.ts +++ b/src/models/operations/listaccountingtransaction.ts @@ -40,7 +40,7 @@ export const ListAccountingTransactionRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingTransactionRequest$inboundSchema: z.ZodType< export type ListAccountingTransactionRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingTransactionRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listaccountingvendorcredit.ts b/src/models/operations/listaccountingvendorcredit.ts index e5a8d338..477ac77a 100644 --- a/src/models/operations/listaccountingvendorcredit.ts +++ b/src/models/operations/listaccountingvendorcredit.ts @@ -40,7 +40,7 @@ export const ListAccountingVendorCreditRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAccountingVendorCreditRequest$inboundSchema: z.ZodType< export type ListAccountingVendorCreditRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAccountingVendorCreditRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsactivity.ts b/src/models/operations/listatsactivity.ts index bbbcfd9a..6881f367 100644 --- a/src/models/operations/listatsactivity.ts +++ b/src/models/operations/listatsactivity.ts @@ -40,7 +40,7 @@ export const ListAtsActivityRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsActivityRequest$inboundSchema: z.ZodType< export type ListAtsActivityRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsActivityRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsapplication.ts b/src/models/operations/listatsapplication.ts index 1d8210be..0ad9f406 100644 --- a/src/models/operations/listatsapplication.ts +++ b/src/models/operations/listatsapplication.ts @@ -40,7 +40,7 @@ export const ListAtsApplicationRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsApplicationRequest$inboundSchema: z.ZodType< export type ListAtsApplicationRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsApplicationRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsattachment.ts b/src/models/operations/listatsattachment.ts index da587aab..aa1769e7 100644 --- a/src/models/operations/listatsattachment.ts +++ b/src/models/operations/listatsattachment.ts @@ -40,7 +40,7 @@ export const ListAtsAttachmentRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsAttachmentRequest$inboundSchema: z.ZodType< export type ListAtsAttachmentRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsAttachmentRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatscandidate.ts b/src/models/operations/listatscandidate.ts index a6ba858d..d92b4097 100644 --- a/src/models/operations/listatscandidate.ts +++ b/src/models/operations/listatscandidate.ts @@ -40,7 +40,7 @@ export const ListAtsCandidateRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsCandidateRequest$inboundSchema: z.ZodType< export type ListAtsCandidateRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsCandidateRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsdepartments.ts b/src/models/operations/listatsdepartments.ts index 9110b0cb..ef4292f7 100644 --- a/src/models/operations/listatsdepartments.ts +++ b/src/models/operations/listatsdepartments.ts @@ -40,7 +40,7 @@ export const ListAtsDepartmentsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsDepartmentsRequest$inboundSchema: z.ZodType< export type ListAtsDepartmentsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsDepartmentsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatseeocs.ts b/src/models/operations/listatseeocs.ts index 81df9a65..f82a0240 100644 --- a/src/models/operations/listatseeocs.ts +++ b/src/models/operations/listatseeocs.ts @@ -40,7 +40,7 @@ export const ListAtsEeocsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsEeocsRequest$inboundSchema: z.ZodType< export type ListAtsEeocsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsEeocsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsinterview.ts b/src/models/operations/listatsinterview.ts index 6792aea4..331f98af 100644 --- a/src/models/operations/listatsinterview.ts +++ b/src/models/operations/listatsinterview.ts @@ -40,7 +40,7 @@ export const ListAtsInterviewRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsInterviewRequest$inboundSchema: z.ZodType< export type ListAtsInterviewRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsInterviewRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsjob.ts b/src/models/operations/listatsjob.ts index 617b7740..ce6ef72e 100644 --- a/src/models/operations/listatsjob.ts +++ b/src/models/operations/listatsjob.ts @@ -37,7 +37,7 @@ export const ListAtsJobRequest$inboundSchema: z.ZodType { @@ -51,7 +51,7 @@ export const ListAtsJobRequest$inboundSchema: z.ZodType { diff --git a/src/models/operations/listatsjobinterviewstage.ts b/src/models/operations/listatsjobinterviewstage.ts index ae8390b6..a0d17896 100644 --- a/src/models/operations/listatsjobinterviewstage.ts +++ b/src/models/operations/listatsjobinterviewstage.ts @@ -40,7 +40,7 @@ export const ListAtsJobInterviewStageRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsJobInterviewStageRequest$inboundSchema: z.ZodType< export type ListAtsJobInterviewStageRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsJobInterviewStageRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsoffer.ts b/src/models/operations/listatsoffer.ts index bf6d97cd..298c78af 100644 --- a/src/models/operations/listatsoffer.ts +++ b/src/models/operations/listatsoffer.ts @@ -40,7 +40,7 @@ export const ListAtsOfferRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsOfferRequest$inboundSchema: z.ZodType< export type ListAtsOfferRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsOfferRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsoffice.ts b/src/models/operations/listatsoffice.ts index 6221f8b5..3f740a96 100644 --- a/src/models/operations/listatsoffice.ts +++ b/src/models/operations/listatsoffice.ts @@ -40,7 +40,7 @@ export const ListAtsOfficeRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsOfficeRequest$inboundSchema: z.ZodType< export type ListAtsOfficeRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsOfficeRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsrejectreasons.ts b/src/models/operations/listatsrejectreasons.ts index 49a89f8c..d28899e4 100644 --- a/src/models/operations/listatsrejectreasons.ts +++ b/src/models/operations/listatsrejectreasons.ts @@ -40,7 +40,7 @@ export const ListAtsRejectReasonsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsRejectReasonsRequest$inboundSchema: z.ZodType< export type ListAtsRejectReasonsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsRejectReasonsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsscorecard.ts b/src/models/operations/listatsscorecard.ts index 8375c6c0..7761017f 100644 --- a/src/models/operations/listatsscorecard.ts +++ b/src/models/operations/listatsscorecard.ts @@ -40,7 +40,7 @@ export const ListAtsScorecardRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsScorecardRequest$inboundSchema: z.ZodType< export type ListAtsScorecardRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsScorecardRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatstags.ts b/src/models/operations/listatstags.ts index 3201c4fc..198615a3 100644 --- a/src/models/operations/listatstags.ts +++ b/src/models/operations/listatstags.ts @@ -40,7 +40,7 @@ export const ListAtsTagsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsTagsRequest$inboundSchema: z.ZodType< export type ListAtsTagsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsTagsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listatsusers.ts b/src/models/operations/listatsusers.ts index 021b81e5..2caa266c 100644 --- a/src/models/operations/listatsusers.ts +++ b/src/models/operations/listatsusers.ts @@ -40,7 +40,7 @@ export const ListAtsUsersRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListAtsUsersRequest$inboundSchema: z.ZodType< export type ListAtsUsersRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListAtsUsersRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmcompany.ts b/src/models/operations/listcrmcompany.ts index d3277800..eccdc3ac 100644 --- a/src/models/operations/listcrmcompany.ts +++ b/src/models/operations/listcrmcompany.ts @@ -40,7 +40,7 @@ export const ListCrmCompanyRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmCompanyRequest$inboundSchema: z.ZodType< export type ListCrmCompanyRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmCompanyRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmcontacts.ts b/src/models/operations/listcrmcontacts.ts index e3f19820..3a4a0563 100644 --- a/src/models/operations/listcrmcontacts.ts +++ b/src/models/operations/listcrmcontacts.ts @@ -40,7 +40,7 @@ export const ListCrmContactsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmContactsRequest$inboundSchema: z.ZodType< export type ListCrmContactsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmContactsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmdeals.ts b/src/models/operations/listcrmdeals.ts index 51113a02..92b7aba9 100644 --- a/src/models/operations/listcrmdeals.ts +++ b/src/models/operations/listcrmdeals.ts @@ -40,7 +40,7 @@ export const ListCrmDealsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmDealsRequest$inboundSchema: z.ZodType< export type ListCrmDealsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmDealsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmengagements.ts b/src/models/operations/listcrmengagements.ts index 90329e89..89c2fae0 100644 --- a/src/models/operations/listcrmengagements.ts +++ b/src/models/operations/listcrmengagements.ts @@ -40,7 +40,7 @@ export const ListCrmEngagementsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmEngagementsRequest$inboundSchema: z.ZodType< export type ListCrmEngagementsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmEngagementsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmnote.ts b/src/models/operations/listcrmnote.ts index ba25e440..8f7ec43e 100644 --- a/src/models/operations/listcrmnote.ts +++ b/src/models/operations/listcrmnote.ts @@ -40,7 +40,7 @@ export const ListCrmNoteRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmNoteRequest$inboundSchema: z.ZodType< export type ListCrmNoteRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmNoteRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmstages.ts b/src/models/operations/listcrmstages.ts index f9cf9e11..1da00a37 100644 --- a/src/models/operations/listcrmstages.ts +++ b/src/models/operations/listcrmstages.ts @@ -40,7 +40,7 @@ export const ListCrmStagesRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmStagesRequest$inboundSchema: z.ZodType< export type ListCrmStagesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmStagesRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmtask.ts b/src/models/operations/listcrmtask.ts index 33a83dcb..eab4630b 100644 --- a/src/models/operations/listcrmtask.ts +++ b/src/models/operations/listcrmtask.ts @@ -40,7 +40,7 @@ export const ListCrmTaskRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmTaskRequest$inboundSchema: z.ZodType< export type ListCrmTaskRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmTaskRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listcrmusers.ts b/src/models/operations/listcrmusers.ts index ea4561d2..fc714f67 100644 --- a/src/models/operations/listcrmusers.ts +++ b/src/models/operations/listcrmusers.ts @@ -40,7 +40,7 @@ export const ListCrmUsersRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListCrmUsersRequest$inboundSchema: z.ZodType< export type ListCrmUsersRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListCrmUsersRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listfilestoragedrives.ts b/src/models/operations/listfilestoragedrives.ts index a8d66bf9..97eac0ba 100644 --- a/src/models/operations/listfilestoragedrives.ts +++ b/src/models/operations/listfilestoragedrives.ts @@ -40,7 +40,7 @@ export const ListFilestorageDrivesRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListFilestorageDrivesRequest$inboundSchema: z.ZodType< export type ListFilestorageDrivesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListFilestorageDrivesRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listfilestoragefile.ts b/src/models/operations/listfilestoragefile.ts index 047b7269..24894db7 100644 --- a/src/models/operations/listfilestoragefile.ts +++ b/src/models/operations/listfilestoragefile.ts @@ -40,7 +40,7 @@ export const ListFilestorageFileRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListFilestorageFileRequest$inboundSchema: z.ZodType< export type ListFilestorageFileRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListFilestorageFileRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listfilestoragefolder.ts b/src/models/operations/listfilestoragefolder.ts index 4e4b252e..5d1479f4 100644 --- a/src/models/operations/listfilestoragefolder.ts +++ b/src/models/operations/listfilestoragefolder.ts @@ -40,7 +40,7 @@ export const ListFilestorageFolderRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListFilestorageFolderRequest$inboundSchema: z.ZodType< export type ListFilestorageFolderRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListFilestorageFolderRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listfilestoragegroup.ts b/src/models/operations/listfilestoragegroup.ts index 7597acd1..a7e1d5ae 100644 --- a/src/models/operations/listfilestoragegroup.ts +++ b/src/models/operations/listfilestoragegroup.ts @@ -40,7 +40,7 @@ export const ListFilestorageGroupRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListFilestorageGroupRequest$inboundSchema: z.ZodType< export type ListFilestorageGroupRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListFilestorageGroupRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listfilestorageusers.ts b/src/models/operations/listfilestorageusers.ts index 10865cb5..017850ef 100644 --- a/src/models/operations/listfilestorageusers.ts +++ b/src/models/operations/listfilestorageusers.ts @@ -28,7 +28,7 @@ export type ListFilestorageUsersRequest = { export type ListFilestorageUsersResponseBody = { prevCursor: string | null; nextCursor: string | null; - data: Array; + data: Array; }; /** @internal */ @@ -40,7 +40,7 @@ export const ListFilestorageUsersRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListFilestorageUsersRequest$inboundSchema: z.ZodType< export type ListFilestorageUsersRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListFilestorageUsersRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -99,7 +99,7 @@ export const ListFilestorageUsersResponseBody$inboundSchema: z.ZodType< .object({ prev_cursor: z.nullable(z.string()), next_cursor: z.nullable(z.string()), - data: z.array(components.UnifiedUserOutput$inboundSchema), + data: z.array(components.UnifiedFilestorageUserOutput$inboundSchema), }) .transform((v) => { return remap$(v, { @@ -112,7 +112,7 @@ export const ListFilestorageUsersResponseBody$inboundSchema: z.ZodType< export type ListFilestorageUsersResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; - data: Array; + data: Array; }; /** @internal */ @@ -124,7 +124,7 @@ export const ListFilestorageUsersResponseBody$outboundSchema: z.ZodType< .object({ prevCursor: z.nullable(z.string()), nextCursor: z.nullable(z.string()), - data: z.array(components.UnifiedUserOutput$outboundSchema), + data: z.array(components.UnifiedFilestorageUserOutput$outboundSchema), }) .transform((v) => { return remap$(v, { diff --git a/src/models/operations/listhrisbankinfo.ts b/src/models/operations/listhrisbankinfo.ts index ac2d0669..62d5f975 100644 --- a/src/models/operations/listhrisbankinfo.ts +++ b/src/models/operations/listhrisbankinfo.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisBankinfoRequest = { +export type ListHrisBankInfoRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisBankinfoRequest = { cursor?: string | undefined; }; -export type ListHrisBankinfoResponseBody = { +export type ListHrisBankInfoResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisBankinfoRequest$inboundSchema: z.ZodType< - ListHrisBankinfoRequest, +export const ListHrisBankInfoRequest$inboundSchema: z.ZodType< + ListHrisBankInfoRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisBankinfoRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisBankinfoRequest$Outbound = { +export type ListHrisBankInfoRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisBankinfoRequest$outboundSchema: z.ZodType< - ListHrisBankinfoRequest$Outbound, +export const ListHrisBankInfoRequest$outboundSchema: z.ZodType< + ListHrisBankInfoRequest$Outbound, z.ZodTypeDef, - ListHrisBankinfoRequest + ListHrisBankInfoRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisBankinfoRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisBankinfoRequest$ { - /** @deprecated use `ListHrisBankinfoRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisBankinfoRequest$inboundSchema; - /** @deprecated use `ListHrisBankinfoRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisBankinfoRequest$outboundSchema; - /** @deprecated use `ListHrisBankinfoRequest$Outbound` instead. */ - export type Outbound = ListHrisBankinfoRequest$Outbound; +export namespace ListHrisBankInfoRequest$ { + /** @deprecated use `ListHrisBankInfoRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisBankInfoRequest$inboundSchema; + /** @deprecated use `ListHrisBankInfoRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisBankInfoRequest$outboundSchema; + /** @deprecated use `ListHrisBankInfoRequest$Outbound` instead. */ + export type Outbound = ListHrisBankInfoRequest$Outbound; } /** @internal */ -export const ListHrisBankinfoResponseBody$inboundSchema: z.ZodType< - ListHrisBankinfoResponseBody, +export const ListHrisBankInfoResponseBody$inboundSchema: z.ZodType< + ListHrisBankInfoResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisBankinfoResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisBankinfoResponseBody$Outbound = { +export type ListHrisBankInfoResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisBankinfoResponseBody$outboundSchema: z.ZodType< - ListHrisBankinfoResponseBody$Outbound, +export const ListHrisBankInfoResponseBody$outboundSchema: z.ZodType< + ListHrisBankInfoResponseBody$Outbound, z.ZodTypeDef, - ListHrisBankinfoResponseBody + ListHrisBankInfoResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisBankinfoResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisBankinfoResponseBody$ { - /** @deprecated use `ListHrisBankinfoResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisBankinfoResponseBody$inboundSchema; - /** @deprecated use `ListHrisBankinfoResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisBankinfoResponseBody$outboundSchema; - /** @deprecated use `ListHrisBankinfoResponseBody$Outbound` instead. */ - export type Outbound = ListHrisBankinfoResponseBody$Outbound; +export namespace ListHrisBankInfoResponseBody$ { + /** @deprecated use `ListHrisBankInfoResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisBankInfoResponseBody$inboundSchema; + /** @deprecated use `ListHrisBankInfoResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisBankInfoResponseBody$outboundSchema; + /** @deprecated use `ListHrisBankInfoResponseBody$Outbound` instead. */ + export type Outbound = ListHrisBankInfoResponseBody$Outbound; } diff --git a/src/models/operations/listhrisbenefit.ts b/src/models/operations/listhrisbenefits.ts similarity index 62% rename from src/models/operations/listhrisbenefit.ts rename to src/models/operations/listhrisbenefits.ts index 6a84bfad..6e95de70 100644 --- a/src/models/operations/listhrisbenefit.ts +++ b/src/models/operations/listhrisbenefits.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisBenefitRequest = { +export type ListHrisBenefitsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisBenefitRequest = { cursor?: string | undefined; }; -export type ListHrisBenefitResponseBody = { +export type ListHrisBenefitsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisBenefitRequest$inboundSchema: z.ZodType< - ListHrisBenefitRequest, +export const ListHrisBenefitsRequest$inboundSchema: z.ZodType< + ListHrisBenefitsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisBenefitRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisBenefitRequest$Outbound = { +export type ListHrisBenefitsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisBenefitRequest$outboundSchema: z.ZodType< - ListHrisBenefitRequest$Outbound, +export const ListHrisBenefitsRequest$outboundSchema: z.ZodType< + ListHrisBenefitsRequest$Outbound, z.ZodTypeDef, - ListHrisBenefitRequest + ListHrisBenefitsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisBenefitRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisBenefitRequest$ { - /** @deprecated use `ListHrisBenefitRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisBenefitRequest$inboundSchema; - /** @deprecated use `ListHrisBenefitRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisBenefitRequest$outboundSchema; - /** @deprecated use `ListHrisBenefitRequest$Outbound` instead. */ - export type Outbound = ListHrisBenefitRequest$Outbound; +export namespace ListHrisBenefitsRequest$ { + /** @deprecated use `ListHrisBenefitsRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisBenefitsRequest$inboundSchema; + /** @deprecated use `ListHrisBenefitsRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisBenefitsRequest$outboundSchema; + /** @deprecated use `ListHrisBenefitsRequest$Outbound` instead. */ + export type Outbound = ListHrisBenefitsRequest$Outbound; } /** @internal */ -export const ListHrisBenefitResponseBody$inboundSchema: z.ZodType< - ListHrisBenefitResponseBody, +export const ListHrisBenefitsResponseBody$inboundSchema: z.ZodType< + ListHrisBenefitsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisBenefitResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisBenefitResponseBody$Outbound = { +export type ListHrisBenefitsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisBenefitResponseBody$outboundSchema: z.ZodType< - ListHrisBenefitResponseBody$Outbound, +export const ListHrisBenefitsResponseBody$outboundSchema: z.ZodType< + ListHrisBenefitsResponseBody$Outbound, z.ZodTypeDef, - ListHrisBenefitResponseBody + ListHrisBenefitsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisBenefitResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisBenefitResponseBody$ { - /** @deprecated use `ListHrisBenefitResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisBenefitResponseBody$inboundSchema; - /** @deprecated use `ListHrisBenefitResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisBenefitResponseBody$outboundSchema; - /** @deprecated use `ListHrisBenefitResponseBody$Outbound` instead. */ - export type Outbound = ListHrisBenefitResponseBody$Outbound; +export namespace ListHrisBenefitsResponseBody$ { + /** @deprecated use `ListHrisBenefitsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisBenefitsResponseBody$inboundSchema; + /** @deprecated use `ListHrisBenefitsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisBenefitsResponseBody$outboundSchema; + /** @deprecated use `ListHrisBenefitsResponseBody$Outbound` instead. */ + export type Outbound = ListHrisBenefitsResponseBody$Outbound; } diff --git a/src/models/operations/listhriscompanys.ts b/src/models/operations/listhriscompanies.ts similarity index 61% rename from src/models/operations/listhriscompanys.ts rename to src/models/operations/listhriscompanies.ts index 48812b3f..ae7dd8db 100644 --- a/src/models/operations/listhriscompanys.ts +++ b/src/models/operations/listhriscompanies.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisCompanysRequest = { +export type ListHrisCompaniesRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisCompanysRequest = { cursor?: string | undefined; }; -export type ListHrisCompanysResponseBody = { +export type ListHrisCompaniesResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisCompanysRequest$inboundSchema: z.ZodType< - ListHrisCompanysRequest, +export const ListHrisCompaniesRequest$inboundSchema: z.ZodType< + ListHrisCompaniesRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisCompanysRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisCompanysRequest$Outbound = { +export type ListHrisCompaniesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisCompanysRequest$outboundSchema: z.ZodType< - ListHrisCompanysRequest$Outbound, +export const ListHrisCompaniesRequest$outboundSchema: z.ZodType< + ListHrisCompaniesRequest$Outbound, z.ZodTypeDef, - ListHrisCompanysRequest + ListHrisCompaniesRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisCompanysRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisCompanysRequest$ { - /** @deprecated use `ListHrisCompanysRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisCompanysRequest$inboundSchema; - /** @deprecated use `ListHrisCompanysRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisCompanysRequest$outboundSchema; - /** @deprecated use `ListHrisCompanysRequest$Outbound` instead. */ - export type Outbound = ListHrisCompanysRequest$Outbound; +export namespace ListHrisCompaniesRequest$ { + /** @deprecated use `ListHrisCompaniesRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisCompaniesRequest$inboundSchema; + /** @deprecated use `ListHrisCompaniesRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisCompaniesRequest$outboundSchema; + /** @deprecated use `ListHrisCompaniesRequest$Outbound` instead. */ + export type Outbound = ListHrisCompaniesRequest$Outbound; } /** @internal */ -export const ListHrisCompanysResponseBody$inboundSchema: z.ZodType< - ListHrisCompanysResponseBody, +export const ListHrisCompaniesResponseBody$inboundSchema: z.ZodType< + ListHrisCompaniesResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisCompanysResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisCompanysResponseBody$Outbound = { +export type ListHrisCompaniesResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisCompanysResponseBody$outboundSchema: z.ZodType< - ListHrisCompanysResponseBody$Outbound, +export const ListHrisCompaniesResponseBody$outboundSchema: z.ZodType< + ListHrisCompaniesResponseBody$Outbound, z.ZodTypeDef, - ListHrisCompanysResponseBody + ListHrisCompaniesResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisCompanysResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisCompanysResponseBody$ { - /** @deprecated use `ListHrisCompanysResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisCompanysResponseBody$inboundSchema; - /** @deprecated use `ListHrisCompanysResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisCompanysResponseBody$outboundSchema; - /** @deprecated use `ListHrisCompanysResponseBody$Outbound` instead. */ - export type Outbound = ListHrisCompanysResponseBody$Outbound; +export namespace ListHrisCompaniesResponseBody$ { + /** @deprecated use `ListHrisCompaniesResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisCompaniesResponseBody$inboundSchema; + /** @deprecated use `ListHrisCompaniesResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisCompaniesResponseBody$outboundSchema; + /** @deprecated use `ListHrisCompaniesResponseBody$Outbound` instead. */ + export type Outbound = ListHrisCompaniesResponseBody$Outbound; } diff --git a/src/models/operations/listhrisdependents.ts b/src/models/operations/listhrisdependents.ts index 4ca41b70..6a8618c4 100644 --- a/src/models/operations/listhrisdependents.ts +++ b/src/models/operations/listhrisdependents.ts @@ -40,7 +40,7 @@ export const ListHrisDependentsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListHrisDependentsRequest$inboundSchema: z.ZodType< export type ListHrisDependentsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListHrisDependentsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listhrisemployeepayrollrun.ts b/src/models/operations/listhrisemployeepayrollrun.ts index f2ef77fc..d6a29741 100644 --- a/src/models/operations/listhrisemployeepayrollrun.ts +++ b/src/models/operations/listhrisemployeepayrollrun.ts @@ -40,7 +40,7 @@ export const ListHrisEmployeePayrollRunRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListHrisEmployeePayrollRunRequest$inboundSchema: z.ZodType< export type ListHrisEmployeePayrollRunRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListHrisEmployeePayrollRunRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listhrisemployee.ts b/src/models/operations/listhrisemployees.ts similarity index 61% rename from src/models/operations/listhrisemployee.ts rename to src/models/operations/listhrisemployees.ts index 1550d0f4..ce23c250 100644 --- a/src/models/operations/listhrisemployee.ts +++ b/src/models/operations/listhrisemployees.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisEmployeeRequest = { +export type ListHrisEmployeesRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisEmployeeRequest = { cursor?: string | undefined; }; -export type ListHrisEmployeeResponseBody = { +export type ListHrisEmployeesResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisEmployeeRequest$inboundSchema: z.ZodType< - ListHrisEmployeeRequest, +export const ListHrisEmployeesRequest$inboundSchema: z.ZodType< + ListHrisEmployeesRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisEmployeeRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisEmployeeRequest$Outbound = { +export type ListHrisEmployeesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisEmployeeRequest$outboundSchema: z.ZodType< - ListHrisEmployeeRequest$Outbound, +export const ListHrisEmployeesRequest$outboundSchema: z.ZodType< + ListHrisEmployeesRequest$Outbound, z.ZodTypeDef, - ListHrisEmployeeRequest + ListHrisEmployeesRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisEmployeeRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisEmployeeRequest$ { - /** @deprecated use `ListHrisEmployeeRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisEmployeeRequest$inboundSchema; - /** @deprecated use `ListHrisEmployeeRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisEmployeeRequest$outboundSchema; - /** @deprecated use `ListHrisEmployeeRequest$Outbound` instead. */ - export type Outbound = ListHrisEmployeeRequest$Outbound; +export namespace ListHrisEmployeesRequest$ { + /** @deprecated use `ListHrisEmployeesRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisEmployeesRequest$inboundSchema; + /** @deprecated use `ListHrisEmployeesRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisEmployeesRequest$outboundSchema; + /** @deprecated use `ListHrisEmployeesRequest$Outbound` instead. */ + export type Outbound = ListHrisEmployeesRequest$Outbound; } /** @internal */ -export const ListHrisEmployeeResponseBody$inboundSchema: z.ZodType< - ListHrisEmployeeResponseBody, +export const ListHrisEmployeesResponseBody$inboundSchema: z.ZodType< + ListHrisEmployeesResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisEmployeeResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisEmployeeResponseBody$Outbound = { +export type ListHrisEmployeesResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisEmployeeResponseBody$outboundSchema: z.ZodType< - ListHrisEmployeeResponseBody$Outbound, +export const ListHrisEmployeesResponseBody$outboundSchema: z.ZodType< + ListHrisEmployeesResponseBody$Outbound, z.ZodTypeDef, - ListHrisEmployeeResponseBody + ListHrisEmployeesResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisEmployeeResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisEmployeeResponseBody$ { - /** @deprecated use `ListHrisEmployeeResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisEmployeeResponseBody$inboundSchema; - /** @deprecated use `ListHrisEmployeeResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisEmployeeResponseBody$outboundSchema; - /** @deprecated use `ListHrisEmployeeResponseBody$Outbound` instead. */ - export type Outbound = ListHrisEmployeeResponseBody$Outbound; +export namespace ListHrisEmployeesResponseBody$ { + /** @deprecated use `ListHrisEmployeesResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisEmployeesResponseBody$inboundSchema; + /** @deprecated use `ListHrisEmployeesResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisEmployeesResponseBody$outboundSchema; + /** @deprecated use `ListHrisEmployeesResponseBody$Outbound` instead. */ + export type Outbound = ListHrisEmployeesResponseBody$Outbound; } diff --git a/src/models/operations/listhrisemployerbenefit.ts b/src/models/operations/listhrisemployerbenefits.ts similarity index 60% rename from src/models/operations/listhrisemployerbenefit.ts rename to src/models/operations/listhrisemployerbenefits.ts index d368bf4f..f5219de1 100644 --- a/src/models/operations/listhrisemployerbenefit.ts +++ b/src/models/operations/listhrisemployerbenefits.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisEmployerBenefitRequest = { +export type ListHrisEmployerBenefitsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisEmployerBenefitRequest = { cursor?: string | undefined; }; -export type ListHrisEmployerBenefitResponseBody = { +export type ListHrisEmployerBenefitsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisEmployerBenefitRequest$inboundSchema: z.ZodType< - ListHrisEmployerBenefitRequest, +export const ListHrisEmployerBenefitsRequest$inboundSchema: z.ZodType< + ListHrisEmployerBenefitsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisEmployerBenefitRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisEmployerBenefitRequest$Outbound = { +export type ListHrisEmployerBenefitsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisEmployerBenefitRequest$outboundSchema: z.ZodType< - ListHrisEmployerBenefitRequest$Outbound, +export const ListHrisEmployerBenefitsRequest$outboundSchema: z.ZodType< + ListHrisEmployerBenefitsRequest$Outbound, z.ZodTypeDef, - ListHrisEmployerBenefitRequest + ListHrisEmployerBenefitsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisEmployerBenefitRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisEmployerBenefitRequest$ { - /** @deprecated use `ListHrisEmployerBenefitRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisEmployerBenefitRequest$inboundSchema; - /** @deprecated use `ListHrisEmployerBenefitRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisEmployerBenefitRequest$outboundSchema; - /** @deprecated use `ListHrisEmployerBenefitRequest$Outbound` instead. */ - export type Outbound = ListHrisEmployerBenefitRequest$Outbound; +export namespace ListHrisEmployerBenefitsRequest$ { + /** @deprecated use `ListHrisEmployerBenefitsRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisEmployerBenefitsRequest$inboundSchema; + /** @deprecated use `ListHrisEmployerBenefitsRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisEmployerBenefitsRequest$outboundSchema; + /** @deprecated use `ListHrisEmployerBenefitsRequest$Outbound` instead. */ + export type Outbound = ListHrisEmployerBenefitsRequest$Outbound; } /** @internal */ -export const ListHrisEmployerBenefitResponseBody$inboundSchema: z.ZodType< - ListHrisEmployerBenefitResponseBody, +export const ListHrisEmployerBenefitsResponseBody$inboundSchema: z.ZodType< + ListHrisEmployerBenefitsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisEmployerBenefitResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisEmployerBenefitResponseBody$Outbound = { +export type ListHrisEmployerBenefitsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisEmployerBenefitResponseBody$outboundSchema: z.ZodType< - ListHrisEmployerBenefitResponseBody$Outbound, +export const ListHrisEmployerBenefitsResponseBody$outboundSchema: z.ZodType< + ListHrisEmployerBenefitsResponseBody$Outbound, z.ZodTypeDef, - ListHrisEmployerBenefitResponseBody + ListHrisEmployerBenefitsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisEmployerBenefitResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisEmployerBenefitResponseBody$ { - /** @deprecated use `ListHrisEmployerBenefitResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisEmployerBenefitResponseBody$inboundSchema; - /** @deprecated use `ListHrisEmployerBenefitResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisEmployerBenefitResponseBody$outboundSchema; - /** @deprecated use `ListHrisEmployerBenefitResponseBody$Outbound` instead. */ - export type Outbound = ListHrisEmployerBenefitResponseBody$Outbound; +export namespace ListHrisEmployerBenefitsResponseBody$ { + /** @deprecated use `ListHrisEmployerBenefitsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisEmployerBenefitsResponseBody$inboundSchema; + /** @deprecated use `ListHrisEmployerBenefitsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisEmployerBenefitsResponseBody$outboundSchema; + /** @deprecated use `ListHrisEmployerBenefitsResponseBody$Outbound` instead. */ + export type Outbound = ListHrisEmployerBenefitsResponseBody$Outbound; } diff --git a/src/models/operations/listhrisemployment.ts b/src/models/operations/listhrisemployments.ts similarity index 61% rename from src/models/operations/listhrisemployment.ts rename to src/models/operations/listhrisemployments.ts index fa6016ad..780e0953 100644 --- a/src/models/operations/listhrisemployment.ts +++ b/src/models/operations/listhrisemployments.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisEmploymentRequest = { +export type ListHrisEmploymentsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisEmploymentRequest = { cursor?: string | undefined; }; -export type ListHrisEmploymentResponseBody = { +export type ListHrisEmploymentsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisEmploymentRequest$inboundSchema: z.ZodType< - ListHrisEmploymentRequest, +export const ListHrisEmploymentsRequest$inboundSchema: z.ZodType< + ListHrisEmploymentsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisEmploymentRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisEmploymentRequest$Outbound = { +export type ListHrisEmploymentsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisEmploymentRequest$outboundSchema: z.ZodType< - ListHrisEmploymentRequest$Outbound, +export const ListHrisEmploymentsRequest$outboundSchema: z.ZodType< + ListHrisEmploymentsRequest$Outbound, z.ZodTypeDef, - ListHrisEmploymentRequest + ListHrisEmploymentsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisEmploymentRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisEmploymentRequest$ { - /** @deprecated use `ListHrisEmploymentRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisEmploymentRequest$inboundSchema; - /** @deprecated use `ListHrisEmploymentRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisEmploymentRequest$outboundSchema; - /** @deprecated use `ListHrisEmploymentRequest$Outbound` instead. */ - export type Outbound = ListHrisEmploymentRequest$Outbound; +export namespace ListHrisEmploymentsRequest$ { + /** @deprecated use `ListHrisEmploymentsRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisEmploymentsRequest$inboundSchema; + /** @deprecated use `ListHrisEmploymentsRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisEmploymentsRequest$outboundSchema; + /** @deprecated use `ListHrisEmploymentsRequest$Outbound` instead. */ + export type Outbound = ListHrisEmploymentsRequest$Outbound; } /** @internal */ -export const ListHrisEmploymentResponseBody$inboundSchema: z.ZodType< - ListHrisEmploymentResponseBody, +export const ListHrisEmploymentsResponseBody$inboundSchema: z.ZodType< + ListHrisEmploymentsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisEmploymentResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisEmploymentResponseBody$Outbound = { +export type ListHrisEmploymentsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisEmploymentResponseBody$outboundSchema: z.ZodType< - ListHrisEmploymentResponseBody$Outbound, +export const ListHrisEmploymentsResponseBody$outboundSchema: z.ZodType< + ListHrisEmploymentsResponseBody$Outbound, z.ZodTypeDef, - ListHrisEmploymentResponseBody + ListHrisEmploymentsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisEmploymentResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisEmploymentResponseBody$ { - /** @deprecated use `ListHrisEmploymentResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisEmploymentResponseBody$inboundSchema; - /** @deprecated use `ListHrisEmploymentResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisEmploymentResponseBody$outboundSchema; - /** @deprecated use `ListHrisEmploymentResponseBody$Outbound` instead. */ - export type Outbound = ListHrisEmploymentResponseBody$Outbound; +export namespace ListHrisEmploymentsResponseBody$ { + /** @deprecated use `ListHrisEmploymentsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisEmploymentsResponseBody$inboundSchema; + /** @deprecated use `ListHrisEmploymentsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisEmploymentsResponseBody$outboundSchema; + /** @deprecated use `ListHrisEmploymentsResponseBody$Outbound` instead. */ + export type Outbound = ListHrisEmploymentsResponseBody$Outbound; } diff --git a/src/models/operations/listhrisgroup.ts b/src/models/operations/listhrisgroups.ts similarity index 62% rename from src/models/operations/listhrisgroup.ts rename to src/models/operations/listhrisgroups.ts index 1e2c032f..06a95fae 100644 --- a/src/models/operations/listhrisgroup.ts +++ b/src/models/operations/listhrisgroups.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisGroupRequest = { +export type ListHrisGroupsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisGroupRequest = { cursor?: string | undefined; }; -export type ListHrisGroupResponseBody = { +export type ListHrisGroupsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisGroupRequest$inboundSchema: z.ZodType< - ListHrisGroupRequest, +export const ListHrisGroupsRequest$inboundSchema: z.ZodType< + ListHrisGroupsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisGroupRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisGroupRequest$Outbound = { +export type ListHrisGroupsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisGroupRequest$outboundSchema: z.ZodType< - ListHrisGroupRequest$Outbound, +export const ListHrisGroupsRequest$outboundSchema: z.ZodType< + ListHrisGroupsRequest$Outbound, z.ZodTypeDef, - ListHrisGroupRequest + ListHrisGroupsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisGroupRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisGroupRequest$ { - /** @deprecated use `ListHrisGroupRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisGroupRequest$inboundSchema; - /** @deprecated use `ListHrisGroupRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisGroupRequest$outboundSchema; - /** @deprecated use `ListHrisGroupRequest$Outbound` instead. */ - export type Outbound = ListHrisGroupRequest$Outbound; +export namespace ListHrisGroupsRequest$ { + /** @deprecated use `ListHrisGroupsRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisGroupsRequest$inboundSchema; + /** @deprecated use `ListHrisGroupsRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisGroupsRequest$outboundSchema; + /** @deprecated use `ListHrisGroupsRequest$Outbound` instead. */ + export type Outbound = ListHrisGroupsRequest$Outbound; } /** @internal */ -export const ListHrisGroupResponseBody$inboundSchema: z.ZodType< - ListHrisGroupResponseBody, +export const ListHrisGroupsResponseBody$inboundSchema: z.ZodType< + ListHrisGroupsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisGroupResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisGroupResponseBody$Outbound = { +export type ListHrisGroupsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisGroupResponseBody$outboundSchema: z.ZodType< - ListHrisGroupResponseBody$Outbound, +export const ListHrisGroupsResponseBody$outboundSchema: z.ZodType< + ListHrisGroupsResponseBody$Outbound, z.ZodTypeDef, - ListHrisGroupResponseBody + ListHrisGroupsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisGroupResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisGroupResponseBody$ { - /** @deprecated use `ListHrisGroupResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisGroupResponseBody$inboundSchema; - /** @deprecated use `ListHrisGroupResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisGroupResponseBody$outboundSchema; - /** @deprecated use `ListHrisGroupResponseBody$Outbound` instead. */ - export type Outbound = ListHrisGroupResponseBody$Outbound; +export namespace ListHrisGroupsResponseBody$ { + /** @deprecated use `ListHrisGroupsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisGroupsResponseBody$inboundSchema; + /** @deprecated use `ListHrisGroupsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisGroupsResponseBody$outboundSchema; + /** @deprecated use `ListHrisGroupsResponseBody$Outbound` instead. */ + export type Outbound = ListHrisGroupsResponseBody$Outbound; } diff --git a/src/models/operations/listhrislocation.ts b/src/models/operations/listhrislocations.ts similarity index 61% rename from src/models/operations/listhrislocation.ts rename to src/models/operations/listhrislocations.ts index 8702d986..279314b1 100644 --- a/src/models/operations/listhrislocation.ts +++ b/src/models/operations/listhrislocations.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisLocationRequest = { +export type ListHrisLocationsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisLocationRequest = { cursor?: string | undefined; }; -export type ListHrisLocationResponseBody = { +export type ListHrisLocationsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisLocationRequest$inboundSchema: z.ZodType< - ListHrisLocationRequest, +export const ListHrisLocationsRequest$inboundSchema: z.ZodType< + ListHrisLocationsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisLocationRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisLocationRequest$Outbound = { +export type ListHrisLocationsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisLocationRequest$outboundSchema: z.ZodType< - ListHrisLocationRequest$Outbound, +export const ListHrisLocationsRequest$outboundSchema: z.ZodType< + ListHrisLocationsRequest$Outbound, z.ZodTypeDef, - ListHrisLocationRequest + ListHrisLocationsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisLocationRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisLocationRequest$ { - /** @deprecated use `ListHrisLocationRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisLocationRequest$inboundSchema; - /** @deprecated use `ListHrisLocationRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisLocationRequest$outboundSchema; - /** @deprecated use `ListHrisLocationRequest$Outbound` instead. */ - export type Outbound = ListHrisLocationRequest$Outbound; +export namespace ListHrisLocationsRequest$ { + /** @deprecated use `ListHrisLocationsRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisLocationsRequest$inboundSchema; + /** @deprecated use `ListHrisLocationsRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisLocationsRequest$outboundSchema; + /** @deprecated use `ListHrisLocationsRequest$Outbound` instead. */ + export type Outbound = ListHrisLocationsRequest$Outbound; } /** @internal */ -export const ListHrisLocationResponseBody$inboundSchema: z.ZodType< - ListHrisLocationResponseBody, +export const ListHrisLocationsResponseBody$inboundSchema: z.ZodType< + ListHrisLocationsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisLocationResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisLocationResponseBody$Outbound = { +export type ListHrisLocationsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisLocationResponseBody$outboundSchema: z.ZodType< - ListHrisLocationResponseBody$Outbound, +export const ListHrisLocationsResponseBody$outboundSchema: z.ZodType< + ListHrisLocationsResponseBody$Outbound, z.ZodTypeDef, - ListHrisLocationResponseBody + ListHrisLocationsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisLocationResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisLocationResponseBody$ { - /** @deprecated use `ListHrisLocationResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisLocationResponseBody$inboundSchema; - /** @deprecated use `ListHrisLocationResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisLocationResponseBody$outboundSchema; - /** @deprecated use `ListHrisLocationResponseBody$Outbound` instead. */ - export type Outbound = ListHrisLocationResponseBody$Outbound; +export namespace ListHrisLocationsResponseBody$ { + /** @deprecated use `ListHrisLocationsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisLocationsResponseBody$inboundSchema; + /** @deprecated use `ListHrisLocationsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisLocationsResponseBody$outboundSchema; + /** @deprecated use `ListHrisLocationsResponseBody$Outbound` instead. */ + export type Outbound = ListHrisLocationsResponseBody$Outbound; } diff --git a/src/models/operations/listhrispaygroup.ts b/src/models/operations/listhrispaygroups.ts similarity index 61% rename from src/models/operations/listhrispaygroup.ts rename to src/models/operations/listhrispaygroups.ts index 514a2d9f..3c0a9544 100644 --- a/src/models/operations/listhrispaygroup.ts +++ b/src/models/operations/listhrispaygroups.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisPaygroupRequest = { +export type ListHrisPaygroupsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisPaygroupRequest = { cursor?: string | undefined; }; -export type ListHrisPaygroupResponseBody = { +export type ListHrisPaygroupsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisPaygroupRequest$inboundSchema: z.ZodType< - ListHrisPaygroupRequest, +export const ListHrisPaygroupsRequest$inboundSchema: z.ZodType< + ListHrisPaygroupsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisPaygroupRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisPaygroupRequest$Outbound = { +export type ListHrisPaygroupsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisPaygroupRequest$outboundSchema: z.ZodType< - ListHrisPaygroupRequest$Outbound, +export const ListHrisPaygroupsRequest$outboundSchema: z.ZodType< + ListHrisPaygroupsRequest$Outbound, z.ZodTypeDef, - ListHrisPaygroupRequest + ListHrisPaygroupsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisPaygroupRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisPaygroupRequest$ { - /** @deprecated use `ListHrisPaygroupRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisPaygroupRequest$inboundSchema; - /** @deprecated use `ListHrisPaygroupRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisPaygroupRequest$outboundSchema; - /** @deprecated use `ListHrisPaygroupRequest$Outbound` instead. */ - export type Outbound = ListHrisPaygroupRequest$Outbound; +export namespace ListHrisPaygroupsRequest$ { + /** @deprecated use `ListHrisPaygroupsRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisPaygroupsRequest$inboundSchema; + /** @deprecated use `ListHrisPaygroupsRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisPaygroupsRequest$outboundSchema; + /** @deprecated use `ListHrisPaygroupsRequest$Outbound` instead. */ + export type Outbound = ListHrisPaygroupsRequest$Outbound; } /** @internal */ -export const ListHrisPaygroupResponseBody$inboundSchema: z.ZodType< - ListHrisPaygroupResponseBody, +export const ListHrisPaygroupsResponseBody$inboundSchema: z.ZodType< + ListHrisPaygroupsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisPaygroupResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisPaygroupResponseBody$Outbound = { +export type ListHrisPaygroupsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisPaygroupResponseBody$outboundSchema: z.ZodType< - ListHrisPaygroupResponseBody$Outbound, +export const ListHrisPaygroupsResponseBody$outboundSchema: z.ZodType< + ListHrisPaygroupsResponseBody$Outbound, z.ZodTypeDef, - ListHrisPaygroupResponseBody + ListHrisPaygroupsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisPaygroupResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisPaygroupResponseBody$ { - /** @deprecated use `ListHrisPaygroupResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisPaygroupResponseBody$inboundSchema; - /** @deprecated use `ListHrisPaygroupResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisPaygroupResponseBody$outboundSchema; - /** @deprecated use `ListHrisPaygroupResponseBody$Outbound` instead. */ - export type Outbound = ListHrisPaygroupResponseBody$Outbound; +export namespace ListHrisPaygroupsResponseBody$ { + /** @deprecated use `ListHrisPaygroupsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisPaygroupsResponseBody$inboundSchema; + /** @deprecated use `ListHrisPaygroupsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisPaygroupsResponseBody$outboundSchema; + /** @deprecated use `ListHrisPaygroupsResponseBody$Outbound` instead. */ + export type Outbound = ListHrisPaygroupsResponseBody$Outbound; } diff --git a/src/models/operations/listhrispayrollruns.ts b/src/models/operations/listhrispayrollruns.ts index 6a60c1f5..55505478 100644 --- a/src/models/operations/listhrispayrollruns.ts +++ b/src/models/operations/listhrispayrollruns.ts @@ -40,7 +40,7 @@ export const ListHrisPayrollRunsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListHrisPayrollRunsRequest$inboundSchema: z.ZodType< export type ListHrisPayrollRunsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListHrisPayrollRunsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listhristimeoffbalance.ts b/src/models/operations/listhristimeoffbalances.ts similarity index 60% rename from src/models/operations/listhristimeoffbalance.ts rename to src/models/operations/listhristimeoffbalances.ts index 4d647399..3a7e0dd1 100644 --- a/src/models/operations/listhristimeoffbalance.ts +++ b/src/models/operations/listhristimeoffbalances.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListHrisTimeoffbalanceRequest = { +export type ListHrisTimeoffbalancesRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListHrisTimeoffbalanceRequest = { cursor?: string | undefined; }; -export type ListHrisTimeoffbalanceResponseBody = { +export type ListHrisTimeoffbalancesResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListHrisTimeoffbalanceRequest$inboundSchema: z.ZodType< - ListHrisTimeoffbalanceRequest, +export const ListHrisTimeoffbalancesRequest$inboundSchema: z.ZodType< + ListHrisTimeoffbalancesRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListHrisTimeoffbalanceRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisTimeoffbalanceRequest$Outbound = { +export type ListHrisTimeoffbalancesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListHrisTimeoffbalanceRequest$outboundSchema: z.ZodType< - ListHrisTimeoffbalanceRequest$Outbound, +export const ListHrisTimeoffbalancesRequest$outboundSchema: z.ZodType< + ListHrisTimeoffbalancesRequest$Outbound, z.ZodTypeDef, - ListHrisTimeoffbalanceRequest + ListHrisTimeoffbalancesRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListHrisTimeoffbalanceRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisTimeoffbalanceRequest$ { - /** @deprecated use `ListHrisTimeoffbalanceRequest$inboundSchema` instead. */ - export const inboundSchema = ListHrisTimeoffbalanceRequest$inboundSchema; - /** @deprecated use `ListHrisTimeoffbalanceRequest$outboundSchema` instead. */ - export const outboundSchema = ListHrisTimeoffbalanceRequest$outboundSchema; - /** @deprecated use `ListHrisTimeoffbalanceRequest$Outbound` instead. */ - export type Outbound = ListHrisTimeoffbalanceRequest$Outbound; +export namespace ListHrisTimeoffbalancesRequest$ { + /** @deprecated use `ListHrisTimeoffbalancesRequest$inboundSchema` instead. */ + export const inboundSchema = ListHrisTimeoffbalancesRequest$inboundSchema; + /** @deprecated use `ListHrisTimeoffbalancesRequest$outboundSchema` instead. */ + export const outboundSchema = ListHrisTimeoffbalancesRequest$outboundSchema; + /** @deprecated use `ListHrisTimeoffbalancesRequest$Outbound` instead. */ + export type Outbound = ListHrisTimeoffbalancesRequest$Outbound; } /** @internal */ -export const ListHrisTimeoffbalanceResponseBody$inboundSchema: z.ZodType< - ListHrisTimeoffbalanceResponseBody, +export const ListHrisTimeoffbalancesResponseBody$inboundSchema: z.ZodType< + ListHrisTimeoffbalancesResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListHrisTimeoffbalanceResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ListHrisTimeoffbalanceResponseBody$Outbound = { +export type ListHrisTimeoffbalancesResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListHrisTimeoffbalanceResponseBody$outboundSchema: z.ZodType< - ListHrisTimeoffbalanceResponseBody$Outbound, +export const ListHrisTimeoffbalancesResponseBody$outboundSchema: z.ZodType< + ListHrisTimeoffbalancesResponseBody$Outbound, z.ZodTypeDef, - ListHrisTimeoffbalanceResponseBody + ListHrisTimeoffbalancesResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListHrisTimeoffbalanceResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListHrisTimeoffbalanceResponseBody$ { - /** @deprecated use `ListHrisTimeoffbalanceResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListHrisTimeoffbalanceResponseBody$inboundSchema; - /** @deprecated use `ListHrisTimeoffbalanceResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListHrisTimeoffbalanceResponseBody$outboundSchema; - /** @deprecated use `ListHrisTimeoffbalanceResponseBody$Outbound` instead. */ - export type Outbound = ListHrisTimeoffbalanceResponseBody$Outbound; +export namespace ListHrisTimeoffbalancesResponseBody$ { + /** @deprecated use `ListHrisTimeoffbalancesResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListHrisTimeoffbalancesResponseBody$inboundSchema; + /** @deprecated use `ListHrisTimeoffbalancesResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListHrisTimeoffbalancesResponseBody$outboundSchema; + /** @deprecated use `ListHrisTimeoffbalancesResponseBody$Outbound` instead. */ + export type Outbound = ListHrisTimeoffbalancesResponseBody$Outbound; } diff --git a/src/models/operations/listhristimeoffs.ts b/src/models/operations/listhristimeoffs.ts index 23c9603d..912f7a19 100644 --- a/src/models/operations/listhristimeoffs.ts +++ b/src/models/operations/listhristimeoffs.ts @@ -40,7 +40,7 @@ export const ListHrisTimeoffsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListHrisTimeoffsRequest$inboundSchema: z.ZodType< export type ListHrisTimeoffsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListHrisTimeoffsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationaction.ts b/src/models/operations/listmarketingautomationaction.ts index e026e14b..2d4dbb3c 100644 --- a/src/models/operations/listmarketingautomationaction.ts +++ b/src/models/operations/listmarketingautomationaction.ts @@ -40,7 +40,7 @@ export const ListMarketingautomationActionRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingautomationActionRequest$inboundSchema: z.ZodType< export type ListMarketingautomationActionRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingautomationActionRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationautomation.ts b/src/models/operations/listmarketingautomationautomations.ts similarity index 61% rename from src/models/operations/listmarketingautomationautomation.ts rename to src/models/operations/listmarketingautomationautomations.ts index 6cfdcf44..326b3419 100644 --- a/src/models/operations/listmarketingautomationautomation.ts +++ b/src/models/operations/listmarketingautomationautomations.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListMarketingautomationAutomationRequest = { +export type ListMarketingautomationAutomationsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListMarketingautomationAutomationRequest = { cursor?: string | undefined; }; -export type ListMarketingautomationAutomationResponseBody = { +export type ListMarketingautomationAutomationsResponseBody = { prevCursor: string | null; nextCursor: string | null; data: Array; }; /** @internal */ -export const ListMarketingautomationAutomationRequest$inboundSchema: z.ZodType< - ListMarketingautomationAutomationRequest, +export const ListMarketingautomationAutomationsRequest$inboundSchema: z.ZodType< + ListMarketingautomationAutomationsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListMarketingautomationAutomationRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListMarketingautomationAutomationRequest$Outbound = { +export type ListMarketingautomationAutomationsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListMarketingautomationAutomationRequest$outboundSchema: z.ZodType< - ListMarketingautomationAutomationRequest$Outbound, +export const ListMarketingautomationAutomationsRequest$outboundSchema: z.ZodType< + ListMarketingautomationAutomationsRequest$Outbound, z.ZodTypeDef, - ListMarketingautomationAutomationRequest + ListMarketingautomationAutomationsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,18 +81,18 @@ export const ListMarketingautomationAutomationRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListMarketingautomationAutomationRequest$ { - /** @deprecated use `ListMarketingautomationAutomationRequest$inboundSchema` instead. */ - export const inboundSchema = ListMarketingautomationAutomationRequest$inboundSchema; - /** @deprecated use `ListMarketingautomationAutomationRequest$outboundSchema` instead. */ - export const outboundSchema = ListMarketingautomationAutomationRequest$outboundSchema; - /** @deprecated use `ListMarketingautomationAutomationRequest$Outbound` instead. */ - export type Outbound = ListMarketingautomationAutomationRequest$Outbound; +export namespace ListMarketingautomationAutomationsRequest$ { + /** @deprecated use `ListMarketingautomationAutomationsRequest$inboundSchema` instead. */ + export const inboundSchema = ListMarketingautomationAutomationsRequest$inboundSchema; + /** @deprecated use `ListMarketingautomationAutomationsRequest$outboundSchema` instead. */ + export const outboundSchema = ListMarketingautomationAutomationsRequest$outboundSchema; + /** @deprecated use `ListMarketingautomationAutomationsRequest$Outbound` instead. */ + export type Outbound = ListMarketingautomationAutomationsRequest$Outbound; } /** @internal */ -export const ListMarketingautomationAutomationResponseBody$inboundSchema: z.ZodType< - ListMarketingautomationAutomationResponseBody, +export const ListMarketingautomationAutomationsResponseBody$inboundSchema: z.ZodType< + ListMarketingautomationAutomationsResponseBody, z.ZodTypeDef, unknown > = z @@ -109,17 +109,17 @@ export const ListMarketingautomationAutomationResponseBody$inboundSchema: z.ZodT }); /** @internal */ -export type ListMarketingautomationAutomationResponseBody$Outbound = { +export type ListMarketingautomationAutomationsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; data: Array; }; /** @internal */ -export const ListMarketingautomationAutomationResponseBody$outboundSchema: z.ZodType< - ListMarketingautomationAutomationResponseBody$Outbound, +export const ListMarketingautomationAutomationsResponseBody$outboundSchema: z.ZodType< + ListMarketingautomationAutomationsResponseBody$Outbound, z.ZodTypeDef, - ListMarketingautomationAutomationResponseBody + ListMarketingautomationAutomationsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), @@ -137,11 +137,11 @@ export const ListMarketingautomationAutomationResponseBody$outboundSchema: z.Zod * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListMarketingautomationAutomationResponseBody$ { - /** @deprecated use `ListMarketingautomationAutomationResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListMarketingautomationAutomationResponseBody$inboundSchema; - /** @deprecated use `ListMarketingautomationAutomationResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListMarketingautomationAutomationResponseBody$outboundSchema; - /** @deprecated use `ListMarketingautomationAutomationResponseBody$Outbound` instead. */ - export type Outbound = ListMarketingautomationAutomationResponseBody$Outbound; +export namespace ListMarketingautomationAutomationsResponseBody$ { + /** @deprecated use `ListMarketingautomationAutomationsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListMarketingautomationAutomationsResponseBody$inboundSchema; + /** @deprecated use `ListMarketingautomationAutomationsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListMarketingautomationAutomationsResponseBody$outboundSchema; + /** @deprecated use `ListMarketingautomationAutomationsResponseBody$Outbound` instead. */ + export type Outbound = ListMarketingautomationAutomationsResponseBody$Outbound; } diff --git a/src/models/operations/listmarketingautomationcampaign.ts b/src/models/operations/listmarketingautomationcampaigns.ts similarity index 55% rename from src/models/operations/listmarketingautomationcampaign.ts rename to src/models/operations/listmarketingautomationcampaigns.ts index c52e7065..fcaf36cf 100644 --- a/src/models/operations/listmarketingautomationcampaign.ts +++ b/src/models/operations/listmarketingautomationcampaigns.ts @@ -6,7 +6,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as components from "../components/index.js"; import * as z from "zod"; -export type ListMarketingautomationCampaignRequest = { +export type ListMarketingautomationCampaignsRequest = { /** * The connection token */ @@ -25,22 +25,22 @@ export type ListMarketingautomationCampaignRequest = { cursor?: string | undefined; }; -export type ListMarketingautomationCampaignResponseBody = { +export type ListMarketingautomationCampaignsResponseBody = { prevCursor: string | null; nextCursor: string | null; - data: Array; + data: Array; }; /** @internal */ -export const ListMarketingautomationCampaignRequest$inboundSchema: z.ZodType< - ListMarketingautomationCampaignRequest, +export const ListMarketingautomationCampaignsRequest$inboundSchema: z.ZodType< + ListMarketingautomationCampaignsRequest, z.ZodTypeDef, unknown > = z .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -51,23 +51,23 @@ export const ListMarketingautomationCampaignRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type ListMarketingautomationCampaignRequest$Outbound = { +export type ListMarketingautomationCampaignsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; /** @internal */ -export const ListMarketingautomationCampaignRequest$outboundSchema: z.ZodType< - ListMarketingautomationCampaignRequest$Outbound, +export const ListMarketingautomationCampaignsRequest$outboundSchema: z.ZodType< + ListMarketingautomationCampaignsRequest$Outbound, z.ZodTypeDef, - ListMarketingautomationCampaignRequest + ListMarketingautomationCampaignsRequest > = z .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -81,25 +81,25 @@ export const ListMarketingautomationCampaignRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListMarketingautomationCampaignRequest$ { - /** @deprecated use `ListMarketingautomationCampaignRequest$inboundSchema` instead. */ - export const inboundSchema = ListMarketingautomationCampaignRequest$inboundSchema; - /** @deprecated use `ListMarketingautomationCampaignRequest$outboundSchema` instead. */ - export const outboundSchema = ListMarketingautomationCampaignRequest$outboundSchema; - /** @deprecated use `ListMarketingautomationCampaignRequest$Outbound` instead. */ - export type Outbound = ListMarketingautomationCampaignRequest$Outbound; +export namespace ListMarketingautomationCampaignsRequest$ { + /** @deprecated use `ListMarketingautomationCampaignsRequest$inboundSchema` instead. */ + export const inboundSchema = ListMarketingautomationCampaignsRequest$inboundSchema; + /** @deprecated use `ListMarketingautomationCampaignsRequest$outboundSchema` instead. */ + export const outboundSchema = ListMarketingautomationCampaignsRequest$outboundSchema; + /** @deprecated use `ListMarketingautomationCampaignsRequest$Outbound` instead. */ + export type Outbound = ListMarketingautomationCampaignsRequest$Outbound; } /** @internal */ -export const ListMarketingautomationCampaignResponseBody$inboundSchema: z.ZodType< - ListMarketingautomationCampaignResponseBody, +export const ListMarketingautomationCampaignsResponseBody$inboundSchema: z.ZodType< + ListMarketingautomationCampaignsResponseBody, z.ZodTypeDef, unknown > = z .object({ prev_cursor: z.nullable(z.string()), next_cursor: z.nullable(z.string()), - data: z.array(components.UnifiedCampaignOutput$inboundSchema), + data: z.array(components.UnifiedMarketingautomationCampaignOutput$inboundSchema), }) .transform((v) => { return remap$(v, { @@ -109,22 +109,22 @@ export const ListMarketingautomationCampaignResponseBody$inboundSchema: z.ZodTyp }); /** @internal */ -export type ListMarketingautomationCampaignResponseBody$Outbound = { +export type ListMarketingautomationCampaignsResponseBody$Outbound = { prev_cursor: string | null; next_cursor: string | null; - data: Array; + data: Array; }; /** @internal */ -export const ListMarketingautomationCampaignResponseBody$outboundSchema: z.ZodType< - ListMarketingautomationCampaignResponseBody$Outbound, +export const ListMarketingautomationCampaignsResponseBody$outboundSchema: z.ZodType< + ListMarketingautomationCampaignsResponseBody$Outbound, z.ZodTypeDef, - ListMarketingautomationCampaignResponseBody + ListMarketingautomationCampaignsResponseBody > = z .object({ prevCursor: z.nullable(z.string()), nextCursor: z.nullable(z.string()), - data: z.array(components.UnifiedCampaignOutput$outboundSchema), + data: z.array(components.UnifiedMarketingautomationCampaignOutput$outboundSchema), }) .transform((v) => { return remap$(v, { @@ -137,11 +137,11 @@ export const ListMarketingautomationCampaignResponseBody$outboundSchema: z.ZodTy * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ListMarketingautomationCampaignResponseBody$ { - /** @deprecated use `ListMarketingautomationCampaignResponseBody$inboundSchema` instead. */ - export const inboundSchema = ListMarketingautomationCampaignResponseBody$inboundSchema; - /** @deprecated use `ListMarketingautomationCampaignResponseBody$outboundSchema` instead. */ - export const outboundSchema = ListMarketingautomationCampaignResponseBody$outboundSchema; - /** @deprecated use `ListMarketingautomationCampaignResponseBody$Outbound` instead. */ - export type Outbound = ListMarketingautomationCampaignResponseBody$Outbound; +export namespace ListMarketingautomationCampaignsResponseBody$ { + /** @deprecated use `ListMarketingautomationCampaignsResponseBody$inboundSchema` instead. */ + export const inboundSchema = ListMarketingautomationCampaignsResponseBody$inboundSchema; + /** @deprecated use `ListMarketingautomationCampaignsResponseBody$outboundSchema` instead. */ + export const outboundSchema = ListMarketingautomationCampaignsResponseBody$outboundSchema; + /** @deprecated use `ListMarketingautomationCampaignsResponseBody$Outbound` instead. */ + export type Outbound = ListMarketingautomationCampaignsResponseBody$Outbound; } diff --git a/src/models/operations/listmarketingautomationcontacts.ts b/src/models/operations/listmarketingautomationcontacts.ts index e41217c8..8e97f9c9 100644 --- a/src/models/operations/listmarketingautomationcontacts.ts +++ b/src/models/operations/listmarketingautomationcontacts.ts @@ -40,7 +40,7 @@ export const ListMarketingAutomationContactsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingAutomationContactsRequest$inboundSchema: z.ZodType< export type ListMarketingAutomationContactsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingAutomationContactsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationemails.ts b/src/models/operations/listmarketingautomationemails.ts index c2a42072..60609987 100644 --- a/src/models/operations/listmarketingautomationemails.ts +++ b/src/models/operations/listmarketingautomationemails.ts @@ -40,7 +40,7 @@ export const ListMarketingautomationEmailsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingautomationEmailsRequest$inboundSchema: z.ZodType< export type ListMarketingautomationEmailsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingautomationEmailsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationevents.ts b/src/models/operations/listmarketingautomationevents.ts index 48440165..ddaa50c4 100644 --- a/src/models/operations/listmarketingautomationevents.ts +++ b/src/models/operations/listmarketingautomationevents.ts @@ -40,7 +40,7 @@ export const ListMarketingAutomationEventsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingAutomationEventsRequest$inboundSchema: z.ZodType< export type ListMarketingAutomationEventsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingAutomationEventsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationlists.ts b/src/models/operations/listmarketingautomationlists.ts index 6b2f04ad..d3f76013 100644 --- a/src/models/operations/listmarketingautomationlists.ts +++ b/src/models/operations/listmarketingautomationlists.ts @@ -40,7 +40,7 @@ export const ListMarketingautomationListsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingautomationListsRequest$inboundSchema: z.ZodType< export type ListMarketingautomationListsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingautomationListsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationmessages.ts b/src/models/operations/listmarketingautomationmessages.ts index 9c7434ef..bf75b663 100644 --- a/src/models/operations/listmarketingautomationmessages.ts +++ b/src/models/operations/listmarketingautomationmessages.ts @@ -40,7 +40,7 @@ export const ListMarketingautomationMessagesRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingautomationMessagesRequest$inboundSchema: z.ZodType< export type ListMarketingautomationMessagesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingautomationMessagesRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationtemplates.ts b/src/models/operations/listmarketingautomationtemplates.ts index 8450261d..54852589 100644 --- a/src/models/operations/listmarketingautomationtemplates.ts +++ b/src/models/operations/listmarketingautomationtemplates.ts @@ -40,7 +40,7 @@ export const ListMarketingautomationTemplatesRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingautomationTemplatesRequest$inboundSchema: z.ZodType< export type ListMarketingautomationTemplatesRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingautomationTemplatesRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listmarketingautomationusers.ts b/src/models/operations/listmarketingautomationusers.ts index 8a7d931b..eee8823a 100644 --- a/src/models/operations/listmarketingautomationusers.ts +++ b/src/models/operations/listmarketingautomationusers.ts @@ -40,7 +40,7 @@ export const ListMarketingAutomationUsersRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListMarketingAutomationUsersRequest$inboundSchema: z.ZodType< export type ListMarketingAutomationUsersRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListMarketingAutomationUsersRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingaccount.ts b/src/models/operations/listticketingaccount.ts index e5242937..cff8ffc7 100644 --- a/src/models/operations/listticketingaccount.ts +++ b/src/models/operations/listticketingaccount.ts @@ -40,7 +40,7 @@ export const ListTicketingAccountRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingAccountRequest$inboundSchema: z.ZodType< export type ListTicketingAccountRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingAccountRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingattachments.ts b/src/models/operations/listticketingattachments.ts index 5a383e10..1cc96d43 100644 --- a/src/models/operations/listticketingattachments.ts +++ b/src/models/operations/listticketingattachments.ts @@ -40,7 +40,7 @@ export const ListTicketingAttachmentsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingAttachmentsRequest$inboundSchema: z.ZodType< export type ListTicketingAttachmentsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingAttachmentsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingcollections.ts b/src/models/operations/listticketingcollections.ts index 85db9b07..73452638 100644 --- a/src/models/operations/listticketingcollections.ts +++ b/src/models/operations/listticketingcollections.ts @@ -40,7 +40,7 @@ export const ListTicketingCollectionsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingCollectionsRequest$inboundSchema: z.ZodType< export type ListTicketingCollectionsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingCollectionsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingcomments.ts b/src/models/operations/listticketingcomments.ts index 6c290735..4e6b6fc3 100644 --- a/src/models/operations/listticketingcomments.ts +++ b/src/models/operations/listticketingcomments.ts @@ -40,7 +40,7 @@ export const ListTicketingCommentsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingCommentsRequest$inboundSchema: z.ZodType< export type ListTicketingCommentsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingCommentsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingcontacts.ts b/src/models/operations/listticketingcontacts.ts index e08f7c5a..0173bbf4 100644 --- a/src/models/operations/listticketingcontacts.ts +++ b/src/models/operations/listticketingcontacts.ts @@ -40,7 +40,7 @@ export const ListTicketingContactsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingContactsRequest$inboundSchema: z.ZodType< export type ListTicketingContactsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingContactsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingtags.ts b/src/models/operations/listticketingtags.ts index 7dc2c0a4..51a529f3 100644 --- a/src/models/operations/listticketingtags.ts +++ b/src/models/operations/listticketingtags.ts @@ -40,7 +40,7 @@ export const ListTicketingTagsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingTagsRequest$inboundSchema: z.ZodType< export type ListTicketingTagsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingTagsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingteams.ts b/src/models/operations/listticketingteams.ts index 2887dae8..bada3dc8 100644 --- a/src/models/operations/listticketingteams.ts +++ b/src/models/operations/listticketingteams.ts @@ -40,7 +40,7 @@ export const ListTicketingTeamsRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingTeamsRequest$inboundSchema: z.ZodType< export type ListTicketingTeamsRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingTeamsRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingticket.ts b/src/models/operations/listticketingticket.ts index 23299902..801f9c3c 100644 --- a/src/models/operations/listticketingticket.ts +++ b/src/models/operations/listticketingticket.ts @@ -40,7 +40,7 @@ export const ListTicketingTicketRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingTicketRequest$inboundSchema: z.ZodType< export type ListTicketingTicketRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingTicketRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/listticketingusers.ts b/src/models/operations/listticketingusers.ts index 0c6aa92a..47430bf5 100644 --- a/src/models/operations/listticketingusers.ts +++ b/src/models/operations/listticketingusers.ts @@ -40,7 +40,7 @@ export const ListTicketingUsersRequest$inboundSchema: z.ZodType< .object({ "x-connection-token": z.string(), remote_data: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { @@ -54,7 +54,7 @@ export const ListTicketingUsersRequest$inboundSchema: z.ZodType< export type ListTicketingUsersRequest$Outbound = { "x-connection-token": string; remote_data?: boolean | undefined; - limit: number; + limit?: number | undefined; cursor?: string | undefined; }; @@ -67,7 +67,7 @@ export const ListTicketingUsersRequest$outboundSchema: z.ZodType< .object({ xConnectionToken: z.string(), remoteData: z.boolean().optional(), - limit: z.number().default(50), + limit: z.number().optional(), cursor: z.string().optional(), }) .transform((v) => { diff --git a/src/models/operations/retrievefilestoragedrive.ts b/src/models/operations/retrievefilestoragedrive.ts index 4c53c706..3ed44a1e 100644 --- a/src/models/operations/retrievefilestoragedrive.ts +++ b/src/models/operations/retrievefilestoragedrive.ts @@ -15,7 +15,7 @@ export type RetrieveFilestorageDriveRequest = { */ id: string; /** - * Set to true to include data from the original File Storage software. + * Set to true to include data from the original file storage service. */ remoteData?: boolean | undefined; }; diff --git a/src/models/operations/retrievehrisbankinfo.ts b/src/models/operations/retrievehrisbankinfo.ts index 66a1a163..c636728e 100644 --- a/src/models/operations/retrievehrisbankinfo.ts +++ b/src/models/operations/retrievehrisbankinfo.ts @@ -5,13 +5,13 @@ import { remap as remap$ } from "../../lib/primitives.js"; import * as z from "zod"; -export type RetrieveHrisBankinfoRequest = { +export type RetrieveHrisBankInfoRequest = { /** * The connection token */ xConnectionToken: string; /** - * id of the bankinfo you want to retrieve. + * id of the bank info you want to retrieve. */ id: string; /** @@ -21,8 +21,8 @@ export type RetrieveHrisBankinfoRequest = { }; /** @internal */ -export const RetrieveHrisBankinfoRequest$inboundSchema: z.ZodType< - RetrieveHrisBankinfoRequest, +export const RetrieveHrisBankInfoRequest$inboundSchema: z.ZodType< + RetrieveHrisBankInfoRequest, z.ZodTypeDef, unknown > = z @@ -39,17 +39,17 @@ export const RetrieveHrisBankinfoRequest$inboundSchema: z.ZodType< }); /** @internal */ -export type RetrieveHrisBankinfoRequest$Outbound = { +export type RetrieveHrisBankInfoRequest$Outbound = { "x-connection-token": string; id: string; remote_data?: boolean | undefined; }; /** @internal */ -export const RetrieveHrisBankinfoRequest$outboundSchema: z.ZodType< - RetrieveHrisBankinfoRequest$Outbound, +export const RetrieveHrisBankInfoRequest$outboundSchema: z.ZodType< + RetrieveHrisBankInfoRequest$Outbound, z.ZodTypeDef, - RetrieveHrisBankinfoRequest + RetrieveHrisBankInfoRequest > = z .object({ xConnectionToken: z.string(), @@ -67,11 +67,11 @@ export const RetrieveHrisBankinfoRequest$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace RetrieveHrisBankinfoRequest$ { - /** @deprecated use `RetrieveHrisBankinfoRequest$inboundSchema` instead. */ - export const inboundSchema = RetrieveHrisBankinfoRequest$inboundSchema; - /** @deprecated use `RetrieveHrisBankinfoRequest$outboundSchema` instead. */ - export const outboundSchema = RetrieveHrisBankinfoRequest$outboundSchema; - /** @deprecated use `RetrieveHrisBankinfoRequest$Outbound` instead. */ - export type Outbound = RetrieveHrisBankinfoRequest$Outbound; +export namespace RetrieveHrisBankInfoRequest$ { + /** @deprecated use `RetrieveHrisBankInfoRequest$inboundSchema` instead. */ + export const inboundSchema = RetrieveHrisBankInfoRequest$inboundSchema; + /** @deprecated use `RetrieveHrisBankInfoRequest$outboundSchema` instead. */ + export const outboundSchema = RetrieveHrisBankInfoRequest$outboundSchema; + /** @deprecated use `RetrieveHrisBankInfoRequest$Outbound` instead. */ + export type Outbound = RetrieveHrisBankInfoRequest$Outbound; } diff --git a/src/models/operations/retrievehriscompany.ts b/src/models/operations/retrievehriscompany.ts new file mode 100644 index 00000000..d672e92c --- /dev/null +++ b/src/models/operations/retrievehriscompany.ts @@ -0,0 +1,77 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { remap as remap$ } from "../../lib/primitives.js"; +import * as z from "zod"; + +export type RetrieveHrisCompanyRequest = { + /** + * The connection token + */ + xConnectionToken: string; + /** + * id of the company you want to retrieve. + */ + id: string; + /** + * Set to true to include data from the original Hris software. + */ + remoteData?: boolean | undefined; +}; + +/** @internal */ +export const RetrieveHrisCompanyRequest$inboundSchema: z.ZodType< + RetrieveHrisCompanyRequest, + z.ZodTypeDef, + unknown +> = z + .object({ + "x-connection-token": z.string(), + id: z.string(), + remote_data: z.boolean().optional(), + }) + .transform((v) => { + return remap$(v, { + "x-connection-token": "xConnectionToken", + remote_data: "remoteData", + }); + }); + +/** @internal */ +export type RetrieveHrisCompanyRequest$Outbound = { + "x-connection-token": string; + id: string; + remote_data?: boolean | undefined; +}; + +/** @internal */ +export const RetrieveHrisCompanyRequest$outboundSchema: z.ZodType< + RetrieveHrisCompanyRequest$Outbound, + z.ZodTypeDef, + RetrieveHrisCompanyRequest +> = z + .object({ + xConnectionToken: z.string(), + id: z.string(), + remoteData: z.boolean().optional(), + }) + .transform((v) => { + return remap$(v, { + xConnectionToken: "x-connection-token", + remoteData: "remote_data", + }); + }); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace RetrieveHrisCompanyRequest$ { + /** @deprecated use `RetrieveHrisCompanyRequest$inboundSchema` instead. */ + export const inboundSchema = RetrieveHrisCompanyRequest$inboundSchema; + /** @deprecated use `RetrieveHrisCompanyRequest$outboundSchema` instead. */ + export const outboundSchema = RetrieveHrisCompanyRequest$outboundSchema; + /** @deprecated use `RetrieveHrisCompanyRequest$Outbound` instead. */ + export type Outbound = RetrieveHrisCompanyRequest$Outbound; +} diff --git a/src/models/operations/retrievehrisemployerbenefit.ts b/src/models/operations/retrievehrisemployerbenefit.ts index 7f2e416b..2b3b074a 100644 --- a/src/models/operations/retrievehrisemployerbenefit.ts +++ b/src/models/operations/retrievehrisemployerbenefit.ts @@ -11,7 +11,7 @@ export type RetrieveHrisEmployerBenefitRequest = { */ xConnectionToken: string; /** - * id of the employerbenefit you want to retrieve. + * id of the employer benefit you want to retrieve. */ id: string; /** diff --git a/src/models/operations/retrievehrispayrollrun.ts b/src/models/operations/retrievehrispayrollrun.ts new file mode 100644 index 00000000..000b82dd --- /dev/null +++ b/src/models/operations/retrievehrispayrollrun.ts @@ -0,0 +1,77 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { remap as remap$ } from "../../lib/primitives.js"; +import * as z from "zod"; + +export type RetrieveHrisPayrollRunRequest = { + /** + * The connection token + */ + xConnectionToken: string; + /** + * id of the payroll run you want to retrieve. + */ + id: string; + /** + * Set to true to include data from the original Hris software. + */ + remoteData?: boolean | undefined; +}; + +/** @internal */ +export const RetrieveHrisPayrollRunRequest$inboundSchema: z.ZodType< + RetrieveHrisPayrollRunRequest, + z.ZodTypeDef, + unknown +> = z + .object({ + "x-connection-token": z.string(), + id: z.string(), + remote_data: z.boolean().optional(), + }) + .transform((v) => { + return remap$(v, { + "x-connection-token": "xConnectionToken", + remote_data: "remoteData", + }); + }); + +/** @internal */ +export type RetrieveHrisPayrollRunRequest$Outbound = { + "x-connection-token": string; + id: string; + remote_data?: boolean | undefined; +}; + +/** @internal */ +export const RetrieveHrisPayrollRunRequest$outboundSchema: z.ZodType< + RetrieveHrisPayrollRunRequest$Outbound, + z.ZodTypeDef, + RetrieveHrisPayrollRunRequest +> = z + .object({ + xConnectionToken: z.string(), + id: z.string(), + remoteData: z.boolean().optional(), + }) + .transform((v) => { + return remap$(v, { + xConnectionToken: "x-connection-token", + remoteData: "remote_data", + }); + }); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace RetrieveHrisPayrollRunRequest$ { + /** @deprecated use `RetrieveHrisPayrollRunRequest$inboundSchema` instead. */ + export const inboundSchema = RetrieveHrisPayrollRunRequest$inboundSchema; + /** @deprecated use `RetrieveHrisPayrollRunRequest$outboundSchema` instead. */ + export const outboundSchema = RetrieveHrisPayrollRunRequest$outboundSchema; + /** @deprecated use `RetrieveHrisPayrollRunRequest$Outbound` instead. */ + export type Outbound = RetrieveHrisPayrollRunRequest$Outbound; +} diff --git a/src/models/operations/retrievehristimeoff.ts b/src/models/operations/retrievehristimeoff.ts index ef7c41d9..5fc2decd 100644 --- a/src/models/operations/retrievehristimeoff.ts +++ b/src/models/operations/retrievehristimeoff.ts @@ -11,7 +11,7 @@ export type RetrieveHrisTimeoffRequest = { */ xConnectionToken: string; /** - * id of the timeoff you want to retrieve. + * id of the time off you want to retrieve. */ id: string; /** diff --git a/src/models/operations/status.ts b/src/models/operations/status.ts index d5872d0e..7bbaa61a 100644 --- a/src/models/operations/status.ts +++ b/src/models/operations/status.ts @@ -4,14 +4,42 @@ import * as z from "zod"; +export enum Vertical { + Ticketing = "ticketing", + Marketingautomation = "marketingautomation", + Crm = "crm", + Filestorage = "filestorage", + Ats = "ats", + Hris = "hris", + Accounting = "accounting", + Ecommerce = "ecommerce", +} + export type StatusRequest = { - vertical: string; + vertical: Vertical; }; +/** @internal */ +export const Vertical$inboundSchema: z.ZodNativeEnum = z.nativeEnum(Vertical); + +/** @internal */ +export const Vertical$outboundSchema: z.ZodNativeEnum = Vertical$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Vertical$ { + /** @deprecated use `Vertical$inboundSchema` instead. */ + export const inboundSchema = Vertical$inboundSchema; + /** @deprecated use `Vertical$outboundSchema` instead. */ + export const outboundSchema = Vertical$outboundSchema; +} + /** @internal */ export const StatusRequest$inboundSchema: z.ZodType = z.object({ - vertical: z.string(), + vertical: Vertical$inboundSchema, }); /** @internal */ @@ -25,7 +53,7 @@ export const StatusRequest$outboundSchema: z.ZodType< z.ZodTypeDef, StatusRequest > = z.object({ - vertical: z.string(), + vertical: Vertical$outboundSchema, }); /** diff --git a/src/models/operations/updatestatus.ts b/src/models/operations/updatestatus.ts index 58ef8248..a0924d3c 100644 --- a/src/models/operations/updatestatus.ts +++ b/src/models/operations/updatestatus.ts @@ -5,6 +5,9 @@ import * as z from "zod"; export type UpdateStatusRequest = { + /** + * id of the webhook to update. + */ id: string; }; diff --git a/src/sdk/actions.ts b/src/sdk/actions.ts index ce1832ad..70811504 100644 --- a/src/sdk/actions.ts +++ b/src/sdk/actions.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Actions extends ClientSDK { /** - * List Actions + * List Actions */ async list( request: operations.ListMarketingautomationActionRequest, diff --git a/src/sdk/automations.ts b/src/sdk/automations.ts index 2e32809d..86d75eaf 100644 --- a/src/sdk/automations.ts +++ b/src/sdk/automations.ts @@ -20,18 +20,18 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Automations extends ClientSDK { /** - * List Automations + * List Automations */ async list( - request: operations.ListMarketingautomationAutomationRequest, + request: operations.ListMarketingautomationAutomationsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, (value$) => - operations.ListMarketingautomationAutomationRequest$outboundSchema.parse(value$), + operations.ListMarketingautomationAutomationsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -57,7 +57,7 @@ export class Automations extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listMarketingautomationAutomation", + operationID: "listMarketingautomationAutomations", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -87,10 +87,10 @@ export class Automations extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListMarketingautomationAutomationResponseBody, + operations.ListMarketingautomationAutomationsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListMarketingautomationAutomationResponseBody$inboundSchema), + m$.json(200, operations.ListMarketingautomationAutomationsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -180,10 +180,10 @@ export class Automations extends ClientSDK { } /** - * Retrieve Automations + * Retrieve Automation * * @remarks - * Retrieve Automations from any connected Marketingautomation software + * Retrieve an Automation from any connected Marketingautomation software */ async retrieve( request: operations.RetrieveMarketingautomationAutomationRequest, diff --git a/src/sdk/bankinfos.ts b/src/sdk/bankinfos.ts index 38e242b4..721aae0f 100644 --- a/src/sdk/bankinfos.ts +++ b/src/sdk/bankinfos.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Bankinfos extends ClientSDK { /** - * List Bankinfos + * List Bank Info */ async list( - request: operations.ListHrisBankinfoRequest, + request: operations.ListHrisBankInfoRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisBankinfoRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisBankInfoRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Bankinfos extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisBankinfo", + operationID: "listHrisBankInfo", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Bankinfos extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisBankinfoResponseBody, + operations.ListHrisBankInfoResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisBankinfoResponseBody$inboundSchema), + m$.json(200, operations.ListHrisBankInfoResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,20 +96,20 @@ export class Bankinfos extends ClientSDK { } /** - * Retrieve Bank Infos + * Retrieve Bank Info * * @remarks - * Retrieve Bank Infos from any connected Hris software + * Retrieve Bank Info from any connected Hris software */ async retrieve( - request: operations.RetrieveHrisBankinfoRequest, + request: operations.RetrieveHrisBankInfoRequest, options?: RequestOptions ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.RetrieveHrisBankinfoRequest$outboundSchema.parse(value$), + (value$) => operations.RetrieveHrisBankInfoRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -137,7 +137,7 @@ export class Bankinfos extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "retrieveHrisBankinfo", + operationID: "retrieveHrisBankInfo", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; diff --git a/src/sdk/benefits.ts b/src/sdk/benefits.ts index 7d54c20e..62a31b6f 100644 --- a/src/sdk/benefits.ts +++ b/src/sdk/benefits.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Benefits extends ClientSDK { /** - * List Benefits + * List Benefits */ async list( - request: operations.ListHrisBenefitRequest, + request: operations.ListHrisBenefitsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisBenefitRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisBenefitsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Benefits extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisBenefit", + operationID: "listHrisBenefits", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Benefits extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisBenefitResponseBody, + operations.ListHrisBenefitsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisBenefitResponseBody$inboundSchema), + m$.json(200, operations.ListHrisBenefitsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,10 +96,10 @@ export class Benefits extends ClientSDK { } /** - * Retrieve Benefits + * Retrieve Benefit * * @remarks - * Retrieve Benefits from any connected Hris software + * Retrieve a Benefit from any connected Hris software */ async retrieve( request: operations.RetrieveHrisBenefitRequest, diff --git a/src/sdk/campaigns.ts b/src/sdk/campaigns.ts index 79ce0d8d..e1639508 100644 --- a/src/sdk/campaigns.ts +++ b/src/sdk/campaigns.ts @@ -20,18 +20,18 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Campaigns extends ClientSDK { /** - * List Campaigns + * List Campaigns */ async list( - request: operations.ListMarketingautomationCampaignRequest, + request: operations.ListMarketingautomationCampaignsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, (value$) => - operations.ListMarketingautomationCampaignRequest$outboundSchema.parse(value$), + operations.ListMarketingautomationCampaignsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -57,7 +57,7 @@ export class Campaigns extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listMarketingautomationCampaign", + operationID: "listMarketingautomationCampaigns", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -87,10 +87,10 @@ export class Campaigns extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListMarketingautomationCampaignResponseBody, + operations.ListMarketingautomationCampaignsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListMarketingautomationCampaignResponseBody$inboundSchema), + m$.json(200, operations.ListMarketingautomationCampaignsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -106,7 +106,7 @@ export class Campaigns extends ClientSDK { async create( request: operations.CreateMarketingautomationCampaignRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -169,10 +169,10 @@ export class Campaigns extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - components.UnifiedCampaignOutput, + components.UnifiedMarketingautomationCampaignOutput, SDKError | SDKValidationError >( - m$.json(201, components.UnifiedCampaignOutput$inboundSchema), + m$.json(201, components.UnifiedMarketingautomationCampaignOutput$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -180,15 +180,15 @@ export class Campaigns extends ClientSDK { } /** - * Retrieve Campaigns + * Retrieve Campaign * * @remarks - * Retrieve Campaigns from any connected Marketingautomation software + * Retrieve a Campaign from any connected Marketingautomation software */ async retrieve( request: operations.RetrieveMarketingautomationCampaignRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -252,10 +252,10 @@ export class Campaigns extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - components.UnifiedCampaignOutput, + components.UnifiedMarketingautomationCampaignOutput, SDKError | SDKValidationError >( - m$.json(200, components.UnifiedCampaignOutput$inboundSchema), + m$.json(200, components.UnifiedMarketingautomationCampaignOutput$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); diff --git a/src/sdk/collections.ts b/src/sdk/collections.ts index 184fc875..8bfc8c0e 100644 --- a/src/sdk/collections.ts +++ b/src/sdk/collections.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Collections extends ClientSDK { /** - * List Collections + * List Collections */ async list( request: operations.ListTicketingCollectionsRequest, diff --git a/src/sdk/comments.ts b/src/sdk/comments.ts index c338b787..21df4aa2 100644 --- a/src/sdk/comments.ts +++ b/src/sdk/comments.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Comments extends ClientSDK { /** - * List Comments + * List Comments */ async list( request: operations.ListTicketingCommentsRequest, @@ -176,10 +176,10 @@ export class Comments extends ClientSDK { } /** - * Retrieve Comments + * Retrieve Comment * * @remarks - * Retrieve Comments from any connected Ticketing software + * Retrieve a Comment from any connected Ticketing software */ async retrieve( request: operations.RetrieveTicketingCommentRequest, diff --git a/src/sdk/contacts.ts b/src/sdk/contacts.ts index 4e7165b1..f5ba3bfd 100644 --- a/src/sdk/contacts.ts +++ b/src/sdk/contacts.ts @@ -18,7 +18,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Contacts extends ClientSDK { /** - * List all Contacts + * List Contacts */ async list( request: operations.ListTicketingContactsRequest, @@ -95,10 +95,10 @@ export class Contacts extends ClientSDK { } /** - * Retrieve Contacts + * Retrieve Contact * * @remarks - * Retrieve Contacts from any connected Ticketing software + * Retrieve a Contact from any connected Ticketing software */ async retrieve( request: operations.RetrieveTicketingContactRequest, diff --git a/src/sdk/deals.ts b/src/sdk/deals.ts index 9f34f7bc..d4a3de62 100644 --- a/src/sdk/deals.ts +++ b/src/sdk/deals.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Deals extends ClientSDK { /** - * List Deals + * List Deals */ async list( request: operations.ListCrmDealsRequest, diff --git a/src/sdk/dependents.ts b/src/sdk/dependents.ts index 7f460575..3d6534bb 100644 --- a/src/sdk/dependents.ts +++ b/src/sdk/dependents.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Dependents extends ClientSDK { /** - * List Dependents + * List Dependents */ async list( request: operations.ListHrisDependentsRequest, @@ -96,10 +96,10 @@ export class Dependents extends ClientSDK { } /** - * Retrieve Dependents + * Retrieve Dependent * * @remarks - * Retrieve Dependents from any connected Hris software + * Retrieve a Dependent from any connected Hris software */ async retrieve( request: operations.RetrieveHrisDependentRequest, diff --git a/src/sdk/drives.ts b/src/sdk/drives.ts index 9a892c9c..08fc78f8 100644 --- a/src/sdk/drives.ts +++ b/src/sdk/drives.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Drives extends ClientSDK { /** - * List Drives + * List Drives */ async list( request: operations.ListFilestorageDrivesRequest, @@ -96,10 +96,10 @@ export class Drives extends ClientSDK { } /** - * Retrieve Drives + * Retrieve Drive * * @remarks - * Retrieve Drives from any connected Filestorage software + * Retrieve a Drive from any connected file storage service */ async retrieve( request: operations.RetrieveFilestorageDriveRequest, diff --git a/src/sdk/emails.ts b/src/sdk/emails.ts index 3cb814d6..17a9b5eb 100644 --- a/src/sdk/emails.ts +++ b/src/sdk/emails.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Emails extends ClientSDK { /** - * List Emails + * List Emails */ async list( request: operations.ListMarketingautomationEmailsRequest, @@ -97,10 +97,10 @@ export class Emails extends ClientSDK { } /** - * Retrieve Emails + * Retrieve Email * * @remarks - * Retrieve Emails from any connected Marketingautomation software + * Retrieve an Email from any connected Marketingautomation software */ async retrieve( request: operations.RetrieveMarketingautomationEmailRequest, diff --git a/src/sdk/employeepayrollruns.ts b/src/sdk/employeepayrollruns.ts index 370982b2..bd08a2f2 100644 --- a/src/sdk/employeepayrollruns.ts +++ b/src/sdk/employeepayrollruns.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Employeepayrollruns extends ClientSDK { /** - * List EmployeePayrollRuns + * List Employee Payroll Runs */ async list( request: operations.ListHrisEmployeePayrollRunRequest, @@ -96,10 +96,10 @@ export class Employeepayrollruns extends ClientSDK { } /** - * Retrieve Employee Payroll Runs + * Retrieve Employee Payroll Run * * @remarks - * Retrieve Employee Payroll Runs from any connected Hris software + * Retrieve Employee Payroll Run from any connected Hris software */ async retrieve( request: operations.RetrieveHrisEmployeePayrollRunRequest, diff --git a/src/sdk/employees.ts b/src/sdk/employees.ts index 67bd191a..22397234 100644 --- a/src/sdk/employees.ts +++ b/src/sdk/employees.ts @@ -20,17 +20,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Employees extends ClientSDK { /** - * List Employees + * List Employees */ async list( - request: operations.ListHrisEmployeeRequest, + request: operations.ListHrisEmployeesRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisEmployeeRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisEmployeesRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -56,7 +56,7 @@ export class Employees extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisEmployee", + operationID: "listHrisEmployees", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -86,10 +86,10 @@ export class Employees extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisEmployeeResponseBody, + operations.ListHrisEmployeesResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisEmployeeResponseBody$inboundSchema), + m$.json(200, operations.ListHrisEmployeesResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -176,10 +176,10 @@ export class Employees extends ClientSDK { } /** - * Retrieven Employees + * Retrieve Employee * * @remarks - * Retrieven Employees from any connected Hris software + * Retrieve an Employee from any connected Hris software */ async retrieve( request: operations.RetrieveHrisEmployeeRequest, diff --git a/src/sdk/employerbenefits.ts b/src/sdk/employerbenefits.ts index ef29cae5..5aeb0e35 100644 --- a/src/sdk/employerbenefits.ts +++ b/src/sdk/employerbenefits.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Employerbenefits extends ClientSDK { /** - * List EmployerBenefits + * List Employer Benefits */ async list( - request: operations.ListHrisEmployerBenefitRequest, + request: operations.ListHrisEmployerBenefitsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisEmployerBenefitRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisEmployerBenefitsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Employerbenefits extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisEmployerBenefit", + operationID: "listHrisEmployerBenefits", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Employerbenefits extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisEmployerBenefitResponseBody, + operations.ListHrisEmployerBenefitsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisEmployerBenefitResponseBody$inboundSchema), + m$.json(200, operations.ListHrisEmployerBenefitsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,10 +96,10 @@ export class Employerbenefits extends ClientSDK { } /** - * Retrieve Employer Benefits + * Retrieve Employer Benefit * * @remarks - * Retrieve Employer Benefits from any connected Hris software + * Retrieve an Employer Benefit from any connected Hris software */ async retrieve( request: operations.RetrieveHrisEmployerBenefitRequest, diff --git a/src/sdk/employments.ts b/src/sdk/employments.ts index b8e6cb6a..ef4a4eec 100644 --- a/src/sdk/employments.ts +++ b/src/sdk/employments.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Employments extends ClientSDK { /** - * List Employments + * List Employments */ async list( - request: operations.ListHrisEmploymentRequest, + request: operations.ListHrisEmploymentsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisEmploymentRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisEmploymentsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Employments extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisEmployment", + operationID: "listHrisEmployments", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Employments extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisEmploymentResponseBody, + operations.ListHrisEmploymentsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisEmploymentResponseBody$inboundSchema), + m$.json(200, operations.ListHrisEmploymentsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,10 +96,10 @@ export class Employments extends ClientSDK { } /** - * Retrieve Employments + * Retrieve Employment * * @remarks - * Retrieve Employments from any connected Hris software + * Retrieve an Employment from any connected Hris software */ async retrieve( request: operations.RetrieveHrisEmploymentRequest, diff --git a/src/sdk/engagements.ts b/src/sdk/engagements.ts index 0355d4e4..47f46c74 100644 --- a/src/sdk/engagements.ts +++ b/src/sdk/engagements.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Engagements extends ClientSDK { /** - * List Engagements + * List Engagements */ async list( request: operations.ListCrmEngagementsRequest, diff --git a/src/sdk/events.ts b/src/sdk/events.ts index d66b0563..460033e2 100644 --- a/src/sdk/events.ts +++ b/src/sdk/events.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Events extends ClientSDK { /** - * List Events + * List Events */ async list( request: operations.ListMarketingAutomationEventsRequest, @@ -97,10 +97,10 @@ export class Events extends ClientSDK { } /** - * Retrieve Events + * Retrieve Event * * @remarks - * Retrieve Events from any connected Marketingautomation software + * Retrieve an Event from any connected Marketingautomation software */ async retrieve( request: operations.RetrieveMarketingautomationEventRequest, diff --git a/src/sdk/groups.ts b/src/sdk/groups.ts index 43b131b7..7516aac1 100644 --- a/src/sdk/groups.ts +++ b/src/sdk/groups.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Groups extends ClientSDK { /** - * List Groups + * List Groups */ async list( - request: operations.ListHrisGroupRequest, + request: operations.ListHrisGroupsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisGroupRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisGroupsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Groups extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisGroup", + operationID: "listHrisGroups", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Groups extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisGroupResponseBody, + operations.ListHrisGroupsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisGroupResponseBody$inboundSchema), + m$.json(200, operations.ListHrisGroupsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,10 +96,10 @@ export class Groups extends ClientSDK { } /** - * Retrieve Groups + * Retrieve Group * * @remarks - * Retrieve Groups from any connected Hris software + * Retrieve a Group from any connected Hris software */ async retrieve( request: operations.RetrieveHrisGroupRequest, diff --git a/src/sdk/single.ts b/src/sdk/id.ts similarity index 78% rename from src/sdk/single.ts rename to src/sdk/id.ts index 0ce54e0b..bd966638 100644 --- a/src/sdk/single.ts +++ b/src/sdk/id.ts @@ -2,26 +2,26 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ -import { encodeFormQuery as encodeFormQuery$ } from "../lib/encodings.js"; +import { encodeSimple as encodeSimple$ } from "../lib/encodings.js"; import * as m$ from "../lib/matchers.js"; import * as schemas$ from "../lib/schemas.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { unwrap as unwrap$ } from "../types/fp.js"; +import * as z from "zod"; -export class Single extends ClientSDK { +export class Id extends ClientSDK { /** * Retrieve Linked Users */ async retrieve( request: operations.RetrieveLinkedUserRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -32,14 +32,14 @@ export class Single extends ClientSDK { const payload$ = unwrap$(parsed$); const body$ = null; - const path$ = pathToFunc("/linked_users/single")(); + const pathParams$ = { + id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), + }; - const query$ = encodeFormQuery$({ - id: payload$.id, - }); + const path$ = pathToFunc("/linked_users/{id}")(pathParams$); const headers$ = new Headers({ - Accept: "application/json", + Accept: "*/*", }); const apiKey$ = await extractSecurity(this.options$.apiKey); @@ -58,7 +58,6 @@ export class Single extends ClientSDK { method: "GET", path: path$, headers: headers$, - query: query$, body: body$, timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, }, @@ -74,11 +73,8 @@ export class Single extends ClientSDK { }); const response = unwrap$(doResult); - const [result$] = await m$.match< - components.LinkedUserResponse, - SDKError | SDKValidationError - >( - m$.json(200, components.LinkedUserResponse$inboundSchema), + const [result$] = await m$.match( + m$.nil(200, z.void()), m$.fail(["4XX", "5XX"]) )(response); diff --git a/src/sdk/linkedusers.ts b/src/sdk/linkedusers.ts index 677bb347..02c89607 100644 --- a/src/sdk/linkedusers.ts +++ b/src/sdk/linkedusers.ts @@ -14,7 +14,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { unwrap as unwrap$ } from "../types/fp.js"; import { Batch } from "./batch.js"; import { Fromremoteid } from "./fromremoteid.js"; -import { Single } from "./single.js"; +import { Id } from "./id.js"; import * as z from "zod"; export class LinkedUsers extends ClientSDK { @@ -23,9 +23,9 @@ export class LinkedUsers extends ClientSDK { return (this._batch ??= new Batch(this.options$)); } - private _single?: Single; - get single(): Single { - return (this._single ??= new Single(this.options$)); + private _id?: Id; + get id(): Id { + return (this._id ??= new Id(this.options$)); } private _fromremoteid?: Fromremoteid; diff --git a/src/sdk/lists.ts b/src/sdk/lists.ts index e941cac6..2318a20b 100644 --- a/src/sdk/lists.ts +++ b/src/sdk/lists.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Lists extends ClientSDK { /** - * List Lists + * List Lists */ async list( request: operations.ListMarketingautomationListsRequest, @@ -179,10 +179,10 @@ export class Lists extends ClientSDK { } /** - * Retrieve Lists + * Retrieve List * * @remarks - * Retrieve Lists from any connected Marketingautomation software + * Retrieve a List from any connected Marketingautomation software */ async retrieve( request: operations.RetrieveMarketingautomationListRequest, diff --git a/src/sdk/locations.ts b/src/sdk/locations.ts index 1bb42a68..c8e38cd1 100644 --- a/src/sdk/locations.ts +++ b/src/sdk/locations.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Locations extends ClientSDK { /** - * List Locations + * List Locations */ async list( - request: operations.ListHrisLocationRequest, + request: operations.ListHrisLocationsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisLocationRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisLocationsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Locations extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisLocation", + operationID: "listHrisLocations", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Locations extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisLocationResponseBody, + operations.ListHrisLocationsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisLocationResponseBody$inboundSchema), + m$.json(200, operations.ListHrisLocationsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,10 +96,10 @@ export class Locations extends ClientSDK { } /** - * Retrieve Locations + * Retrieve Location * * @remarks - * Retrieve Locations from any connected Hris software + * Retrieve a Location from any connected Hris software */ async retrieve( request: operations.RetrieveHrisLocationRequest, diff --git a/src/sdk/messages.ts b/src/sdk/messages.ts index 809cabe2..dff09ba3 100644 --- a/src/sdk/messages.ts +++ b/src/sdk/messages.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Messages extends ClientSDK { /** - * List Messages + * List Messages */ async list( request: operations.ListMarketingautomationMessagesRequest, diff --git a/src/sdk/notes.ts b/src/sdk/notes.ts index cb82e28b..5dc6f139 100644 --- a/src/sdk/notes.ts +++ b/src/sdk/notes.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Notes extends ClientSDK { /** - * List Notes + * List Notes */ async list( request: operations.ListCrmNoteRequest, diff --git a/src/sdk/panoracompanies.ts b/src/sdk/panoracompanies.ts index ed43c250..03b735e3 100644 --- a/src/sdk/panoracompanies.ts +++ b/src/sdk/panoracompanies.ts @@ -11,6 +11,7 @@ import * as schemas$ from "../lib/schemas.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; +import * as components from "../models/components/index.js"; import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; @@ -18,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class PanoraCompanies extends ClientSDK { /** - * List Companys + * List Companies */ async list( - request: operations.ListHrisCompanysRequest, + request: operations.ListHrisCompaniesRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisCompanysRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisCompaniesRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -54,7 +55,7 @@ export class PanoraCompanies extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisCompanys", + operationID: "listHrisCompanies", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -84,10 +85,92 @@ export class PanoraCompanies extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisCompanysResponseBody, + operations.ListHrisCompaniesResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisCompanysResponseBody$inboundSchema), + m$.json(200, operations.ListHrisCompaniesResponseBody$inboundSchema), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); + } + + /** + * Retrieve Company + * + * @remarks + * Retrieve a Company from any connected Hris software + */ + async retrieve( + request: operations.RetrieveHrisCompanyRequest, + options?: RequestOptions + ): Promise { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => operations.RetrieveHrisCompanyRequest$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = null; + + const pathParams$ = { + id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), + }; + + const path$ = pathToFunc("/hris/companies/{id}")(pathParams$); + + const query$ = encodeFormQuery$({ + remote_data: payload$.remote_data, + }); + + const headers$ = new Headers({ + Accept: "application/json", + "x-connection-token": encodeSimple$( + "x-connection-token", + payload$["x-connection-token"], + { explode: false, charEncoding: "none" } + ), + }); + + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "retrieveHrisCompany", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "GET", + path: path$, + headers: headers$, + query: query$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + components.UnifiedHrisCompanyOutput, + SDKError | SDKValidationError + >( + m$.json(200, components.UnifiedHrisCompanyOutput$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); diff --git a/src/sdk/panorafilestorageusers.ts b/src/sdk/panorafilestorageusers.ts index 742dfcdc..8b7fa9c6 100644 --- a/src/sdk/panorafilestorageusers.ts +++ b/src/sdk/panorafilestorageusers.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class PanoraFilestorageUsers extends ClientSDK { /** - * List Users + * List Users */ async list( request: operations.ListFilestorageUsersRequest, @@ -104,7 +104,7 @@ export class PanoraFilestorageUsers extends ClientSDK { async retrieve( request: operations.RetrieveFilestorageUserRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -167,10 +167,10 @@ export class PanoraFilestorageUsers extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - components.UnifiedUserOutput, + components.UnifiedFilestorageUserOutput, SDKError | SDKValidationError >( - m$.json(200, components.UnifiedUserOutput$inboundSchema), + m$.json(200, components.UnifiedFilestorageUserOutput$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); diff --git a/src/sdk/paygroups.ts b/src/sdk/paygroups.ts index 1ed71b37..a7ed565d 100644 --- a/src/sdk/paygroups.ts +++ b/src/sdk/paygroups.ts @@ -19,17 +19,17 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Paygroups extends ClientSDK { /** - * List PayGroups + * List Pay Groups */ async list( - request: operations.ListHrisPaygroupRequest, + request: operations.ListHrisPaygroupsRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisPaygroupRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisPaygroupsRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Paygroups extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisPaygroup", + operationID: "listHrisPaygroups", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Paygroups extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisPaygroupResponseBody, + operations.ListHrisPaygroupsResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisPaygroupResponseBody$inboundSchema), + m$.json(200, operations.ListHrisPaygroupsResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -96,10 +96,10 @@ export class Paygroups extends ClientSDK { } /** - * Retrieve Pay Groups + * Retrieve Pay Group * * @remarks - * Retrieve Pay Groups from any connected Hris software + * Retrieve a Pay Group from any connected Hris software */ async retrieve( request: operations.RetrieveHrisPaygroupRequest, diff --git a/src/sdk/payrollruns.ts b/src/sdk/payrollruns.ts index 986e8df2..80d73ef1 100644 --- a/src/sdk/payrollruns.ts +++ b/src/sdk/payrollruns.ts @@ -11,6 +11,7 @@ import * as schemas$ from "../lib/schemas.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; +import * as components from "../models/components/index.js"; import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; @@ -18,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Payrollruns extends ClientSDK { /** - * List PayrollRuns + * List Payroll Runs */ async list( request: operations.ListHrisPayrollRunsRequest, @@ -93,4 +94,86 @@ export class Payrollruns extends ClientSDK { return unwrap$(result$); } + + /** + * Retrieve Payroll Run + * + * @remarks + * Retrieve a Payroll Run from any connected Hris software + */ + async retrieve( + request: operations.RetrieveHrisPayrollRunRequest, + options?: RequestOptions + ): Promise { + const input$ = request; + + const parsed$ = schemas$.safeParse( + input$, + (value$) => operations.RetrieveHrisPayrollRunRequest$outboundSchema.parse(value$), + "Input validation failed" + ); + const payload$ = unwrap$(parsed$); + const body$ = null; + + const pathParams$ = { + id: encodeSimple$("id", payload$.id, { explode: false, charEncoding: "percent" }), + }; + + const path$ = pathToFunc("/hris/payrollruns/{id}")(pathParams$); + + const query$ = encodeFormQuery$({ + remote_data: payload$.remote_data, + }); + + const headers$ = new Headers({ + Accept: "application/json", + "x-connection-token": encodeSimple$( + "x-connection-token", + payload$["x-connection-token"], + { explode: false, charEncoding: "none" } + ), + }); + + const apiKey$ = await extractSecurity(this.options$.apiKey); + const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; + const context = { + operationID: "retrieveHrisPayrollRun", + oAuth2Scopes: [], + securitySource: this.options$.apiKey, + }; + const securitySettings$ = resolveGlobalSecurity(security$); + + const requestRes$ = this.createRequest$( + context, + { + security: securitySettings$, + method: "GET", + path: path$, + headers: headers$, + query: query$, + body: body$, + timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1, + }, + options + ); + const request$ = unwrap$(requestRes$); + + const doResult = await this.do$(request$, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: options?.retries || this.options$.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + const response = unwrap$(doResult); + + const [result$] = await m$.match< + components.UnifiedHrisPayrollrunOutput, + SDKError | SDKValidationError + >( + m$.json(200, components.UnifiedHrisPayrollrunOutput$inboundSchema), + m$.fail(["4XX", "5XX"]) + )(response); + + return unwrap$(result$); + } } diff --git a/src/sdk/tags.ts b/src/sdk/tags.ts index 962abc7e..16b2815c 100644 --- a/src/sdk/tags.ts +++ b/src/sdk/tags.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Tags extends ClientSDK { /** - * List Tags + * List Tags */ async list( request: operations.ListTicketingTagsRequest, @@ -96,10 +96,10 @@ export class Tags extends ClientSDK { } /** - * Retrieve Tags + * Retrieve Tag * * @remarks - * Retrieve Tags from any connected Ticketing software + * Retrieve a Tag from any connected Ticketing software */ async retrieve( request: operations.RetrieveTicketingTagRequest, diff --git a/src/sdk/tasks.ts b/src/sdk/tasks.ts index 6ce1e308..c0afb7a1 100644 --- a/src/sdk/tasks.ts +++ b/src/sdk/tasks.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Tasks extends ClientSDK { /** - * List Tasks + * List Tasks */ async list( request: operations.ListCrmTaskRequest, diff --git a/src/sdk/templates.ts b/src/sdk/templates.ts index c7c17ee6..1301b82f 100644 --- a/src/sdk/templates.ts +++ b/src/sdk/templates.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Templates extends ClientSDK { /** - * List Templates + * List Templates */ async list( request: operations.ListMarketingautomationTemplatesRequest, @@ -180,10 +180,10 @@ export class Templates extends ClientSDK { } /** - * Retrieve Templates + * Retrieve Template * * @remarks - * Retrieve Templates from any connected Marketingautomation software + * Retrieve a Template from any connected Marketingautomation software */ async retrieve( request: operations.RetrieveMarketingautomationTemplateRequest, diff --git a/src/sdk/timeoffbalances.ts b/src/sdk/timeoffbalances.ts index 9d0dd787..efe7b3a3 100644 --- a/src/sdk/timeoffbalances.ts +++ b/src/sdk/timeoffbalances.ts @@ -22,14 +22,14 @@ export class Timeoffbalances extends ClientSDK { * List TimeoffBalances */ async list( - request: operations.ListHrisTimeoffbalanceRequest, + request: operations.ListHrisTimeoffbalancesRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( input$, - (value$) => operations.ListHrisTimeoffbalanceRequest$outboundSchema.parse(value$), + (value$) => operations.ListHrisTimeoffbalancesRequest$outboundSchema.parse(value$), "Input validation failed" ); const payload$ = unwrap$(parsed$); @@ -55,7 +55,7 @@ export class Timeoffbalances extends ClientSDK { const apiKey$ = await extractSecurity(this.options$.apiKey); const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ }; const context = { - operationID: "listHrisTimeoffbalance", + operationID: "listHrisTimeoffbalances", oAuth2Scopes: [], securitySource: this.options$.apiKey, }; @@ -85,10 +85,10 @@ export class Timeoffbalances extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.ListHrisTimeoffbalanceResponseBody, + operations.ListHrisTimeoffbalancesResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.ListHrisTimeoffbalanceResponseBody$inboundSchema), + m$.json(200, operations.ListHrisTimeoffbalancesResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); diff --git a/src/sdk/timeoffs.ts b/src/sdk/timeoffs.ts index c2bd2949..b5c9d2f1 100644 --- a/src/sdk/timeoffs.ts +++ b/src/sdk/timeoffs.ts @@ -20,7 +20,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Timeoffs extends ClientSDK { /** - * List Timeoffs + * List Time Offs */ async list( request: operations.ListHrisTimeoffsRequest, @@ -176,10 +176,10 @@ export class Timeoffs extends ClientSDK { } /** - * Retrieve Timeoffs + * Retrieve Time Off * * @remarks - * Retrieve Timeoffs from any connected Hris software + * Retrieve a Time Off from any connected Hris software */ async retrieve( request: operations.RetrieveHrisTimeoffRequest, diff --git a/src/sdk/users.ts b/src/sdk/users.ts index 56545a07..21ade90a 100644 --- a/src/sdk/users.ts +++ b/src/sdk/users.ts @@ -19,7 +19,7 @@ import { unwrap as unwrap$ } from "../types/fp.js"; export class Users extends ClientSDK { /** - * List Users + * List Users */ async list( request: operations.ListTicketingUsersRequest, @@ -96,10 +96,10 @@ export class Users extends ClientSDK { } /** - * Retrieve Users + * Retrieve User * * @remarks - * Retrieve Users from any connected Ticketing software + * Retrieve a User from any connected Ticketing software */ async retrieve( request: operations.RetrieveTicketingUserRequest, diff --git a/src/sdk/webhooks.ts b/src/sdk/webhooks.ts index 857f28c3..9be3705a 100644 --- a/src/sdk/webhooks.ts +++ b/src/sdk/webhooks.ts @@ -136,7 +136,7 @@ export class Webhooks extends ClientSDK { async delete( request: operations.DeleteRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -188,12 +188,8 @@ export class Webhooks extends ClientSDK { }); const response = unwrap$(doResult); - const [result$] = await m$.match< - components.WebhookResponse | undefined, - SDKError | SDKValidationError - >( - m$.nil(200, components.WebhookResponse$inboundSchema.optional()), - m$.json(201, components.WebhookResponse$inboundSchema.optional()), + const [result$] = await m$.match( + m$.json(201, components.WebhookResponse$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -206,7 +202,7 @@ export class Webhooks extends ClientSDK { async updateStatus( request: operations.UpdateStatusRequest, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -258,12 +254,8 @@ export class Webhooks extends ClientSDK { }); const response = unwrap$(doResult); - const [result$] = await m$.match< - components.WebhookResponse | undefined, - SDKError | SDKValidationError - >( - m$.nil(200, components.WebhookResponse$inboundSchema.optional()), - m$.json(201, components.WebhookResponse$inboundSchema.optional()), + const [result$] = await m$.match( + m$.json(201, components.WebhookResponse$inboundSchema), m$.fail(["4XX", "5XX"]) )(response); @@ -276,7 +268,7 @@ export class Webhooks extends ClientSDK { async verifyEvent( request: components.SignatureVerificationDto, options?: RequestOptions - ): Promise { + ): Promise { const input$ = request; const parsed$ = schemas$.safeParse( @@ -326,11 +318,10 @@ export class Webhooks extends ClientSDK { const response = unwrap$(doResult); const [result$] = await m$.match< - operations.VerifyEventResponseBody | undefined, + operations.VerifyEventResponseBody, SDKError | SDKValidationError >( - m$.json(200, operations.VerifyEventResponseBody$inboundSchema.optional()), - m$.nil(201, operations.VerifyEventResponseBody$inboundSchema.optional()), + m$.json(200, operations.VerifyEventResponseBody$inboundSchema), m$.fail(["4XX", "5XX"]) )(response);