From 99309b2c987efeb30f38d2d8de5bba3a15717cba Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Oct 2023 11:37:15 -0700 Subject: [PATCH] chore: speakeasy sdk regeneration - Generate (#23) * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.43.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.44.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.44.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.45.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.45.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.47.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.47.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.47.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.48.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.49.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.49.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.50.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.50.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.51.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.51.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.51.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.52.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.52.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.52.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.53.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.53.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.56.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.56.4 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.57.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.59.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.59.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.61.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.62.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.62.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.64.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.65.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.65.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.65.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.65.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.66.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.66.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.68.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.68.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.69.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.71.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.71.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.72.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.73.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.73.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.6 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.7 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.9 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.11 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.16 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.74.19 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.76.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.77.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.77.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.78.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.79.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.82.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.82.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.82.5 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.83.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.83.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.86.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.87.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.88.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.88.1 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.89.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.91.0 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.91.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.91.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.91.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.92.2 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.92.3 * ci: regenerated with OpenAPI Doc v2, Speakeay CLI 1.94.0 --------- Co-authored-by: speakeasybot --- .gitattributes | 2 + .gitignore | 0 README.md | 236 +++--- RELEASES.md | 653 ++++++++++++++++ USAGE.md | 8 +- docs/circleci/README.md | 8 - docs/context/README.md | 203 ----- docs/insights/README.md | 323 -------- docs/job/README.md | 112 --- ...entvariabletocontext200applicationjson1.md | 11 + ...ontext200applicationjsonmessageresponse.md | 10 + ...variabletocontextdefaultapplicationjson.md | 10 + .../addenvironmentvariabletocontextrequest.md | 10 + ...environmentvariabletocontextrequestbody.md | 8 + ...addenvironmentvariabletocontextresponse.md | 12 + ...ngapprovaljobbyiddefaultapplicationjson.md | 10 + ...vependingapprovaljobbyidmessageresponse.md | 10 + .../approvependingapprovaljobbyidrequest.md | 9 + .../approvependingapprovaljobbyidresponse.md | 12 + .../canceljobdefaultapplicationjson.md | 10 + .../operations/canceljobmessageresponse.md | 10 + docs/models/operations/canceljobrequest.md | 9 + docs/models/operations/canceljobresponse.md | 12 + .../cancelworkflowdefaultapplicationjson.md | 10 + .../cancelworkflowmessageresponse.md | 10 + .../operations/cancelworkflowrequest.md | 8 + .../operations/cancelworkflowresponse.md | 12 + .../continuepipelinedefaultapplicationjson.md | 10 + .../continuepipelinemessageresponse.md | 10 + .../operations/continuepipelinerequestbody.md | 10 + .../operations/continuepipelineresponse.md | 12 + .../createcheckoutkeycheckoutkey.md | 14 + ...techeckoutkeycheckoutkeycheckoutkeytype.md | 11 + .../createcheckoutkeycheckoutkeyinput.md | 8 + ...keycheckoutkeyinputcheckoutkeyinputtype.md | 11 + ...createcheckoutkeydefaultapplicationjson.md | 10 + .../operations/createcheckoutkeyrequest.md | 9 + .../operations/createcheckoutkeyresponse.md | 12 + .../models/operations/createcontextcontext.md | 12 + .../createcontextdefaultapplicationjson.md | 10 + .../operations/createcontextrequestbody.md | 9 + .../createcontextrequestbodyowner1.md | 9 + .../createcontextrequestbodyowner1type.md | 11 + .../createcontextrequestbodyowner2.md | 9 + .../createcontextrequestbodyowner2type.md | 10 + .../operations/createcontextresponse.md | 12 + .../createenvvardefaultapplicationjson.md | 10 + .../createenvvarenvironmentvariable.md | 11 + .../createenvvarenvironmentvariable1.md | 12 + docs/models/operations/createenvvarrequest.md | 9 + .../models/operations/createenvvarresponse.md | 12 + .../createpolicybundle400applicationjson.md | 11 + .../createpolicybundle401applicationjson.md | 11 + .../createpolicybundle403applicationjson.md | 11 + .../createpolicybundle413applicationjson.md | 11 + .../createpolicybundle500applicationjson.md | 10 + .../operations/createpolicybundlerequest.md | 11 + .../operations/createpolicybundleresponse.md | 16 + .../createschedulecreatescheduleparameters.md | 14 + ...reatescheduleparametersattributionactor.md | 11 + ...edulecreatescheduleparameterstimetable1.md | 14 + ...escheduleparameterstimetable1daysofweek.md | 16 + ...reatescheduleparameterstimetable1months.md | 21 + ...edulecreatescheduleparameterstimetable2.md | 14 + ...escheduleparameterstimetable2daysofweek.md | 16 + ...reatescheduleparameterstimetable2months.md | 21 + .../createscheduledefaultapplicationjson.md | 10 + .../operations/createschedulerequest.md | 9 + .../operations/createscheduleresponse.md | 12 + .../operations/createscheduleschedule.md | 18 + .../createschedulescheduletimetable1.md | 14 + ...ateschedulescheduletimetable1daysofweek.md | 16 + .../createschedulescheduletimetable1months.md | 21 + .../createschedulescheduletimetable2.md | 14 + ...ateschedulescheduletimetable2daysofweek.md | 16 + .../createschedulescheduletimetable2months.md | 21 + .../operations/createschedulescheduleuser.md | 12 + .../createwebhookdefaultapplicationjson.md | 10 + .../operations/createwebhookrequestbody.md | 15 + .../createwebhookrequestbodyevents.md | 9 + .../createwebhookrequestbodyscope.md | 11 + .../createwebhookrequestbodyscopetype.md | 10 + .../operations/createwebhookresponse.md | 12 + .../models/operations/createwebhookwebhook.md | 18 + .../operations/createwebhookwebhookevents.md | 9 + .../operations/createwebhookwebhookscope.md | 11 + ...deletecheckoutkeydefaultapplicationjson.md | 10 + .../deletecheckoutkeymessageresponse.md | 10 + .../operations/deletecheckoutkeyrequest.md | 9 + .../operations/deletecheckoutkeyresponse.md | 12 + .../deletecontextdefaultapplicationjson.md | 10 + .../deletecontextmessageresponse.md | 10 + .../models/operations/deletecontextrequest.md | 8 + .../operations/deletecontextresponse.md | 12 + ...riablefromcontextdefaultapplicationjson.md | 10 + ...nmentvariablefromcontextmessageresponse.md | 10 + ...teenvironmentvariablefromcontextrequest.md | 9 + ...eenvironmentvariablefromcontextresponse.md | 12 + .../deleteenvvardefaultapplicationjson.md | 10 + .../operations/deleteenvvarmessageresponse.md | 10 + docs/models/operations/deleteenvvarrequest.md | 9 + .../models/operations/deleteenvvarresponse.md | 12 + .../deleteorgclaims400applicationjson.md | 11 + .../deleteorgclaims403applicationjson.md | 11 + .../deleteorgclaims500applicationjson.md | 10 + .../operations/deleteorgclaimsrequest.md | 9 + .../operations/deleteorgclaimsresponse.md | 14 + .../deleteprojectclaims400applicationjson.md | 11 + .../deleteprojectclaims403applicationjson.md | 11 + .../deleteprojectclaims500applicationjson.md | 10 + .../operations/deleteprojectclaimsrequest.md | 10 + .../operations/deleteprojectclaimsresponse.md | 14 + ...eleteschedulebyiddefaultapplicationjson.md | 10 + .../deleteschedulebyidmessageresponse.md | 10 + .../operations/deleteschedulebyidrequest.md | 8 + .../operations/deleteschedulebyidresponse.md | 12 + .../deletewebhookdefaultapplicationjson.md | 10 + .../deletewebhookmessageresponse.md | 10 + .../models/operations/deletewebhookrequest.md | 8 + .../operations/deletewebhookresponse.md | 12 + ...linsightsbranchesdefaultapplicationjson.md | 10 + .../getallinsightsbranchesrequest.md | 9 + .../getallinsightsbranchesresponse.md | 12 + .../operations/getcheckoutkeycheckoutkey.md | 14 + ...etcheckoutkeycheckoutkeycheckoutkeytype.md | 11 + .../getcheckoutkeydefaultapplicationjson.md | 10 + .../operations/getcheckoutkeyrequest.md | 9 + .../operations/getcheckoutkeyresponse.md | 12 + .../getcollaborationscollaboration.md | 12 + ...getcollaborationsdefaultapplicationjson.md | 10 + .../operations/getcollaborationsresponse.md | 12 + docs/models/operations/getcontextcontext.md | 12 + .../getcontextdefaultapplicationjson.md | 10 + docs/models/operations/getcontextrequest.md | 8 + docs/models/operations/getcontextresponse.md | 12 + .../getcurrentuserdefaultapplicationjson.md | 10 + .../operations/getcurrentuserresponse.md | 12 + docs/models/operations/getcurrentuseruser.md | 12 + .../getdecisionlog400applicationjson.md | 11 + .../getdecisionlog401applicationjson.md | 11 + .../getdecisionlog403applicationjson.md | 11 + .../getdecisionlog404applicationjson.md | 11 + .../getdecisionlog500applicationjson.md | 10 + ...cisionlogpolicybundle400applicationjson.md | 11 + ...cisionlogpolicybundle401applicationjson.md | 11 + ...cisionlogpolicybundle403applicationjson.md | 11 + ...cisionlogpolicybundle404applicationjson.md | 11 + ...cisionlogpolicybundle500applicationjson.md | 10 + .../getdecisionlogpolicybundlerequest.md | 10 + .../getdecisionlogpolicybundleresponse.md | 16 + .../operations/getdecisionlogrequest.md | 10 + .../operations/getdecisionlogresponse.md | 16 + .../getdecisionlogs400applicationjson.md | 11 + .../getdecisionlogs401applicationjson.md | 11 + .../getdecisionlogs403applicationjson.md | 11 + .../getdecisionlogs500applicationjson.md | 10 + .../operations/getdecisionlogsrequest.md | 16 + .../operations/getdecisionlogsresponse.md | 15 + .../getdecisionsettings400applicationjson.md | 11 + .../getdecisionsettings401applicationjson.md | 11 + .../getdecisionsettings403applicationjson.md | 11 + .../getdecisionsettings500applicationjson.md | 10 + .../operations/getdecisionsettingsrequest.md | 9 + .../operations/getdecisionsettingsresponse.md | 15 + .../getenvvardefaultapplicationjson.md | 10 + .../getenvvarenvironmentvariable.md | 12 + docs/models/operations/getenvvarrequest.md | 9 + docs/models/operations/getenvvarresponse.md | 12 + .../getflakytests200applicationjson.md | 11 + ...tflakytests200applicationjsonflakytests.md | 19 + .../getflakytestsdefaultapplicationjson.md | 10 + .../models/operations/getflakytestsrequest.md | 8 + .../operations/getflakytestsresponse.md | 12 + .../getjobartifactsartifactlistresponse.md | 11 + ...obartifactsartifactlistresponseartifact.md | 12 + .../getjobartifactsdefaultapplicationjson.md | 10 + .../operations/getjobartifactsrequest.md | 9 + .../operations/getjobartifactsresponse.md | 12 + .../getjobdetailsdefaultapplicationjson.md | 10 + .../operations/getjobdetailsjobdetails.md | 27 + .../getjobdetailsjobdetailscontexts.md | 10 + .../getjobdetailsjobdetailsexecutor.md | 11 + .../getjobdetailsjobdetailslatestworkflow.md | 11 + .../getjobdetailsjobdetailsmessages.md | 12 + .../getjobdetailsjobdetailsorganization.md | 10 + .../getjobdetailsjobdetailsparallelruns.md | 11 + .../getjobdetailsjobdetailspipeline.md | 10 + .../getjobdetailsjobdetailsproject.md | 13 + .../getjobdetailsjobdetailsstatus.md | 23 + .../models/operations/getjobdetailsrequest.md | 9 + .../operations/getjobdetailsresponse.md | 12 + .../getjobtimeseries200applicationjson.md | 11 + ...getjobtimeseries200applicationjsonitems.md | 12 + ...imeseries200applicationjsonitemsmetrics.md | 16 + ...licationjsonitemsmetricsdurationmetrics.md | 14 + .../getjobtimeseriesdefaultapplicationjson.md | 10 + .../operations/getjobtimeseriesgranularity.md | 11 + .../operations/getjobtimeseriesrequest.md | 13 + .../operations/getjobtimeseriesresponse.md | 12 + .../getorgclaims400applicationjson.md | 11 + .../getorgclaims403applicationjson.md | 11 + .../getorgclaims500applicationjson.md | 10 + docs/models/operations/getorgclaimsrequest.md | 8 + .../models/operations/getorgclaimsresponse.md | 14 + .../getorgsummarydata200applicationjson.md | 12 + ...orgsummarydata200applicationjsonorgdata.md | 11 + ...arydata200applicationjsonorgdatametrics.md | 14 + ...marydata200applicationjsonorgdatatrends.md | 14 + ...arydata200applicationjsonorgprojectdata.md | 10 + ...200applicationjsonorgprojectdatametrics.md | 13 + ...a200applicationjsonorgprojectdatatrends.md | 13 + ...getorgsummarydatadefaultapplicationjson.md | 10 + .../getorgsummarydataprojectnames.md | 9 + .../getorgsummarydatareportingwindow.md | 14 + .../operations/getorgsummarydatarequest.md | 10 + .../operations/getorgsummarydataresponse.md | 12 + .../getpipelinebyiddefaultapplicationjson.md | 10 + .../operations/getpipelinebyidpipeline.md | 19 + .../getpipelinebyidpipelineerrors.md | 11 + .../getpipelinebyidpipelineerrorstype.md | 15 + .../getpipelinebyidpipelinestate.md | 14 + .../getpipelinebyidpipelinetrigger.md | 12 + .../getpipelinebyidpipelinetriggeractor.md | 11 + .../getpipelinebyidpipelinetriggertype.md | 13 + .../operations/getpipelinebyidpipelinevcs.md | 18 + .../getpipelinebyidpipelinevcscommit.md | 11 + .../operations/getpipelinebyidrequest.md | 8 + .../operations/getpipelinebyidresponse.md | 12 + ...tpipelinebynumberdefaultapplicationjson.md | 10 + .../operations/getpipelinebynumberpipeline.md | 19 + .../getpipelinebynumberpipelineerrors.md | 11 + .../getpipelinebynumberpipelineerrorstype.md | 15 + .../getpipelinebynumberpipelinestate.md | 14 + .../getpipelinebynumberpipelinetrigger.md | 12 + ...getpipelinebynumberpipelinetriggeractor.md | 11 + .../getpipelinebynumberpipelinetriggertype.md | 13 + .../getpipelinebynumberpipelinevcs.md | 18 + .../getpipelinebynumberpipelinevcscommit.md | 11 + .../operations/getpipelinebynumberrequest.md | 9 + .../operations/getpipelinebynumberresponse.md | 12 + ...ipelineconfigbyiddefaultapplicationjson.md | 10 + .../getpipelineconfigbyidpipelineconfig.md | 13 + .../getpipelineconfigbyidrequest.md | 8 + .../getpipelineconfigbyidresponse.md | 12 + .../getpolicybundle400applicationjson.md | 11 + .../getpolicybundle401applicationjson.md | 11 + .../getpolicybundle403applicationjson.md | 11 + .../getpolicybundle500applicationjson.md | 10 + .../operations/getpolicybundlerequest.md | 9 + .../operations/getpolicybundleresponse.md | 15 + .../getpolicydocument400applicationjson.md | 11 + .../getpolicydocument401applicationjson.md | 11 + .../getpolicydocument403applicationjson.md | 11 + .../getpolicydocument404applicationjson.md | 11 + .../getpolicydocument500applicationjson.md | 10 + .../operations/getpolicydocumentrequest.md | 10 + .../operations/getpolicydocumentresponse.md | 16 + .../getprojectbyslugdefaultapplicationjson.md | 10 + .../operations/getprojectbyslugproject.md | 16 + .../getprojectbyslugprojectvcsinfo.md | 12 + .../getprojectbyslugprojectvcsinfoprovider.md | 12 + .../operations/getprojectbyslugrequest.md | 8 + .../operations/getprojectbyslugresponse.md | 12 + .../getprojectclaims400applicationjson.md | 11 + .../getprojectclaims403applicationjson.md | 11 + .../getprojectclaims500applicationjson.md | 10 + .../operations/getprojectclaimsrequest.md | 9 + .../operations/getprojectclaimsresponse.md | 14 + ...ectworkflowjobmetrics200applicationjson.md | 11 + ...rkflowjobmetrics200applicationjsonitems.md | 11 + ...obmetrics200applicationjsonitemsmetrics.md | 16 + ...licationjsonitemsmetricsdurationmetrics.md | 15 + ...orkflowjobmetricsdefaultapplicationjson.md | 10 + ...rojectworkflowjobmetricsreportingwindow.md | 14 + .../getprojectworkflowjobmetricsrequest.md | 13 + .../getprojectworkflowjobmetricsresponse.md | 12 + ...rojectworkflowmetrics200applicationjson.md | 11 + ...tworkflowmetrics200applicationjsonitems.md | 12 + ...owmetrics200applicationjsonitemsmetrics.md | 18 + ...licationjsonitemsmetricsdurationmetrics.md | 15 + ...ctworkflowmetricsdefaultapplicationjson.md | 10 + ...etprojectworkflowmetricsreportingwindow.md | 14 + .../getprojectworkflowmetricsrequest.md | 12 + .../getprojectworkflowmetricsresponse.md | 12 + ...etprojectworkflowruns200applicationjson.md | 11 + ...jectworkflowruns200applicationjsonitems.md | 15 + ...rkflowruns200applicationjsonitemsstatus.md | 14 + ...ojectworkflowrunsdefaultapplicationjson.md | 10 + .../getprojectworkflowrunsrequest.md | 14 + .../getprojectworkflowrunsresponse.md | 12 + ...jectworkflowspagedata200applicationjson.md | 16 + ...wspagedata200applicationjsonprojectdata.md | 11 + ...ata200applicationjsonprojectdatametrics.md | 14 + ...data200applicationjsonprojectdatatrends.md | 14 + ...pplicationjsonprojectworkflowbranchdata.md | 11 + ...ionjsonprojectworkflowbranchdatametrics.md | 13 + ...tionjsonprojectworkflowbranchdatatrends.md | 13 + ...ta200applicationjsonprojectworkflowdata.md | 10 + ...plicationjsonprojectworkflowdatametrics.md | 13 + ...pplicationjsonprojectworkflowdatatrends.md | 13 + .../getprojectworkflowspagedatabranches.md | 9 + ...workflowspagedatadefaultapplicationjson.md | 10 + ...projectworkflowspagedatareportingwindow.md | 14 + .../getprojectworkflowspagedatarequest.md | 11 + .../getprojectworkflowspagedataresponse.md | 12 + ...etprojectworkflowspagedataworkflownames.md | 9 + ...ctworkflowtestmetrics200applicationjson.md | 16 + ...etrics200applicationjsonmostfailedtests.md | 16 + ...stmetrics200applicationjsonslowesttests.md | 16 + ...owtestmetrics200applicationjsontestruns.md | 11 + ...ics200applicationjsontestrunstestcounts.md | 14 + ...rkflowtestmetricsdefaultapplicationjson.md | 10 + .../getprojectworkflowtestmetricsrequest.md | 11 + .../getprojectworkflowtestmetricsresponse.md | 12 + .../getschedulebyiddefaultapplicationjson.md | 10 + .../operations/getschedulebyidrequest.md | 8 + .../operations/getschedulebyidresponse.md | 12 + .../operations/getschedulebyidschedule.md | 18 + .../getschedulebyidscheduletimetable1.md | 14 + ...chedulebyidscheduletimetable1daysofweek.md | 16 + ...getschedulebyidscheduletimetable1months.md | 21 + .../getschedulebyidscheduletimetable2.md | 14 + ...chedulebyidscheduletimetable2daysofweek.md | 16 + ...getschedulebyidscheduletimetable2months.md | 21 + .../operations/getschedulebyidscheduleuser.md | 12 + .../gettestsdefaultapplicationjson.md | 10 + docs/models/operations/gettestsrequest.md | 9 + docs/models/operations/gettestsresponse.md | 12 + .../operations/getteststestsresponse.md | 11 + .../operations/getteststestsresponseitems.md | 14 + .../getuserdefaultapplicationjson.md | 10 + docs/models/operations/getuserrequest.md | 8 + docs/models/operations/getuserresponse.md | 12 + docs/models/operations/getuseruser.md | 12 + .../getwebhookbyiddefaultapplicationjson.md | 10 + .../operations/getwebhookbyidrequest.md | 8 + .../operations/getwebhookbyidresponse.md | 12 + .../operations/getwebhookbyidwebhook.md | 18 + .../operations/getwebhookbyidwebhookevents.md | 9 + .../operations/getwebhookbyidwebhookscope.md | 11 + .../getwebhooks200applicationjson.md | 11 + .../getwebhooks200applicationjsonwebhook.md | 16 + ...webhooks200applicationjsonwebhookevents.md | 9 + ...twebhooks200applicationjsonwebhookscope.md | 11 + .../getwebhooksdefaultapplicationjson.md | 10 + docs/models/operations/getwebhooksrequest.md | 9 + docs/models/operations/getwebhooksresponse.md | 12 + .../models/operations/getwebhooksscopetype.md | 10 + .../getworkflowbyiddefaultapplicationjson.md | 10 + .../operations/getworkflowbyidrequest.md | 8 + .../operations/getworkflowbyidresponse.md | 12 + .../operations/getworkflowbyidworkflow.md | 21 + .../getworkflowbyidworkflowstatus.md | 18 + .../operations/getworkflowbyidworkflowtag.md | 10 + .../getworkflowsummary200applicationjson.md | 12 + ...orkflowsummary200applicationjsonmetrics.md | 20 + ...00applicationjsonmetricsdurationmetrics.md | 15 + ...workflowsummary200applicationjsontrends.md | 17 + ...etworkflowsummarydefaultapplicationjson.md | 10 + .../operations/getworkflowsummaryrequest.md | 11 + .../operations/getworkflowsummaryresponse.md | 12 + ...listcheckoutkeyscheckoutkeylistresponse.md | 11 + ...tkeyscheckoutkeylistresponsecheckoutkey.md | 14 + ...ylistresponsecheckoutkeycheckoutkeytype.md | 11 + .../listcheckoutkeysdefaultapplicationjson.md | 10 + .../operations/listcheckoutkeysrequest.md | 8 + .../operations/listcheckoutkeysresponse.md | 12 + .../listcontexts200applicationjson.md | 11 + .../listcontexts200applicationjsoncontext.md | 10 + .../listcontextsdefaultapplicationjson.md | 10 + .../operations/listcontextsownertype.md | 11 + docs/models/operations/listcontextsrequest.md | 11 + .../models/operations/listcontextsresponse.md | 12 + ...tvariablesfromcontext200applicationjson.md | 11 + ...ablesfromcontext200applicationjsonitems.md | 11 + ...iablesfromcontextdefaultapplicationjson.md | 10 + ...tenvironmentvariablesfromcontextrequest.md | 9 + ...environmentvariablesfromcontextresponse.md | 12 + .../listenvvarsdefaultapplicationjson.md | 10 + ...tenvvarsenvironmentvariablelistresponse.md | 11 + ...variablelistresponseenvironmentvariable.md | 12 + docs/models/operations/listenvvarsrequest.md | 8 + docs/models/operations/listenvvarsresponse.md | 12 + .../listmypipelinesdefaultapplicationjson.md | 10 + .../listmypipelinespipelinelistresponse.md | 11 + ...mypipelinespipelinelistresponsepipeline.md | 19 + ...linespipelinelistresponsepipelineerrors.md | 11 + ...spipelinelistresponsepipelineerrorstype.md | 15 + ...elinespipelinelistresponsepipelinestate.md | 14 + ...inespipelinelistresponsepipelinetrigger.md | 12 + ...ipelinelistresponsepipelinetriggeractor.md | 11 + ...pipelinelistresponsepipelinetriggertype.md | 13 + ...ipelinespipelinelistresponsepipelinevcs.md | 18 + ...espipelinelistresponsepipelinevcscommit.md | 11 + .../operations/listmypipelinesrequest.md | 9 + .../operations/listmypipelinesresponse.md | 12 + .../listpipelinesdefaultapplicationjson.md | 10 + ...pelinesforprojectdefaultapplicationjson.md | 10 + ...pipelinesforprojectpipelinelistresponse.md | 11 + ...sforprojectpipelinelistresponsepipeline.md | 19 + ...ojectpipelinelistresponsepipelineerrors.md | 11 + ...tpipelinelistresponsepipelineerrorstype.md | 15 + ...rojectpipelinelistresponsepipelinestate.md | 14 + ...jectpipelinelistresponsepipelinetrigger.md | 12 + ...ipelinelistresponsepipelinetriggeractor.md | 11 + ...pipelinelistresponsepipelinetriggertype.md | 13 + ...rprojectpipelinelistresponsepipelinevcs.md | 18 + ...ctpipelinelistresponsepipelinevcscommit.md | 11 + .../listpipelinesforprojectrequest.md | 10 + .../listpipelinesforprojectresponse.md | 12 + .../listpipelinespipelinelistresponse.md | 11 + ...stpipelinespipelinelistresponsepipeline.md | 19 + ...linespipelinelistresponsepipelineerrors.md | 11 + ...spipelinelistresponsepipelineerrorstype.md | 15 + ...elinespipelinelistresponsepipelinestate.md | 14 + ...inespipelinelistresponsepipelinetrigger.md | 12 + ...ipelinelistresponsepipelinetriggeractor.md | 11 + ...pipelinelistresponsepipelinetriggertype.md | 13 + ...ipelinespipelinelistresponsepipelinevcs.md | 18 + ...espipelinelistresponsepipelinevcscommit.md | 11 + .../models/operations/listpipelinesrequest.md | 10 + .../operations/listpipelinesresponse.md | 12 + ...stschedulesforproject200applicationjson.md | 11 + ...lesforproject200applicationjsonschedule.md | 18 + ...ect200applicationjsonscheduletimetable1.md | 14 + ...icationjsonscheduletimetable1daysofweek.md | 16 + ...applicationjsonscheduletimetable1months.md | 21 + ...ect200applicationjsonscheduletimetable2.md | 14 + ...icationjsonscheduletimetable2daysofweek.md | 16 + ...applicationjsonscheduletimetable2months.md | 21 + ...orproject200applicationjsonscheduleuser.md | 12 + ...hedulesforprojectdefaultapplicationjson.md | 10 + .../listschedulesforprojectrequest.md | 9 + .../listschedulesforprojectresponse.md | 12 + .../listworkflowjobsdefaultapplicationjson.md | 10 + .../operations/listworkflowjobsrequest.md | 8 + .../operations/listworkflowjobsresponse.md | 12 + ...listworkflowjobsworkflowjoblistresponse.md | 11 + ...tworkflowjobsworkflowjoblistresponsejob.md | 21 + ...lowjobsworkflowjoblistresponsejobstatus.md | 23 + ...kflowjobsworkflowjoblistresponsejobtype.md | 11 + ...flowsbypipelineiddefaultapplicationjson.md | 10 + .../listworkflowsbypipelineidrequest.md | 9 + .../listworkflowsbypipelineidresponse.md | 12 + ...rkflowsbypipelineidworkflowlistresponse.md | 11 + ...ypipelineidworkflowlistresponseworkflow.md | 21 + ...ineidworkflowlistresponseworkflowstatus.md | 18 + ...pelineidworkflowlistresponseworkflowtag.md | 10 + .../makedecision400applicationjson.md | 11 + .../makedecision401applicationjson.md | 11 + .../makedecision500applicationjson.md | 10 + docs/models/operations/makedecisionrequest.md | 10 + .../operations/makedecisionrequestbody.md | 9 + .../makedecisionrequestbodymetadata.md | 7 + .../models/operations/makedecisionresponse.md | 14 + .../patchorgclaims400applicationjson.md | 11 + .../patchorgclaims403applicationjson.md | 11 + .../patchorgclaims500applicationjson.md | 10 + .../operations/patchorgclaimsrequest.md | 9 + .../operations/patchorgclaimsresponse.md | 14 + .../patchprojectclaims400applicationjson.md | 11 + .../patchprojectclaims403applicationjson.md | 11 + .../patchprojectclaims500applicationjson.md | 10 + .../operations/patchprojectclaimsrequest.md | 10 + .../operations/patchprojectclaimsresponse.md | 14 + .../rerunworkflow202applicationjson.md | 10 + .../rerunworkflowdefaultapplicationjson.md | 10 + .../models/operations/rerunworkflowrequest.md | 9 + .../rerunworkflowrerunworkflowparameters.md | 13 + .../operations/rerunworkflowresponse.md | 12 + .../setdecisionsettings400applicationjson.md | 11 + .../setdecisionsettings401applicationjson.md | 11 + .../setdecisionsettings403applicationjson.md | 11 + .../setdecisionsettings500applicationjson.md | 10 + .../operations/setdecisionsettingsrequest.md | 10 + .../operations/setdecisionsettingsresponse.md | 15 + .../triggerpipelinedefaultapplicationjson.md | 10 + .../triggerpipelinepipelinecreation.md | 13 + .../triggerpipelinepipelinecreationstate.md | 14 + .../operations/triggerpipelinerequest.md | 9 + .../operations/triggerpipelineresponse.md | 12 + ...riggerpipelinetriggerpipelineparameters.md | 12 + .../updatescheduledefaultapplicationjson.md | 10 + .../operations/updateschedulerequest.md | 9 + .../operations/updatescheduleresponse.md | 12 + .../operations/updatescheduleschedule.md | 18 + .../updateschedulescheduletimetable1.md | 14 + ...ateschedulescheduletimetable1daysofweek.md | 16 + .../updateschedulescheduletimetable1months.md | 21 + .../updateschedulescheduletimetable2.md | 14 + ...ateschedulescheduletimetable2daysofweek.md | 16 + .../updateschedulescheduletimetable2months.md | 21 + .../operations/updateschedulescheduleuser.md | 12 + .../updatescheduleupdatescheduleparameters.md | 14 + ...pdatescheduleparametersattributionactor.md | 11 + ...heduleupdatescheduleparameterstimetable.md | 14 + ...tescheduleparameterstimetabledaysofweek.md | 16 + ...updatescheduleparameterstimetablemonths.md | 21 + .../updatewebhookdefaultapplicationjson.md | 10 + .../models/operations/updatewebhookrequest.md | 9 + .../operations/updatewebhookrequestbody.md | 14 + .../updatewebhookrequestbodyevents.md | 9 + .../operations/updatewebhookresponse.md | 12 + .../models/operations/updatewebhookwebhook.md | 18 + .../operations/updatewebhookwebhookevents.md | 9 + .../operations/updatewebhookwebhookscope.md | 11 + docs/models/shared/bundlediff.md | 10 + docs/models/shared/bundlepayload.md | 8 + docs/models/shared/claimresponse.md | 13 + docs/models/shared/decision.md | 12 + docs/models/shared/decisionlog.md | 13 + docs/models/shared/decisionlogmetadata.md | 11 + docs/models/shared/decisionlogmetadatavcs.md | 11 + docs/models/shared/decisionsettings.md | 8 + docs/models/shared/patchclaimsrequest.md | 9 + docs/models/shared/policy.md | 11 + docs/models/shared/schemebasicauth.md | 9 + docs/models/shared/security.md | 10 + docs/models/shared/violation.md | 9 + docs/oidctokenmanagement/README.md | 187 ----- docs/pipeline/README.md | 289 ------- docs/policymanagement/README.md | 279 ------- docs/project/README.md | 256 ------ docs/schedule/README.md | 205 ----- docs/sdks/circleci/README.md | 9 + docs/sdks/context/README.md | 295 +++++++ docs/sdks/insights/README.md | 435 +++++++++++ docs/sdks/job/README.md | 165 ++++ docs/sdks/oidctokenmanagement/README.md | 260 +++++++ docs/sdks/pipeline/README.md | 374 +++++++++ docs/sdks/policymanagement/README.md | 392 ++++++++++ docs/sdks/project/README.md | 367 +++++++++ docs/sdks/schedule/README.md | 259 +++++++ docs/sdks/user/README.md | 122 +++ docs/sdks/webhook/README.md | 224 ++++++ docs/sdks/workflow/README.md | 209 +++++ docs/user/README.md | 84 -- docs/webhook/README.md | 169 ---- docs/workflow/README.md | 153 ---- files.gen | 540 ++++++++++++- gen.yaml | 13 +- package-lock.json | 4 +- package.json | 3 +- src/internal/utils/queryparams.ts | 26 +- src/internal/utils/requestbody.ts | 14 +- src/internal/utils/retries.ts | 13 +- src/internal/utils/security.ts | 83 +- src/internal/utils/utils.ts | 12 +- src/sdk/context.ts | 358 ++++++--- src/sdk/insights.ts | 490 ++++++++---- src/sdk/job.ts | 206 +++-- src/sdk/models/errors/index.ts | 5 + src/sdk/models/errors/sdkerror.ts | 31 + .../addenvironmentvariabletocontext.ts | 11 +- .../approvependingapprovaljobbyid.ts | 9 + src/sdk/models/operations/canceljob.ts | 9 + src/sdk/models/operations/cancelworkflow.ts | 9 + src/sdk/models/operations/continuepipeline.ts | 9 + .../models/operations/createcheckoutkey.ts | 9 + src/sdk/models/operations/createcontext.ts | 9 + src/sdk/models/operations/createenvvar.ts | 9 + .../models/operations/createpolicybundle.ts | 9 + src/sdk/models/operations/createschedule.ts | 9 + src/sdk/models/operations/createwebhook.ts | 9 + .../models/operations/deletecheckoutkey.ts | 9 + src/sdk/models/operations/deletecontext.ts | 9 + .../deleteenvironmentvariablefromcontext.ts | 9 + src/sdk/models/operations/deleteenvvar.ts | 9 + src/sdk/models/operations/deleteorgclaims.ts | 9 + .../models/operations/deleteprojectclaims.ts | 9 + .../models/operations/deleteschedulebyid.ts | 9 + src/sdk/models/operations/deletewebhook.ts | 9 + .../operations/getallinsightsbranches.ts | 9 + src/sdk/models/operations/getcheckoutkey.ts | 9 + .../models/operations/getcollaborations.ts | 9 + src/sdk/models/operations/getcontext.ts | 9 + src/sdk/models/operations/getcurrentuser.ts | 9 + src/sdk/models/operations/getdecisionlog.ts | 9 + .../operations/getdecisionlogpolicybundle.ts | 9 + src/sdk/models/operations/getdecisionlogs.ts | 15 + .../models/operations/getdecisionsettings.ts | 9 + src/sdk/models/operations/getenvvar.ts | 9 + src/sdk/models/operations/getflakytests.ts | 9 + src/sdk/models/operations/getjobartifacts.ts | 9 + src/sdk/models/operations/getjobdetails.ts | 9 + src/sdk/models/operations/getjobtimeseries.ts | 11 +- src/sdk/models/operations/getorgclaims.ts | 9 + .../models/operations/getorgsummarydata.ts | 20 +- src/sdk/models/operations/getpipelinebyid.ts | 9 + .../models/operations/getpipelinebynumber.ts | 9 + .../operations/getpipelineconfigbyid.ts | 9 + src/sdk/models/operations/getpolicybundle.ts | 9 + .../models/operations/getpolicydocument.ts | 9 + src/sdk/models/operations/getprojectbyslug.ts | 9 + src/sdk/models/operations/getprojectclaims.ts | 9 + .../getprojectworkflowjobmetrics.ts | 15 +- .../operations/getprojectworkflowmetrics.ts | 22 +- .../operations/getprojectworkflowruns.ts | 16 + .../operations/getprojectworkflowspagedata.ts | 29 +- .../getprojectworkflowtestmetrics.ts | 9 + src/sdk/models/operations/getschedulebyid.ts | 9 + src/sdk/models/operations/gettests.ts | 9 + src/sdk/models/operations/getuser.ts | 9 + src/sdk/models/operations/getwebhookbyid.ts | 9 + src/sdk/models/operations/getwebhooks.ts | 9 + src/sdk/models/operations/getworkflowbyid.ts | 9 + .../models/operations/getworkflowsummary.ts | 28 +- src/sdk/models/operations/listcheckoutkeys.ts | 9 + src/sdk/models/operations/listcontexts.ts | 9 + .../listenvironmentvariablesfromcontext.ts | 9 + src/sdk/models/operations/listenvvars.ts | 9 + src/sdk/models/operations/listmypipelines.ts | 9 + src/sdk/models/operations/listpipelines.ts | 9 + .../operations/listpipelinesforproject.ts | 9 + .../operations/listschedulesforproject.ts | 9 + src/sdk/models/operations/listworkflowjobs.ts | 9 + .../operations/listworkflowsbypipelineid.ts | 9 + src/sdk/models/operations/makedecision.ts | 16 +- src/sdk/models/operations/patchorgclaims.ts | 9 + .../models/operations/patchprojectclaims.ts | 9 + src/sdk/models/operations/rerunworkflow.ts | 9 + .../models/operations/setdecisionsettings.ts | 9 + src/sdk/models/operations/triggerpipeline.ts | 9 + src/sdk/models/operations/updateschedule.ts | 9 + src/sdk/models/operations/updatewebhook.ts | 9 + src/sdk/models/shared/bundlediff.ts | 3 - src/sdk/models/shared/claimresponse.ts | 3 - src/sdk/models/shared/decision.ts | 3 - src/sdk/models/shared/decisionlog.ts | 3 - src/sdk/models/shared/decisionsettings.ts | 3 - src/sdk/models/shared/policy.ts | 3 - src/sdk/oidctokenmanagement.ts | 442 ++++++++--- src/sdk/pipeline.ts | 446 ++++++++--- src/sdk/policymanagement.ts | 730 ++++++++++++++---- src/sdk/project.ts | 438 ++++++++--- src/sdk/schedule.ts | 264 +++++-- src/sdk/sdk.ts | 168 ++-- src/sdk/types/rfcdate.ts | 19 +- src/sdk/user.ts | 165 ++-- src/sdk/webhook.ts | 264 +++++-- src/sdk/workflow.ts | 256 ++++-- tsconfig.json | 1 + 642 files changed, 14467 insertions(+), 3681 deletions(-) create mode 100755 .gitattributes mode change 100644 => 100755 .gitignore delete mode 100755 docs/circleci/README.md delete mode 100755 docs/context/README.md delete mode 100755 docs/insights/README.md delete mode 100755 docs/job/README.md create mode 100755 docs/models/operations/addenvironmentvariabletocontext200applicationjson1.md create mode 100755 docs/models/operations/addenvironmentvariabletocontext200applicationjsonmessageresponse.md create mode 100755 docs/models/operations/addenvironmentvariabletocontextdefaultapplicationjson.md create mode 100755 docs/models/operations/addenvironmentvariabletocontextrequest.md create mode 100755 docs/models/operations/addenvironmentvariabletocontextrequestbody.md create mode 100755 docs/models/operations/addenvironmentvariabletocontextresponse.md create mode 100755 docs/models/operations/approvependingapprovaljobbyiddefaultapplicationjson.md create mode 100755 docs/models/operations/approvependingapprovaljobbyidmessageresponse.md create mode 100755 docs/models/operations/approvependingapprovaljobbyidrequest.md create mode 100755 docs/models/operations/approvependingapprovaljobbyidresponse.md create mode 100755 docs/models/operations/canceljobdefaultapplicationjson.md create mode 100755 docs/models/operations/canceljobmessageresponse.md create mode 100755 docs/models/operations/canceljobrequest.md create mode 100755 docs/models/operations/canceljobresponse.md create mode 100755 docs/models/operations/cancelworkflowdefaultapplicationjson.md create mode 100755 docs/models/operations/cancelworkflowmessageresponse.md create mode 100755 docs/models/operations/cancelworkflowrequest.md create mode 100755 docs/models/operations/cancelworkflowresponse.md create mode 100755 docs/models/operations/continuepipelinedefaultapplicationjson.md create mode 100755 docs/models/operations/continuepipelinemessageresponse.md create mode 100755 docs/models/operations/continuepipelinerequestbody.md create mode 100755 docs/models/operations/continuepipelineresponse.md create mode 100755 docs/models/operations/createcheckoutkeycheckoutkey.md create mode 100755 docs/models/operations/createcheckoutkeycheckoutkeycheckoutkeytype.md create mode 100755 docs/models/operations/createcheckoutkeycheckoutkeyinput.md create mode 100755 docs/models/operations/createcheckoutkeycheckoutkeyinputcheckoutkeyinputtype.md create mode 100755 docs/models/operations/createcheckoutkeydefaultapplicationjson.md create mode 100755 docs/models/operations/createcheckoutkeyrequest.md create mode 100755 docs/models/operations/createcheckoutkeyresponse.md create mode 100755 docs/models/operations/createcontextcontext.md create mode 100755 docs/models/operations/createcontextdefaultapplicationjson.md create mode 100755 docs/models/operations/createcontextrequestbody.md create mode 100755 docs/models/operations/createcontextrequestbodyowner1.md create mode 100755 docs/models/operations/createcontextrequestbodyowner1type.md create mode 100755 docs/models/operations/createcontextrequestbodyowner2.md create mode 100755 docs/models/operations/createcontextrequestbodyowner2type.md create mode 100755 docs/models/operations/createcontextresponse.md create mode 100755 docs/models/operations/createenvvardefaultapplicationjson.md create mode 100755 docs/models/operations/createenvvarenvironmentvariable.md create mode 100755 docs/models/operations/createenvvarenvironmentvariable1.md create mode 100755 docs/models/operations/createenvvarrequest.md create mode 100755 docs/models/operations/createenvvarresponse.md create mode 100755 docs/models/operations/createpolicybundle400applicationjson.md create mode 100755 docs/models/operations/createpolicybundle401applicationjson.md create mode 100755 docs/models/operations/createpolicybundle403applicationjson.md create mode 100755 docs/models/operations/createpolicybundle413applicationjson.md create mode 100755 docs/models/operations/createpolicybundle500applicationjson.md create mode 100755 docs/models/operations/createpolicybundlerequest.md create mode 100755 docs/models/operations/createpolicybundleresponse.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameters.md create mode 100755 docs/models/operations/createschedulecreatescheduleparametersattributionactor.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameterstimetable1.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameterstimetable1daysofweek.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameterstimetable1months.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameterstimetable2.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameterstimetable2daysofweek.md create mode 100755 docs/models/operations/createschedulecreatescheduleparameterstimetable2months.md create mode 100755 docs/models/operations/createscheduledefaultapplicationjson.md create mode 100755 docs/models/operations/createschedulerequest.md create mode 100755 docs/models/operations/createscheduleresponse.md create mode 100755 docs/models/operations/createscheduleschedule.md create mode 100755 docs/models/operations/createschedulescheduletimetable1.md create mode 100755 docs/models/operations/createschedulescheduletimetable1daysofweek.md create mode 100755 docs/models/operations/createschedulescheduletimetable1months.md create mode 100755 docs/models/operations/createschedulescheduletimetable2.md create mode 100755 docs/models/operations/createschedulescheduletimetable2daysofweek.md create mode 100755 docs/models/operations/createschedulescheduletimetable2months.md create mode 100755 docs/models/operations/createschedulescheduleuser.md create mode 100755 docs/models/operations/createwebhookdefaultapplicationjson.md create mode 100755 docs/models/operations/createwebhookrequestbody.md create mode 100755 docs/models/operations/createwebhookrequestbodyevents.md create mode 100755 docs/models/operations/createwebhookrequestbodyscope.md create mode 100755 docs/models/operations/createwebhookrequestbodyscopetype.md create mode 100755 docs/models/operations/createwebhookresponse.md create mode 100755 docs/models/operations/createwebhookwebhook.md create mode 100755 docs/models/operations/createwebhookwebhookevents.md create mode 100755 docs/models/operations/createwebhookwebhookscope.md create mode 100755 docs/models/operations/deletecheckoutkeydefaultapplicationjson.md create mode 100755 docs/models/operations/deletecheckoutkeymessageresponse.md create mode 100755 docs/models/operations/deletecheckoutkeyrequest.md create mode 100755 docs/models/operations/deletecheckoutkeyresponse.md create mode 100755 docs/models/operations/deletecontextdefaultapplicationjson.md create mode 100755 docs/models/operations/deletecontextmessageresponse.md create mode 100755 docs/models/operations/deletecontextrequest.md create mode 100755 docs/models/operations/deletecontextresponse.md create mode 100755 docs/models/operations/deleteenvironmentvariablefromcontextdefaultapplicationjson.md create mode 100755 docs/models/operations/deleteenvironmentvariablefromcontextmessageresponse.md create mode 100755 docs/models/operations/deleteenvironmentvariablefromcontextrequest.md create mode 100755 docs/models/operations/deleteenvironmentvariablefromcontextresponse.md create mode 100755 docs/models/operations/deleteenvvardefaultapplicationjson.md create mode 100755 docs/models/operations/deleteenvvarmessageresponse.md create mode 100755 docs/models/operations/deleteenvvarrequest.md create mode 100755 docs/models/operations/deleteenvvarresponse.md create mode 100755 docs/models/operations/deleteorgclaims400applicationjson.md create mode 100755 docs/models/operations/deleteorgclaims403applicationjson.md create mode 100755 docs/models/operations/deleteorgclaims500applicationjson.md create mode 100755 docs/models/operations/deleteorgclaimsrequest.md create mode 100755 docs/models/operations/deleteorgclaimsresponse.md create mode 100755 docs/models/operations/deleteprojectclaims400applicationjson.md create mode 100755 docs/models/operations/deleteprojectclaims403applicationjson.md create mode 100755 docs/models/operations/deleteprojectclaims500applicationjson.md create mode 100755 docs/models/operations/deleteprojectclaimsrequest.md create mode 100755 docs/models/operations/deleteprojectclaimsresponse.md create mode 100755 docs/models/operations/deleteschedulebyiddefaultapplicationjson.md create mode 100755 docs/models/operations/deleteschedulebyidmessageresponse.md create mode 100755 docs/models/operations/deleteschedulebyidrequest.md create mode 100755 docs/models/operations/deleteschedulebyidresponse.md create mode 100755 docs/models/operations/deletewebhookdefaultapplicationjson.md create mode 100755 docs/models/operations/deletewebhookmessageresponse.md create mode 100755 docs/models/operations/deletewebhookrequest.md create mode 100755 docs/models/operations/deletewebhookresponse.md create mode 100755 docs/models/operations/getallinsightsbranchesdefaultapplicationjson.md create mode 100755 docs/models/operations/getallinsightsbranchesrequest.md create mode 100755 docs/models/operations/getallinsightsbranchesresponse.md create mode 100755 docs/models/operations/getcheckoutkeycheckoutkey.md create mode 100755 docs/models/operations/getcheckoutkeycheckoutkeycheckoutkeytype.md create mode 100755 docs/models/operations/getcheckoutkeydefaultapplicationjson.md create mode 100755 docs/models/operations/getcheckoutkeyrequest.md create mode 100755 docs/models/operations/getcheckoutkeyresponse.md create mode 100755 docs/models/operations/getcollaborationscollaboration.md create mode 100755 docs/models/operations/getcollaborationsdefaultapplicationjson.md create mode 100755 docs/models/operations/getcollaborationsresponse.md create mode 100755 docs/models/operations/getcontextcontext.md create mode 100755 docs/models/operations/getcontextdefaultapplicationjson.md create mode 100755 docs/models/operations/getcontextrequest.md create mode 100755 docs/models/operations/getcontextresponse.md create mode 100755 docs/models/operations/getcurrentuserdefaultapplicationjson.md create mode 100755 docs/models/operations/getcurrentuserresponse.md create mode 100755 docs/models/operations/getcurrentuseruser.md create mode 100755 docs/models/operations/getdecisionlog400applicationjson.md create mode 100755 docs/models/operations/getdecisionlog401applicationjson.md create mode 100755 docs/models/operations/getdecisionlog403applicationjson.md create mode 100755 docs/models/operations/getdecisionlog404applicationjson.md create mode 100755 docs/models/operations/getdecisionlog500applicationjson.md create mode 100755 docs/models/operations/getdecisionlogpolicybundle400applicationjson.md create mode 100755 docs/models/operations/getdecisionlogpolicybundle401applicationjson.md create mode 100755 docs/models/operations/getdecisionlogpolicybundle403applicationjson.md create mode 100755 docs/models/operations/getdecisionlogpolicybundle404applicationjson.md create mode 100755 docs/models/operations/getdecisionlogpolicybundle500applicationjson.md create mode 100755 docs/models/operations/getdecisionlogpolicybundlerequest.md create mode 100755 docs/models/operations/getdecisionlogpolicybundleresponse.md create mode 100755 docs/models/operations/getdecisionlogrequest.md create mode 100755 docs/models/operations/getdecisionlogresponse.md create mode 100755 docs/models/operations/getdecisionlogs400applicationjson.md create mode 100755 docs/models/operations/getdecisionlogs401applicationjson.md create mode 100755 docs/models/operations/getdecisionlogs403applicationjson.md create mode 100755 docs/models/operations/getdecisionlogs500applicationjson.md create mode 100755 docs/models/operations/getdecisionlogsrequest.md create mode 100755 docs/models/operations/getdecisionlogsresponse.md create mode 100755 docs/models/operations/getdecisionsettings400applicationjson.md create mode 100755 docs/models/operations/getdecisionsettings401applicationjson.md create mode 100755 docs/models/operations/getdecisionsettings403applicationjson.md create mode 100755 docs/models/operations/getdecisionsettings500applicationjson.md create mode 100755 docs/models/operations/getdecisionsettingsrequest.md create mode 100755 docs/models/operations/getdecisionsettingsresponse.md create mode 100755 docs/models/operations/getenvvardefaultapplicationjson.md create mode 100755 docs/models/operations/getenvvarenvironmentvariable.md create mode 100755 docs/models/operations/getenvvarrequest.md create mode 100755 docs/models/operations/getenvvarresponse.md create mode 100755 docs/models/operations/getflakytests200applicationjson.md create mode 100755 docs/models/operations/getflakytests200applicationjsonflakytests.md create mode 100755 docs/models/operations/getflakytestsdefaultapplicationjson.md create mode 100755 docs/models/operations/getflakytestsrequest.md create mode 100755 docs/models/operations/getflakytestsresponse.md create mode 100755 docs/models/operations/getjobartifactsartifactlistresponse.md create mode 100755 docs/models/operations/getjobartifactsartifactlistresponseartifact.md create mode 100755 docs/models/operations/getjobartifactsdefaultapplicationjson.md create mode 100755 docs/models/operations/getjobartifactsrequest.md create mode 100755 docs/models/operations/getjobartifactsresponse.md create mode 100755 docs/models/operations/getjobdetailsdefaultapplicationjson.md create mode 100755 docs/models/operations/getjobdetailsjobdetails.md create mode 100755 docs/models/operations/getjobdetailsjobdetailscontexts.md create mode 100755 docs/models/operations/getjobdetailsjobdetailsexecutor.md create mode 100755 docs/models/operations/getjobdetailsjobdetailslatestworkflow.md create mode 100755 docs/models/operations/getjobdetailsjobdetailsmessages.md create mode 100755 docs/models/operations/getjobdetailsjobdetailsorganization.md create mode 100755 docs/models/operations/getjobdetailsjobdetailsparallelruns.md create mode 100755 docs/models/operations/getjobdetailsjobdetailspipeline.md create mode 100755 docs/models/operations/getjobdetailsjobdetailsproject.md create mode 100755 docs/models/operations/getjobdetailsjobdetailsstatus.md create mode 100755 docs/models/operations/getjobdetailsrequest.md create mode 100755 docs/models/operations/getjobdetailsresponse.md create mode 100755 docs/models/operations/getjobtimeseries200applicationjson.md create mode 100755 docs/models/operations/getjobtimeseries200applicationjsonitems.md create mode 100755 docs/models/operations/getjobtimeseries200applicationjsonitemsmetrics.md create mode 100755 docs/models/operations/getjobtimeseries200applicationjsonitemsmetricsdurationmetrics.md create mode 100755 docs/models/operations/getjobtimeseriesdefaultapplicationjson.md create mode 100755 docs/models/operations/getjobtimeseriesgranularity.md create mode 100755 docs/models/operations/getjobtimeseriesrequest.md create mode 100755 docs/models/operations/getjobtimeseriesresponse.md create mode 100755 docs/models/operations/getorgclaims400applicationjson.md create mode 100755 docs/models/operations/getorgclaims403applicationjson.md create mode 100755 docs/models/operations/getorgclaims500applicationjson.md create mode 100755 docs/models/operations/getorgclaimsrequest.md create mode 100755 docs/models/operations/getorgclaimsresponse.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjson.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjsonorgdata.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjsonorgdatametrics.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjsonorgdatatrends.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjsonorgprojectdata.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatametrics.md create mode 100755 docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatatrends.md create mode 100755 docs/models/operations/getorgsummarydatadefaultapplicationjson.md create mode 100755 docs/models/operations/getorgsummarydataprojectnames.md create mode 100755 docs/models/operations/getorgsummarydatareportingwindow.md create mode 100755 docs/models/operations/getorgsummarydatarequest.md create mode 100755 docs/models/operations/getorgsummarydataresponse.md create mode 100755 docs/models/operations/getpipelinebyiddefaultapplicationjson.md create mode 100755 docs/models/operations/getpipelinebyidpipeline.md create mode 100755 docs/models/operations/getpipelinebyidpipelineerrors.md create mode 100755 docs/models/operations/getpipelinebyidpipelineerrorstype.md create mode 100755 docs/models/operations/getpipelinebyidpipelinestate.md create mode 100755 docs/models/operations/getpipelinebyidpipelinetrigger.md create mode 100755 docs/models/operations/getpipelinebyidpipelinetriggeractor.md create mode 100755 docs/models/operations/getpipelinebyidpipelinetriggertype.md create mode 100755 docs/models/operations/getpipelinebyidpipelinevcs.md create mode 100755 docs/models/operations/getpipelinebyidpipelinevcscommit.md create mode 100755 docs/models/operations/getpipelinebyidrequest.md create mode 100755 docs/models/operations/getpipelinebyidresponse.md create mode 100755 docs/models/operations/getpipelinebynumberdefaultapplicationjson.md create mode 100755 docs/models/operations/getpipelinebynumberpipeline.md create mode 100755 docs/models/operations/getpipelinebynumberpipelineerrors.md create mode 100755 docs/models/operations/getpipelinebynumberpipelineerrorstype.md create mode 100755 docs/models/operations/getpipelinebynumberpipelinestate.md create mode 100755 docs/models/operations/getpipelinebynumberpipelinetrigger.md create mode 100755 docs/models/operations/getpipelinebynumberpipelinetriggeractor.md create mode 100755 docs/models/operations/getpipelinebynumberpipelinetriggertype.md create mode 100755 docs/models/operations/getpipelinebynumberpipelinevcs.md create mode 100755 docs/models/operations/getpipelinebynumberpipelinevcscommit.md create mode 100755 docs/models/operations/getpipelinebynumberrequest.md create mode 100755 docs/models/operations/getpipelinebynumberresponse.md create mode 100755 docs/models/operations/getpipelineconfigbyiddefaultapplicationjson.md create mode 100755 docs/models/operations/getpipelineconfigbyidpipelineconfig.md create mode 100755 docs/models/operations/getpipelineconfigbyidrequest.md create mode 100755 docs/models/operations/getpipelineconfigbyidresponse.md create mode 100755 docs/models/operations/getpolicybundle400applicationjson.md create mode 100755 docs/models/operations/getpolicybundle401applicationjson.md create mode 100755 docs/models/operations/getpolicybundle403applicationjson.md create mode 100755 docs/models/operations/getpolicybundle500applicationjson.md create mode 100755 docs/models/operations/getpolicybundlerequest.md create mode 100755 docs/models/operations/getpolicybundleresponse.md create mode 100755 docs/models/operations/getpolicydocument400applicationjson.md create mode 100755 docs/models/operations/getpolicydocument401applicationjson.md create mode 100755 docs/models/operations/getpolicydocument403applicationjson.md create mode 100755 docs/models/operations/getpolicydocument404applicationjson.md create mode 100755 docs/models/operations/getpolicydocument500applicationjson.md create mode 100755 docs/models/operations/getpolicydocumentrequest.md create mode 100755 docs/models/operations/getpolicydocumentresponse.md create mode 100755 docs/models/operations/getprojectbyslugdefaultapplicationjson.md create mode 100755 docs/models/operations/getprojectbyslugproject.md create mode 100755 docs/models/operations/getprojectbyslugprojectvcsinfo.md create mode 100755 docs/models/operations/getprojectbyslugprojectvcsinfoprovider.md create mode 100755 docs/models/operations/getprojectbyslugrequest.md create mode 100755 docs/models/operations/getprojectbyslugresponse.md create mode 100755 docs/models/operations/getprojectclaims400applicationjson.md create mode 100755 docs/models/operations/getprojectclaims403applicationjson.md create mode 100755 docs/models/operations/getprojectclaims500applicationjson.md create mode 100755 docs/models/operations/getprojectclaimsrequest.md create mode 100755 docs/models/operations/getprojectclaimsresponse.md create mode 100755 docs/models/operations/getprojectworkflowjobmetrics200applicationjson.md create mode 100755 docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitems.md create mode 100755 docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetrics.md create mode 100755 docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetricsdurationmetrics.md create mode 100755 docs/models/operations/getprojectworkflowjobmetricsdefaultapplicationjson.md create mode 100755 docs/models/operations/getprojectworkflowjobmetricsreportingwindow.md create mode 100755 docs/models/operations/getprojectworkflowjobmetricsrequest.md create mode 100755 docs/models/operations/getprojectworkflowjobmetricsresponse.md create mode 100755 docs/models/operations/getprojectworkflowmetrics200applicationjson.md create mode 100755 docs/models/operations/getprojectworkflowmetrics200applicationjsonitems.md create mode 100755 docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetrics.md create mode 100755 docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetricsdurationmetrics.md create mode 100755 docs/models/operations/getprojectworkflowmetricsdefaultapplicationjson.md create mode 100755 docs/models/operations/getprojectworkflowmetricsreportingwindow.md create mode 100755 docs/models/operations/getprojectworkflowmetricsrequest.md create mode 100755 docs/models/operations/getprojectworkflowmetricsresponse.md create mode 100755 docs/models/operations/getprojectworkflowruns200applicationjson.md create mode 100755 docs/models/operations/getprojectworkflowruns200applicationjsonitems.md create mode 100755 docs/models/operations/getprojectworkflowruns200applicationjsonitemsstatus.md create mode 100755 docs/models/operations/getprojectworkflowrunsdefaultapplicationjson.md create mode 100755 docs/models/operations/getprojectworkflowrunsrequest.md create mode 100755 docs/models/operations/getprojectworkflowrunsresponse.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjson.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdata.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatametrics.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatatrends.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdata.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatametrics.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatatrends.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdata.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatametrics.md create mode 100755 docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatatrends.md create mode 100755 docs/models/operations/getprojectworkflowspagedatabranches.md create mode 100755 docs/models/operations/getprojectworkflowspagedatadefaultapplicationjson.md create mode 100755 docs/models/operations/getprojectworkflowspagedatareportingwindow.md create mode 100755 docs/models/operations/getprojectworkflowspagedatarequest.md create mode 100755 docs/models/operations/getprojectworkflowspagedataresponse.md create mode 100755 docs/models/operations/getprojectworkflowspagedataworkflownames.md create mode 100755 docs/models/operations/getprojectworkflowtestmetrics200applicationjson.md create mode 100755 docs/models/operations/getprojectworkflowtestmetrics200applicationjsonmostfailedtests.md create mode 100755 docs/models/operations/getprojectworkflowtestmetrics200applicationjsonslowesttests.md create mode 100755 docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestruns.md create mode 100755 docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestrunstestcounts.md create mode 100755 docs/models/operations/getprojectworkflowtestmetricsdefaultapplicationjson.md create mode 100755 docs/models/operations/getprojectworkflowtestmetricsrequest.md create mode 100755 docs/models/operations/getprojectworkflowtestmetricsresponse.md create mode 100755 docs/models/operations/getschedulebyiddefaultapplicationjson.md create mode 100755 docs/models/operations/getschedulebyidrequest.md create mode 100755 docs/models/operations/getschedulebyidresponse.md create mode 100755 docs/models/operations/getschedulebyidschedule.md create mode 100755 docs/models/operations/getschedulebyidscheduletimetable1.md create mode 100755 docs/models/operations/getschedulebyidscheduletimetable1daysofweek.md create mode 100755 docs/models/operations/getschedulebyidscheduletimetable1months.md create mode 100755 docs/models/operations/getschedulebyidscheduletimetable2.md create mode 100755 docs/models/operations/getschedulebyidscheduletimetable2daysofweek.md create mode 100755 docs/models/operations/getschedulebyidscheduletimetable2months.md create mode 100755 docs/models/operations/getschedulebyidscheduleuser.md create mode 100755 docs/models/operations/gettestsdefaultapplicationjson.md create mode 100755 docs/models/operations/gettestsrequest.md create mode 100755 docs/models/operations/gettestsresponse.md create mode 100755 docs/models/operations/getteststestsresponse.md create mode 100755 docs/models/operations/getteststestsresponseitems.md create mode 100755 docs/models/operations/getuserdefaultapplicationjson.md create mode 100755 docs/models/operations/getuserrequest.md create mode 100755 docs/models/operations/getuserresponse.md create mode 100755 docs/models/operations/getuseruser.md create mode 100755 docs/models/operations/getwebhookbyiddefaultapplicationjson.md create mode 100755 docs/models/operations/getwebhookbyidrequest.md create mode 100755 docs/models/operations/getwebhookbyidresponse.md create mode 100755 docs/models/operations/getwebhookbyidwebhook.md create mode 100755 docs/models/operations/getwebhookbyidwebhookevents.md create mode 100755 docs/models/operations/getwebhookbyidwebhookscope.md create mode 100755 docs/models/operations/getwebhooks200applicationjson.md create mode 100755 docs/models/operations/getwebhooks200applicationjsonwebhook.md create mode 100755 docs/models/operations/getwebhooks200applicationjsonwebhookevents.md create mode 100755 docs/models/operations/getwebhooks200applicationjsonwebhookscope.md create mode 100755 docs/models/operations/getwebhooksdefaultapplicationjson.md create mode 100755 docs/models/operations/getwebhooksrequest.md create mode 100755 docs/models/operations/getwebhooksresponse.md create mode 100755 docs/models/operations/getwebhooksscopetype.md create mode 100755 docs/models/operations/getworkflowbyiddefaultapplicationjson.md create mode 100755 docs/models/operations/getworkflowbyidrequest.md create mode 100755 docs/models/operations/getworkflowbyidresponse.md create mode 100755 docs/models/operations/getworkflowbyidworkflow.md create mode 100755 docs/models/operations/getworkflowbyidworkflowstatus.md create mode 100755 docs/models/operations/getworkflowbyidworkflowtag.md create mode 100755 docs/models/operations/getworkflowsummary200applicationjson.md create mode 100755 docs/models/operations/getworkflowsummary200applicationjsonmetrics.md create mode 100755 docs/models/operations/getworkflowsummary200applicationjsonmetricsdurationmetrics.md create mode 100755 docs/models/operations/getworkflowsummary200applicationjsontrends.md create mode 100755 docs/models/operations/getworkflowsummarydefaultapplicationjson.md create mode 100755 docs/models/operations/getworkflowsummaryrequest.md create mode 100755 docs/models/operations/getworkflowsummaryresponse.md create mode 100755 docs/models/operations/listcheckoutkeyscheckoutkeylistresponse.md create mode 100755 docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkey.md create mode 100755 docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkeycheckoutkeytype.md create mode 100755 docs/models/operations/listcheckoutkeysdefaultapplicationjson.md create mode 100755 docs/models/operations/listcheckoutkeysrequest.md create mode 100755 docs/models/operations/listcheckoutkeysresponse.md create mode 100755 docs/models/operations/listcontexts200applicationjson.md create mode 100755 docs/models/operations/listcontexts200applicationjsoncontext.md create mode 100755 docs/models/operations/listcontextsdefaultapplicationjson.md create mode 100755 docs/models/operations/listcontextsownertype.md create mode 100755 docs/models/operations/listcontextsrequest.md create mode 100755 docs/models/operations/listcontextsresponse.md create mode 100755 docs/models/operations/listenvironmentvariablesfromcontext200applicationjson.md create mode 100755 docs/models/operations/listenvironmentvariablesfromcontext200applicationjsonitems.md create mode 100755 docs/models/operations/listenvironmentvariablesfromcontextdefaultapplicationjson.md create mode 100755 docs/models/operations/listenvironmentvariablesfromcontextrequest.md create mode 100755 docs/models/operations/listenvironmentvariablesfromcontextresponse.md create mode 100755 docs/models/operations/listenvvarsdefaultapplicationjson.md create mode 100755 docs/models/operations/listenvvarsenvironmentvariablelistresponse.md create mode 100755 docs/models/operations/listenvvarsenvironmentvariablelistresponseenvironmentvariable.md create mode 100755 docs/models/operations/listenvvarsrequest.md create mode 100755 docs/models/operations/listenvvarsresponse.md create mode 100755 docs/models/operations/listmypipelinesdefaultapplicationjson.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponse.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipeline.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelineerrors.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelineerrorstype.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelinestate.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelinetrigger.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggeractor.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggertype.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelinevcs.md create mode 100755 docs/models/operations/listmypipelinespipelinelistresponsepipelinevcscommit.md create mode 100755 docs/models/operations/listmypipelinesrequest.md create mode 100755 docs/models/operations/listmypipelinesresponse.md create mode 100755 docs/models/operations/listpipelinesdefaultapplicationjson.md create mode 100755 docs/models/operations/listpipelinesforprojectdefaultapplicationjson.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponse.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipeline.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrors.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrorstype.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinestate.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetrigger.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggeractor.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggertype.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcs.md create mode 100755 docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcscommit.md create mode 100755 docs/models/operations/listpipelinesforprojectrequest.md create mode 100755 docs/models/operations/listpipelinesforprojectresponse.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponse.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipeline.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelineerrors.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelineerrorstype.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelinestate.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelinetrigger.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelinetriggeractor.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelinetriggertype.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelinevcs.md create mode 100755 docs/models/operations/listpipelinespipelinelistresponsepipelinevcscommit.md create mode 100755 docs/models/operations/listpipelinesrequest.md create mode 100755 docs/models/operations/listpipelinesresponse.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjson.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonschedule.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1daysofweek.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1months.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2daysofweek.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2months.md create mode 100755 docs/models/operations/listschedulesforproject200applicationjsonscheduleuser.md create mode 100755 docs/models/operations/listschedulesforprojectdefaultapplicationjson.md create mode 100755 docs/models/operations/listschedulesforprojectrequest.md create mode 100755 docs/models/operations/listschedulesforprojectresponse.md create mode 100755 docs/models/operations/listworkflowjobsdefaultapplicationjson.md create mode 100755 docs/models/operations/listworkflowjobsrequest.md create mode 100755 docs/models/operations/listworkflowjobsresponse.md create mode 100755 docs/models/operations/listworkflowjobsworkflowjoblistresponse.md create mode 100755 docs/models/operations/listworkflowjobsworkflowjoblistresponsejob.md create mode 100755 docs/models/operations/listworkflowjobsworkflowjoblistresponsejobstatus.md create mode 100755 docs/models/operations/listworkflowjobsworkflowjoblistresponsejobtype.md create mode 100755 docs/models/operations/listworkflowsbypipelineiddefaultapplicationjson.md create mode 100755 docs/models/operations/listworkflowsbypipelineidrequest.md create mode 100755 docs/models/operations/listworkflowsbypipelineidresponse.md create mode 100755 docs/models/operations/listworkflowsbypipelineidworkflowlistresponse.md create mode 100755 docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflow.md create mode 100755 docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowstatus.md create mode 100755 docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowtag.md create mode 100755 docs/models/operations/makedecision400applicationjson.md create mode 100755 docs/models/operations/makedecision401applicationjson.md create mode 100755 docs/models/operations/makedecision500applicationjson.md create mode 100755 docs/models/operations/makedecisionrequest.md create mode 100755 docs/models/operations/makedecisionrequestbody.md create mode 100755 docs/models/operations/makedecisionrequestbodymetadata.md create mode 100755 docs/models/operations/makedecisionresponse.md create mode 100755 docs/models/operations/patchorgclaims400applicationjson.md create mode 100755 docs/models/operations/patchorgclaims403applicationjson.md create mode 100755 docs/models/operations/patchorgclaims500applicationjson.md create mode 100755 docs/models/operations/patchorgclaimsrequest.md create mode 100755 docs/models/operations/patchorgclaimsresponse.md create mode 100755 docs/models/operations/patchprojectclaims400applicationjson.md create mode 100755 docs/models/operations/patchprojectclaims403applicationjson.md create mode 100755 docs/models/operations/patchprojectclaims500applicationjson.md create mode 100755 docs/models/operations/patchprojectclaimsrequest.md create mode 100755 docs/models/operations/patchprojectclaimsresponse.md create mode 100755 docs/models/operations/rerunworkflow202applicationjson.md create mode 100755 docs/models/operations/rerunworkflowdefaultapplicationjson.md create mode 100755 docs/models/operations/rerunworkflowrequest.md create mode 100755 docs/models/operations/rerunworkflowrerunworkflowparameters.md create mode 100755 docs/models/operations/rerunworkflowresponse.md create mode 100755 docs/models/operations/setdecisionsettings400applicationjson.md create mode 100755 docs/models/operations/setdecisionsettings401applicationjson.md create mode 100755 docs/models/operations/setdecisionsettings403applicationjson.md create mode 100755 docs/models/operations/setdecisionsettings500applicationjson.md create mode 100755 docs/models/operations/setdecisionsettingsrequest.md create mode 100755 docs/models/operations/setdecisionsettingsresponse.md create mode 100755 docs/models/operations/triggerpipelinedefaultapplicationjson.md create mode 100755 docs/models/operations/triggerpipelinepipelinecreation.md create mode 100755 docs/models/operations/triggerpipelinepipelinecreationstate.md create mode 100755 docs/models/operations/triggerpipelinerequest.md create mode 100755 docs/models/operations/triggerpipelineresponse.md create mode 100755 docs/models/operations/triggerpipelinetriggerpipelineparameters.md create mode 100755 docs/models/operations/updatescheduledefaultapplicationjson.md create mode 100755 docs/models/operations/updateschedulerequest.md create mode 100755 docs/models/operations/updatescheduleresponse.md create mode 100755 docs/models/operations/updatescheduleschedule.md create mode 100755 docs/models/operations/updateschedulescheduletimetable1.md create mode 100755 docs/models/operations/updateschedulescheduletimetable1daysofweek.md create mode 100755 docs/models/operations/updateschedulescheduletimetable1months.md create mode 100755 docs/models/operations/updateschedulescheduletimetable2.md create mode 100755 docs/models/operations/updateschedulescheduletimetable2daysofweek.md create mode 100755 docs/models/operations/updateschedulescheduletimetable2months.md create mode 100755 docs/models/operations/updateschedulescheduleuser.md create mode 100755 docs/models/operations/updatescheduleupdatescheduleparameters.md create mode 100755 docs/models/operations/updatescheduleupdatescheduleparametersattributionactor.md create mode 100755 docs/models/operations/updatescheduleupdatescheduleparameterstimetable.md create mode 100755 docs/models/operations/updatescheduleupdatescheduleparameterstimetabledaysofweek.md create mode 100755 docs/models/operations/updatescheduleupdatescheduleparameterstimetablemonths.md create mode 100755 docs/models/operations/updatewebhookdefaultapplicationjson.md create mode 100755 docs/models/operations/updatewebhookrequest.md create mode 100755 docs/models/operations/updatewebhookrequestbody.md create mode 100755 docs/models/operations/updatewebhookrequestbodyevents.md create mode 100755 docs/models/operations/updatewebhookresponse.md create mode 100755 docs/models/operations/updatewebhookwebhook.md create mode 100755 docs/models/operations/updatewebhookwebhookevents.md create mode 100755 docs/models/operations/updatewebhookwebhookscope.md create mode 100755 docs/models/shared/bundlediff.md create mode 100755 docs/models/shared/bundlepayload.md create mode 100755 docs/models/shared/claimresponse.md create mode 100755 docs/models/shared/decision.md create mode 100755 docs/models/shared/decisionlog.md create mode 100755 docs/models/shared/decisionlogmetadata.md create mode 100755 docs/models/shared/decisionlogmetadatavcs.md create mode 100755 docs/models/shared/decisionsettings.md create mode 100755 docs/models/shared/patchclaimsrequest.md create mode 100755 docs/models/shared/policy.md create mode 100755 docs/models/shared/schemebasicauth.md create mode 100755 docs/models/shared/security.md create mode 100755 docs/models/shared/violation.md delete mode 100755 docs/oidctokenmanagement/README.md delete mode 100755 docs/pipeline/README.md delete mode 100755 docs/policymanagement/README.md delete mode 100755 docs/project/README.md delete mode 100755 docs/schedule/README.md create mode 100755 docs/sdks/circleci/README.md create mode 100755 docs/sdks/context/README.md create mode 100755 docs/sdks/insights/README.md create mode 100755 docs/sdks/job/README.md create mode 100755 docs/sdks/oidctokenmanagement/README.md create mode 100755 docs/sdks/pipeline/README.md create mode 100755 docs/sdks/policymanagement/README.md create mode 100755 docs/sdks/project/README.md create mode 100755 docs/sdks/schedule/README.md create mode 100755 docs/sdks/user/README.md create mode 100755 docs/sdks/webhook/README.md create mode 100755 docs/sdks/workflow/README.md delete mode 100755 docs/user/README.md delete mode 100755 docs/webhook/README.md delete mode 100755 docs/workflow/README.md create mode 100755 src/sdk/models/errors/index.ts create mode 100755 src/sdk/models/errors/sdkerror.ts diff --git a/.gitattributes b/.gitattributes new file mode 100755 index 00000000..113eead5 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# This allows generated code to be indexed correctly +*.ts linguist-generated=false \ No newline at end of file diff --git a/.gitignore b/.gitignore old mode 100644 new mode 100755 diff --git a/README.md b/README.md index 74beafbb..ddd7bed8 100755 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ import { AddEnvironmentVariableToContextResponse } from "circleci-v2-sdk/dist/sd const sdk = new Circleci({ security: { - apiKeyHeader: "YOUR_API_KEY_HERE", + apiKeyHeader: "", }, }); @@ -33,8 +33,8 @@ sdk.context.addEnvironmentVariableToContext({ requestBody: { value: "some-secret-value", }, - contextId: "89bd9d8d-69a6-474e-8f46-7cc8796ed151", - envVarName: "deserunt", + contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96", + envVarName: "Pants reproachfully", }).then((res: AddEnvironmentVariableToContextResponse) => { if (res.statusCode == 200) { // handle response @@ -47,110 +47,132 @@ sdk.context.addEnvironmentVariableToContext({ ## Available Resources and Operations -### [context](docs/context/README.md) - -* [addEnvironmentVariableToContext](docs/context/README.md#addenvironmentvariabletocontext) - Add or update an environment variable -* [createContext](docs/context/README.md#createcontext) - Create a new context -* [deleteContext](docs/context/README.md#deletecontext) - Delete a context -* [deleteEnvironmentVariableFromContext](docs/context/README.md#deleteenvironmentvariablefromcontext) - Remove an environment variable -* [getContext](docs/context/README.md#getcontext) - Get a context -* [listContexts](docs/context/README.md#listcontexts) - List contexts -* [listEnvironmentVariablesFromContext](docs/context/README.md#listenvironmentvariablesfromcontext) - List environment variables - -### [insights](docs/insights/README.md) - -* [getAllInsightsBranches](docs/insights/README.md#getallinsightsbranches) - Get all branches for a project -* [getFlakyTests](docs/insights/README.md#getflakytests) - Get flaky tests for a project -* [getJobTimeseries](docs/insights/README.md#getjobtimeseries) - Job timeseries data -* [getOrgSummaryData](docs/insights/README.md#getorgsummarydata) - Get summary metrics with trends for the entire org, and for each project. -* [getProjectWorkflowJobMetrics](docs/insights/README.md#getprojectworkflowjobmetrics) - Get summary metrics for a project workflow's jobs. -* [getProjectWorkflowMetrics](docs/insights/README.md#getprojectworkflowmetrics) - Get summary metrics for a project's workflows -* [getProjectWorkflowRuns](docs/insights/README.md#getprojectworkflowruns) - Get recent runs of a workflow -* [getProjectWorkflowTestMetrics](docs/insights/README.md#getprojectworkflowtestmetrics) - Get test metrics for a project's workflows -* [getProjectWorkflowsPageData](docs/insights/README.md#getprojectworkflowspagedata) - Get summary metrics and trends for a project across it's workflows and branches -* [getWorkflowSummary](docs/insights/README.md#getworkflowsummary) - Get metrics and trends for workflows - -### [job](docs/job/README.md) - -* [cancelJob](docs/job/README.md#canceljob) - Cancel job -* [getJobArtifacts](docs/job/README.md#getjobartifacts) - Get a job's artifacts -* [getJobDetails](docs/job/README.md#getjobdetails) - Get job details -* [getTests](docs/job/README.md#gettests) - Get test metadata - -### [oidcTokenManagement](docs/oidctokenmanagement/README.md) - -* [deleteOrgClaims](docs/oidctokenmanagement/README.md#deleteorgclaims) - Delete org-level claims -* [deleteProjectClaims](docs/oidctokenmanagement/README.md#deleteprojectclaims) - Delete project-level claims -* [getOrgClaims](docs/oidctokenmanagement/README.md#getorgclaims) - Get org-level claims -* [getProjectClaims](docs/oidctokenmanagement/README.md#getprojectclaims) - Get project-level claims -* [patchOrgClaims](docs/oidctokenmanagement/README.md#patchorgclaims) - Patch org-level claims -* [patchProjectClaims](docs/oidctokenmanagement/README.md#patchprojectclaims) - Patch project-level claims - -### [pipeline](docs/pipeline/README.md) - -* [continuePipeline](docs/pipeline/README.md#continuepipeline) - Continue a pipeline -* [getPipelineById](docs/pipeline/README.md#getpipelinebyid) - Get a pipeline by ID -* [getPipelineByNumber](docs/pipeline/README.md#getpipelinebynumber) - Get a pipeline by pipeline number -* [getPipelineConfigById](docs/pipeline/README.md#getpipelineconfigbyid) - Get a pipeline's configuration -* [listMyPipelines](docs/pipeline/README.md#listmypipelines) - Get your pipelines -* [listPipelines](docs/pipeline/README.md#listpipelines) - Get a list of pipelines -* [listPipelinesForProject](docs/pipeline/README.md#listpipelinesforproject) - Get all pipelines -* [listWorkflowsByPipelineId](docs/pipeline/README.md#listworkflowsbypipelineid) - Get a pipeline's workflows -* [triggerPipeline](docs/pipeline/README.md#triggerpipeline) - Trigger a new pipeline - -### [policyManagement](docs/policymanagement/README.md) - -* [createPolicyBundle](docs/policymanagement/README.md#createpolicybundle) - Creates policy bundle for the context -* [getDecisionLog](docs/policymanagement/README.md#getdecisionlog) - Retrieves the owner's decision audit log by given decisionID -* [getDecisionLogPolicyBundle](docs/policymanagement/README.md#getdecisionlogpolicybundle) - Retrieves Policy Bundle for a given decision log ID -* [getDecisionLogs](docs/policymanagement/README.md#getdecisionlogs) - Retrieves the owner's decision audit logs. -* [getDecisionSettings](docs/policymanagement/README.md#getdecisionsettings) - Get the decision settings -* [getPolicyBundle](docs/policymanagement/README.md#getpolicybundle) - Retrieves Policy Bundle -* [getPolicyDocument](docs/policymanagement/README.md#getpolicydocument) - Retrieves a policy document -* [makeDecision](docs/policymanagement/README.md#makedecision) - Makes a decision -* [setDecisionSettings](docs/policymanagement/README.md#setdecisionsettings) - Set the decision settings - -### [project](docs/project/README.md) - -* [createCheckoutKey](docs/project/README.md#createcheckoutkey) - Create a new checkout key -* [createEnvVar](docs/project/README.md#createenvvar) - Create an environment variable -* [deleteCheckoutKey](docs/project/README.md#deletecheckoutkey) - Delete a checkout key -* [deleteEnvVar](docs/project/README.md#deleteenvvar) - Delete an environment variable -* [getCheckoutKey](docs/project/README.md#getcheckoutkey) - Get a checkout key -* [getEnvVar](docs/project/README.md#getenvvar) - Get a masked environment variable -* [getProjectBySlug](docs/project/README.md#getprojectbyslug) - Get a project -* [listCheckoutKeys](docs/project/README.md#listcheckoutkeys) - Get all checkout keys -* [listEnvVars](docs/project/README.md#listenvvars) - List all environment variables - -### [schedule](docs/schedule/README.md) - -* [createSchedule](docs/schedule/README.md#createschedule) - Create a schedule -* [deleteScheduleById](docs/schedule/README.md#deleteschedulebyid) - Delete a schedule -* [getScheduleById](docs/schedule/README.md#getschedulebyid) - Get a schedule -* [listSchedulesForProject](docs/schedule/README.md#listschedulesforproject) - Get all schedules -* [updateSchedule](docs/schedule/README.md#updateschedule) - Update a schedule - -### [user](docs/user/README.md) - -* [getCollaborations](docs/user/README.md#getcollaborations) - Collaborations -* [getCurrentUser](docs/user/README.md#getcurrentuser) - User Information -* [getUser](docs/user/README.md#getuser) - User Information - -### [webhook](docs/webhook/README.md) - -* [createWebhook](docs/webhook/README.md#createwebhook) - Create a webhook -* [deleteWebhook](docs/webhook/README.md#deletewebhook) - Delete a webhook -* [getWebhookById](docs/webhook/README.md#getwebhookbyid) - Get a webhook -* [getWebhooks](docs/webhook/README.md#getwebhooks) - List webhooks -* [updateWebhook](docs/webhook/README.md#updatewebhook) - Update a webhook - -### [workflow](docs/workflow/README.md) - -* [approvePendingApprovalJobById](docs/workflow/README.md#approvependingapprovaljobbyid) - Approve a job -* [cancelWorkflow](docs/workflow/README.md#cancelworkflow) - Cancel a workflow -* [getWorkflowById](docs/workflow/README.md#getworkflowbyid) - Get a workflow -* [listWorkflowJobs](docs/workflow/README.md#listworkflowjobs) - Get a workflow's jobs -* [rerunWorkflow](docs/workflow/README.md#rerunworkflow) - Rerun a workflow +### [context](docs/sdks/context/README.md) + +* [addEnvironmentVariableToContext](docs/sdks/context/README.md#addenvironmentvariabletocontext) - Add or update an environment variable +* [createContext](docs/sdks/context/README.md#createcontext) - Create a new context +* [deleteContext](docs/sdks/context/README.md#deletecontext) - Delete a context +* [deleteEnvironmentVariableFromContext](docs/sdks/context/README.md#deleteenvironmentvariablefromcontext) - Remove an environment variable +* [getContext](docs/sdks/context/README.md#getcontext) - Get a context +* [listContexts](docs/sdks/context/README.md#listcontexts) - List contexts +* [listEnvironmentVariablesFromContext](docs/sdks/context/README.md#listenvironmentvariablesfromcontext) - List environment variables + +### [insights](docs/sdks/insights/README.md) + +* [getAllInsightsBranches](docs/sdks/insights/README.md#getallinsightsbranches) - Get all branches for a project +* [getFlakyTests](docs/sdks/insights/README.md#getflakytests) - Get flaky tests for a project +* [getJobTimeseries](docs/sdks/insights/README.md#getjobtimeseries) - Job timeseries data +* [getOrgSummaryData](docs/sdks/insights/README.md#getorgsummarydata) - Get summary metrics with trends for the entire org, and for each project. +* [getProjectWorkflowJobMetrics](docs/sdks/insights/README.md#getprojectworkflowjobmetrics) - Get summary metrics for a project workflow's jobs. +* [getProjectWorkflowMetrics](docs/sdks/insights/README.md#getprojectworkflowmetrics) - Get summary metrics for a project's workflows +* [getProjectWorkflowRuns](docs/sdks/insights/README.md#getprojectworkflowruns) - Get recent runs of a workflow +* [getProjectWorkflowTestMetrics](docs/sdks/insights/README.md#getprojectworkflowtestmetrics) - Get test metrics for a project's workflows +* [getProjectWorkflowsPageData](docs/sdks/insights/README.md#getprojectworkflowspagedata) - Get summary metrics and trends for a project across it's workflows and branches +* [getWorkflowSummary](docs/sdks/insights/README.md#getworkflowsummary) - Get metrics and trends for workflows + +### [job](docs/sdks/job/README.md) + +* [cancelJob](docs/sdks/job/README.md#canceljob) - Cancel job +* [getJobArtifacts](docs/sdks/job/README.md#getjobartifacts) - Get a job's artifacts +* [getJobDetails](docs/sdks/job/README.md#getjobdetails) - Get job details +* [getTests](docs/sdks/job/README.md#gettests) - Get test metadata + +### [oidcTokenManagement](docs/sdks/oidctokenmanagement/README.md) + +* [deleteOrgClaims](docs/sdks/oidctokenmanagement/README.md#deleteorgclaims) - Delete org-level claims +* [deleteProjectClaims](docs/sdks/oidctokenmanagement/README.md#deleteprojectclaims) - Delete project-level claims +* [getOrgClaims](docs/sdks/oidctokenmanagement/README.md#getorgclaims) - Get org-level claims +* [getProjectClaims](docs/sdks/oidctokenmanagement/README.md#getprojectclaims) - Get project-level claims +* [patchOrgClaims](docs/sdks/oidctokenmanagement/README.md#patchorgclaims) - Patch org-level claims +* [patchProjectClaims](docs/sdks/oidctokenmanagement/README.md#patchprojectclaims) - Patch project-level claims + +### [pipeline](docs/sdks/pipeline/README.md) + +* [continuePipeline](docs/sdks/pipeline/README.md#continuepipeline) - Continue a pipeline +* [getPipelineById](docs/sdks/pipeline/README.md#getpipelinebyid) - Get a pipeline by ID +* [getPipelineByNumber](docs/sdks/pipeline/README.md#getpipelinebynumber) - Get a pipeline by pipeline number +* [getPipelineConfigById](docs/sdks/pipeline/README.md#getpipelineconfigbyid) - Get a pipeline's configuration +* [listMyPipelines](docs/sdks/pipeline/README.md#listmypipelines) - Get your pipelines +* [listPipelines](docs/sdks/pipeline/README.md#listpipelines) - Get a list of pipelines +* [listPipelinesForProject](docs/sdks/pipeline/README.md#listpipelinesforproject) - Get all pipelines +* [listWorkflowsByPipelineId](docs/sdks/pipeline/README.md#listworkflowsbypipelineid) - Get a pipeline's workflows +* [triggerPipeline](docs/sdks/pipeline/README.md#triggerpipeline) - Trigger a new pipeline + +### [policyManagement](docs/sdks/policymanagement/README.md) + +* [createPolicyBundle](docs/sdks/policymanagement/README.md#createpolicybundle) - Creates policy bundle for the context +* [getDecisionLog](docs/sdks/policymanagement/README.md#getdecisionlog) - Retrieves the owner's decision audit log by given decisionID +* [getDecisionLogPolicyBundle](docs/sdks/policymanagement/README.md#getdecisionlogpolicybundle) - Retrieves Policy Bundle for a given decision log ID +* [getDecisionLogs](docs/sdks/policymanagement/README.md#getdecisionlogs) - Retrieves the owner's decision audit logs. +* [getDecisionSettings](docs/sdks/policymanagement/README.md#getdecisionsettings) - Get the decision settings +* [getPolicyBundle](docs/sdks/policymanagement/README.md#getpolicybundle) - Retrieves Policy Bundle +* [getPolicyDocument](docs/sdks/policymanagement/README.md#getpolicydocument) - Retrieves a policy document +* [makeDecision](docs/sdks/policymanagement/README.md#makedecision) - Makes a decision +* [setDecisionSettings](docs/sdks/policymanagement/README.md#setdecisionsettings) - Set the decision settings + +### [project](docs/sdks/project/README.md) + +* [createCheckoutKey](docs/sdks/project/README.md#createcheckoutkey) - Create a new checkout key +* [createEnvVar](docs/sdks/project/README.md#createenvvar) - Create an environment variable +* [deleteCheckoutKey](docs/sdks/project/README.md#deletecheckoutkey) - Delete a checkout key +* [deleteEnvVar](docs/sdks/project/README.md#deleteenvvar) - Delete an environment variable +* [getCheckoutKey](docs/sdks/project/README.md#getcheckoutkey) - Get a checkout key +* [getEnvVar](docs/sdks/project/README.md#getenvvar) - Get a masked environment variable +* [getProjectBySlug](docs/sdks/project/README.md#getprojectbyslug) - Get a project +* [listCheckoutKeys](docs/sdks/project/README.md#listcheckoutkeys) - Get all checkout keys +* [listEnvVars](docs/sdks/project/README.md#listenvvars) - List all environment variables + +### [schedule](docs/sdks/schedule/README.md) + +* [createSchedule](docs/sdks/schedule/README.md#createschedule) - Create a schedule +* [deleteScheduleById](docs/sdks/schedule/README.md#deleteschedulebyid) - Delete a schedule +* [getScheduleById](docs/sdks/schedule/README.md#getschedulebyid) - Get a schedule +* [listSchedulesForProject](docs/sdks/schedule/README.md#listschedulesforproject) - Get all schedules +* [updateSchedule](docs/sdks/schedule/README.md#updateschedule) - Update a schedule + +### [user](docs/sdks/user/README.md) + +* [getCollaborations](docs/sdks/user/README.md#getcollaborations) - Collaborations +* [getCurrentUser](docs/sdks/user/README.md#getcurrentuser) - User Information +* [getUser](docs/sdks/user/README.md#getuser) - User Information + +### [webhook](docs/sdks/webhook/README.md) + +* [createWebhook](docs/sdks/webhook/README.md#createwebhook) - Create a webhook +* [deleteWebhook](docs/sdks/webhook/README.md#deletewebhook) - Delete a webhook +* [getWebhookById](docs/sdks/webhook/README.md#getwebhookbyid) - Get a webhook +* [getWebhooks](docs/sdks/webhook/README.md#getwebhooks) - List webhooks +* [updateWebhook](docs/sdks/webhook/README.md#updatewebhook) - Update a webhook + +### [workflow](docs/sdks/workflow/README.md) + +* [approvePendingApprovalJobById](docs/sdks/workflow/README.md#approvependingapprovaljobbyid) - Approve a job +* [cancelWorkflow](docs/sdks/workflow/README.md#cancelworkflow) - Cancel a workflow +* [getWorkflowById](docs/sdks/workflow/README.md#getworkflowbyid) - Get a workflow +* [listWorkflowJobs](docs/sdks/workflow/README.md#listworkflowjobs) - Get a workflow's jobs +* [rerunWorkflow](docs/sdks/workflow/README.md#rerunworkflow) - Rerun a workflow + + + + + + + + + +# Pagination + +Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the +returned response object will have a `next` method that can be called to pull down the next group of results. If the +return value of `next` is `null`, then there are no more pages to be fetched. + +Here's an example of one such pagination call: + + + + + + ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/RELEASES.md b/RELEASES.md index 91300c28..ef8e1170 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -544,3 +544,656 @@ Based on: - Speakeasy CLI 1.40.2 (2.34.2) https://github.com/speakeasy-api/speakeasy ### Releases - [NPM v3.30.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.30.1 - . + + +## 2023-06-03 00:53:57 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.43.0 (2.35.3) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.31.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.31.0 - . + +## 2023-06-06 00:56:25 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.44.0 (2.35.3) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.31.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.31.1 - . + +## 2023-06-07 00:57:18 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.44.2 (2.35.9) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.31.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.31.2 - . + +## 2023-06-08 00:55:17 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.45.0 (2.37.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.32.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.32.0 - . + +## 2023-06-09 00:57:12 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.45.2 (2.37.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.32.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.32.1 - . + +## 2023-06-10 00:51:43 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.47.0 (2.39.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.33.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.33.0 - . + +## 2023-06-11 00:59:35 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.47.1 (2.39.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.33.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.33.1 - . + +## 2023-06-14 00:53:14 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.47.3 (2.40.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.34.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.34.0 - . + +## 2023-06-16 00:54:05 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.48.0 (2.41.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.35.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.35.0 - . + +## 2023-06-20 00:52:01 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.35.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.35.1 - . + +## 2023-06-21 00:54:26 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.35.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.35.2 - . + +## 2023-06-23 00:59:25 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.36.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.36.0 - . + +## 2023-06-24 00:58:39 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.36.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.36.1 - . + +## 2023-06-27 01:00:04 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.37.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.37.0 - . + +## 2023-06-28 01:03:09 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.37.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.37.1 - . + +## 2023-06-29 00:58:32 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.38.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.38.0 - . + +## 2023-07-01 01:04:54 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.39.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.39.0 - . + +## 2023-07-04 01:01:53 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.39.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.39.1 - . + +## 2023-07-06 01:01:46 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.52.2 (2.57.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.40.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.40.0 - . + +## 2023-07-07 01:02:19 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.41.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.41.0 - . + +## 2023-07-08 00:59:55 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.53.1 (2.58.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.41.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.41.1 - . + +## 2023-07-11 00:54:56 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.56.0 (2.61.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.42.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.42.0 - . + +## 2023-07-12 01:00:10 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.56.4 (2.61.5) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.42.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.42.1 - . + +## 2023-07-13 01:00:43 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.57.0 (2.62.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.43.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.43.0 - . + +## 2023-07-14 01:01:27 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.44.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.44.0 - . + +## 2023-07-15 00:59:32 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.44.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.44.1 - . + +## 2023-07-18 01:16:15 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.61.0 (2.70.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.45.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.45.0 - . + +## 2023-07-19 01:48:02 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.62.1 (2.70.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.45.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.45.1 - . + +## 2023-07-21 00:53:06 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.62.1 (2.70.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.45.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.45.2 - . + +## 2023-07-22 00:52:54 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.64.0 (2.71.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.46.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.46.0 - . + +## 2023-07-26 00:52:39 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.65.0 (2.73.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.47.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.47.0 - . + +## 2023-07-27 00:45:33 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.65.1 (2.73.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.47.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.47.1 - . + +## 2023-07-28 00:46:01 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.48.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.48.0 - . + +## 2023-07-29 00:46:24 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.48.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.48.1 - . + +## 2023-08-01 00:53:24 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.66.1 (2.75.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.48.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.48.2 - . + +## 2023-08-02 00:47:47 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.66.3 (2.75.2) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.48.3] https://www.npmjs.com/package/circleci-v2-sdk/v/3.48.3 - . + +## 2023-08-03 00:47:46 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.68.1 (2.77.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.49.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.49.0 - . + +## 2023-08-04 00:48:01 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.68.3 (2.81.1) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.50.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.50.0 - . + +## 2023-08-08 00:46:43 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.69.1 (2.82.0) https://github.com/speakeasy-api/speakeasy +### Releases +- [NPM v3.51.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.51.0 - . + +## 2023-08-11 00:38:30 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.71.0 (2.83.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.51.1] . +### Releases +- [NPM v3.51.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.51.1 - . + +## 2023-08-12 00:37:43 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.71.0 (2.83.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.51.2] . +### Releases +- [NPM v3.51.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.51.2 - . + +## 2023-08-15 00:38:51 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.72.0 (2.84.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.0] . +### Releases +- [NPM v3.52.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.0 - . + +## 2023-08-16 00:38:40 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.73.1 (2.84.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.1] . +### Releases +- [NPM v3.52.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.1 - . + +## 2023-08-17 00:38:07 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.73.1 (2.84.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.2] . +### Releases +- [NPM v3.52.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.2 - . + +## 2023-08-19 00:37:07 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.3 (2.86.6) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.3] . +### Releases +- [NPM v3.52.3] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.3 - . + +## 2023-08-22 00:39:38 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.6 (2.86.6) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.4] . +### Releases +- [NPM v3.52.4] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.4 - . + +## 2023-08-23 00:38:56 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.7 (2.86.6) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.5] . +### Releases +- [NPM v3.52.5] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.5 - . + +## 2023-08-24 00:38:59 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.9 (2.86.10) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.6] . +### Releases +- [NPM v3.52.6] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.6 - . + +## 2023-08-25 00:39:42 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.11 (2.87.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.52.7] . +### Releases +- [NPM v3.52.7] https://www.npmjs.com/package/circleci-v2-sdk/v/3.52.7 - . + +## 2023-08-26 00:37:57 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.16 (2.88.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.53.0] . +### Releases +- [NPM v3.53.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.53.0 - . + +## 2023-08-30 00:39:45 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.74.19 (2.88.7) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.53.1] . +### Releases +- [NPM v3.53.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.53.1 - . + +## 2023-08-31 00:40:05 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.76.0 (2.89.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.54.0] . +### Releases +- [NPM v3.54.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.54.0 - . + +## 2023-09-01 00:42:52 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.77.0 (2.91.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.55.0] . +### Releases +- [NPM v3.55.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.55.0 - . + +## 2023-09-02 00:38:32 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.77.2 (2.93.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.55.1] . +### Releases +- [NPM v3.55.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.55.1 - . + +## 2023-09-05 00:39:34 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.78.3 (2.96.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.0] . +### Releases +- [NPM v3.56.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.0 - . + +## 2023-09-07 00:39:40 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.79.0 (2.101.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.1] . +### Releases +- [NPM v3.56.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.1 - . + +## 2023-09-08 00:39:46 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.82.0 (2.107.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.2] . +### Releases +- [NPM v3.56.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.2 - . + +## 2023-09-09 00:38:46 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.82.3 (2.107.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.3] . +### Releases +- [NPM v3.56.3] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.3 - . + +## 2023-09-12 00:38:55 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.4] . +### Releases +- [NPM v3.56.4] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.4 - . + +## 2023-09-14 00:40:09 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.83.2 (2.109.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.5] . +### Releases +- [NPM v3.56.5] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.5 - . + +## 2023-09-15 00:40:36 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.83.3 (2.112.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.6] . +### Releases +- [NPM v3.56.6] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.6 - . + +## 2023-09-16 00:39:14 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.86.0 (2.115.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.7] . +### Releases +- [NPM v3.56.7] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.7 - . + +## 2023-09-19 00:41:04 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.87.0 (2.116.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.8] . +### Releases +- [NPM v3.56.8] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.8 - . + +## 2023-09-20 00:40:23 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.88.0 (2.118.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.9] . +### Releases +- [NPM v3.56.9] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.9 - . + +## 2023-09-21 00:40:17 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.88.1 (2.122.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.10] . +### Releases +- [NPM v3.56.10] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.10 - . + +## 2023-09-22 00:40:37 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.89.0 (2.125.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.56.11] . +### Releases +- [NPM v3.56.11] https://www.npmjs.com/package/circleci-v2-sdk/v/3.56.11 - . + +## 2023-09-26 00:41:08 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.91.0 (2.129.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.57.0] . +### Releases +- [NPM v3.57.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.57.0 - . + +## 2023-09-27 00:41:09 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.91.2 (2.131.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.57.1] . +### Releases +- [NPM v3.57.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.57.1 - . + +## 2023-09-28 00:40:45 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.91.2 (2.131.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.57.2] . +### Releases +- [NPM v3.57.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.57.2 - . + +## 2023-09-29 00:40:53 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.91.3 (2.139.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.58.0] . +### Releases +- [NPM v3.58.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.58.0 - . + +## 2023-10-01 00:46:53 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.92.2 (2.142.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.59.0] . +### Releases +- [NPM v3.59.0] https://www.npmjs.com/package/circleci-v2-sdk/v/3.59.0 - . + +## 2023-10-02 00:41:33 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.92.3 (2.143.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.59.1] . +### Releases +- [NPM v3.59.1] https://www.npmjs.com/package/circleci-v2-sdk/v/3.59.1 - . + +## 2023-10-05 00:40:53 +### Changes +Based on: +- OpenAPI Doc v2 https://circleci.com/api/v2/openapi.json +- Speakeasy CLI 1.94.0 (2.147.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v3.59.2] . +### Releases +- [NPM v3.59.2] https://www.npmjs.com/package/circleci-v2-sdk/v/3.59.2 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 32b78bcd..032eefb7 100755 --- a/USAGE.md +++ b/USAGE.md @@ -1,11 +1,13 @@ + + ```typescript import { Circleci } from "circleci-v2-sdk"; import { AddEnvironmentVariableToContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; const sdk = new Circleci({ security: { - apiKeyHeader: "YOUR_API_KEY_HERE", + apiKeyHeader: "", }, }); @@ -13,8 +15,8 @@ sdk.context.addEnvironmentVariableToContext({ requestBody: { value: "some-secret-value", }, - contextId: "89bd9d8d-69a6-474e-8f46-7cc8796ed151", - envVarName: "deserunt", + contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96", + envVarName: "Pants reproachfully", }).then((res: AddEnvironmentVariableToContextResponse) => { if (res.statusCode == 200) { // handle response diff --git a/docs/circleci/README.md b/docs/circleci/README.md deleted file mode 100755 index c68e5e51..00000000 --- a/docs/circleci/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Circleci SDK - -## Overview - -This describes the resources that make up the CircleCI API v2. - -### Available Operations - diff --git a/docs/context/README.md b/docs/context/README.md deleted file mode 100755 index 54f042a2..00000000 --- a/docs/context/README.md +++ /dev/null @@ -1,203 +0,0 @@ -# context - -### Available Operations - -* [addEnvironmentVariableToContext](#addenvironmentvariabletocontext) - Add or update an environment variable -* [createContext](#createcontext) - Create a new context -* [deleteContext](#deletecontext) - Delete a context -* [deleteEnvironmentVariableFromContext](#deleteenvironmentvariablefromcontext) - Remove an environment variable -* [getContext](#getcontext) - Get a context -* [listContexts](#listcontexts) - List contexts -* [listEnvironmentVariablesFromContext](#listenvironmentvariablesfromcontext) - List environment variables - -## addEnvironmentVariableToContext - -Create or update an environment variable within a context. Returns information about the environment variable, not including its value. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { AddEnvironmentVariableToContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.addEnvironmentVariableToContext({ - requestBody: { - value: "some-secret-value", - }, - contextId: "05dfc2dd-f7cc-478c-a1ba-928fc816742c", - envVarName: "cum", -}).then((res: AddEnvironmentVariableToContextResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## createContext - -Create a new context - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - CreateContextRequestBodyOwner1Type, - CreateContextRequestBodyOwner2Type, - CreateContextResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.createContext({ - name: "Edna Mante II", - owner: { - slug: "sed", - type: CreateContextRequestBodyOwner2Type.Organization, - }, -}).then((res: CreateContextResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteContext - -Delete a context - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.deleteContext({ - contextId: "9396fea7-596e-4b10-baaa-2352c5955907", -}).then((res: DeleteContextResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteEnvironmentVariableFromContext - -Delete an environment variable from a context. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteEnvironmentVariableFromContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.deleteEnvironmentVariableFromContext({ - contextId: "aff1a3a2-fa94-4677-b925-1aa52c3f5ad0", - envVarName: "quasi", -}).then((res: DeleteEnvironmentVariableFromContextResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getContext - -Returns basic information about a context. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.getContext({ - contextId: "9da1ffe7-8f09-47b0-874f-15471b5e6e13", -}).then((res: GetContextResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listContexts - -List all contexts for an owner. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { ListContextsOwnerType, ListContextsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.listContexts({ - ownerId: "b99d488e-1e91-4e45-8ad2-abd44269802d", - ownerSlug: "ipsam", - ownerType: ListContextsOwnerType.Account, - pageToken: "fugit", -}).then((res: ListContextsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listEnvironmentVariablesFromContext - -List information about environment variables in a context, not including their values. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { ListEnvironmentVariablesFromContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.context.listEnvironmentVariablesFromContext({ - contextId: "a94bb4f6-3c96-49e9-a3ef-a77dfb14cd66", - pageToken: "laborum", -}).then((res: ListEnvironmentVariablesFromContextResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/insights/README.md b/docs/insights/README.md deleted file mode 100755 index 5f3715cf..00000000 --- a/docs/insights/README.md +++ /dev/null @@ -1,323 +0,0 @@ -# insights - -### Available Operations - -* [getAllInsightsBranches](#getallinsightsbranches) - Get all branches for a project -* [getFlakyTests](#getflakytests) - Get flaky tests for a project -* [getJobTimeseries](#getjobtimeseries) - Job timeseries data -* [getOrgSummaryData](#getorgsummarydata) - Get summary metrics with trends for the entire org, and for each project. -* [getProjectWorkflowJobMetrics](#getprojectworkflowjobmetrics) - Get summary metrics for a project workflow's jobs. -* [getProjectWorkflowMetrics](#getprojectworkflowmetrics) - Get summary metrics for a project's workflows -* [getProjectWorkflowRuns](#getprojectworkflowruns) - Get recent runs of a workflow -* [getProjectWorkflowTestMetrics](#getprojectworkflowtestmetrics) - Get test metrics for a project's workflows -* [getProjectWorkflowsPageData](#getprojectworkflowspagedata) - Get summary metrics and trends for a project across it's workflows and branches -* [getWorkflowSummary](#getworkflowsummary) - Get metrics and trends for workflows - -## getAllInsightsBranches - -Get a list of all branches for a specified project. The list will only contain branches currently available within Insights. The maximum number of branches returned by this endpoint is 5,000. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetAllInsightsBranchesResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getAllInsightsBranches({ - projectSlug: "accusamus", - workflowName: "non", -}).then((res: GetAllInsightsBranchesResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getFlakyTests - -Get a list of flaky tests for a given project. Flaky tests are branch agnostic. - A flaky test is a test that passed and failed in the same commit. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetFlakyTestsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getFlakyTests({ - projectSlug: "occaecati", -}).then((res: GetFlakyTestsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getJobTimeseries - -Get timeseries data for all jobs within a workflow. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetJobTimeseriesGranularity, GetJobTimeseriesResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getJobTimeseries({ - branch: "enim", - endDate: new Date("2020-02-08T20:51:42.354Z"), - granularity: GetJobTimeseriesGranularity.Hourly, - projectSlug: "provident", - startDate: new Date("2021-09-06T10:36:33.442Z"), - workflowName: "blanditiis", -}).then((res: GetJobTimeseriesResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getOrgSummaryData - -Gets aggregated summary metrics with trends for the entire org. - Also gets aggregated metrics and trends for each project belonging to the org. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetOrgSummaryDataReportingWindow, GetOrgSummaryDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getOrgSummaryData({ - orgSlug: "deleniti", - projectNames: { - "amet": "deserunt", - "nisi": "vel", - "natus": "omnis", - "molestiae": "perferendis", - }, - reportingWindow: GetOrgSummaryDataReportingWindow.Last24Hours, -}).then((res: GetOrgSummaryDataResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectWorkflowJobMetrics - -Get summary metrics for a project workflow's jobs. Job runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - GetProjectWorkflowJobMetricsReportingWindow, - GetProjectWorkflowJobMetricsResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getProjectWorkflowJobMetrics({ - allBranches: false, - branch: "magnam", - pageToken: "distinctio", - projectSlug: "id", - reportingWindow: GetProjectWorkflowJobMetricsReportingWindow.Last90Days, - workflowName: "labore", -}).then((res: GetProjectWorkflowJobMetricsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectWorkflowMetrics - -Get summary metrics for a project's workflows. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetProjectWorkflowMetricsReportingWindow, GetProjectWorkflowMetricsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getProjectWorkflowMetrics({ - allBranches: false, - branch: "suscipit", - pageToken: "natus", - projectSlug: "nobis", - reportingWindow: GetProjectWorkflowMetricsReportingWindow.Last24Hours, -}).then((res: GetProjectWorkflowMetricsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectWorkflowRuns - -Get recent runs of a workflow. Runs going back at most 90 days are returned. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - GetProjectWorkflowRuns200ApplicationJSONItemsStatus, - GetProjectWorkflowRunsResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getProjectWorkflowRuns({ - allBranches: false, - branch: "vero", - endDate: new Date("2022-11-24T10:55:00.183Z"), - pageToken: "magnam", - projectSlug: "et", - startDate: new Date("2022-04-17T13:06:08.135Z"), - workflowName: "provident", -}).then((res: GetProjectWorkflowRunsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectWorkflowTestMetrics - -Get test metrics for a project's workflows. Currently tests metrics are calculated based on 10 most recent workflow runs. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetProjectWorkflowTestMetricsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getProjectWorkflowTestMetrics({ - allBranches: false, - branch: "quos", - projectSlug: "sint", - workflowName: "accusantium", -}).then((res: GetProjectWorkflowTestMetricsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectWorkflowsPageData - -Get summary metrics and trends for a project at workflow and branch level. - Workflow runs going back at most 90 days are included in the aggregation window. - Trends are only supported upto last 30 days. - Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetProjectWorkflowsPageDataReportingWindow, GetProjectWorkflowsPageDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getProjectWorkflowsPageData({ - branches: { - "reiciendis": "mollitia", - "ad": "eum", - "dolor": "necessitatibus", - }, - projectSlug: "odit", - reportingWindow: GetProjectWorkflowsPageDataReportingWindow.Last90Days, - workflowNames: { - "iure": "doloribus", - }, -}).then((res: GetProjectWorkflowsPageDataResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getWorkflowSummary - -Get the metrics and trends for a particular workflow on a single branch or all branches - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetWorkflowSummaryResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.insights.getWorkflowSummary({ - allBranches: false, - branches: { - "eius": "maxime", - "deleniti": "facilis", - "in": "architecto", - "architecto": "repudiandae", - }, - projectSlug: "ullam", - workflowName: "expedita", -}).then((res: GetWorkflowSummaryResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/job/README.md b/docs/job/README.md deleted file mode 100755 index cc62f54d..00000000 --- a/docs/job/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# job - -### Available Operations - -* [cancelJob](#canceljob) - Cancel job -* [getJobArtifacts](#getjobartifacts) - Get a job's artifacts -* [getJobDetails](#getjobdetails) - Get job details -* [getTests](#gettests) - Get test metadata - -## cancelJob - -Cancel job with a given job number. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { CancelJobResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.job.cancelJob({ - jobNumber: "nihil", - projectSlug: "repellat", -}).then((res: CancelJobResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getJobArtifacts - -Returns a job's artifacts. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetJobArtifactsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.job.getJobArtifacts({ - jobNumber: "quibusdam", - projectSlug: "sed", -}).then((res: GetJobArtifactsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getJobDetails - -Returns job details. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetJobDetailsJobDetailsStatus, GetJobDetailsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.job.getJobDetails({ - jobNumber: "saepe", - projectSlug: "pariatur", -}).then((res: GetJobDetailsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getTests - -Get test metadata for a build. In the rare case where there is more than 250MB of test data on the job, no results will be returned. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetTestsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.job.getTests({ - jobNumber: "accusantium", - projectSlug: "consequuntur", -}).then((res: GetTestsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/models/operations/addenvironmentvariabletocontext200applicationjson1.md b/docs/models/operations/addenvironmentvariabletocontext200applicationjson1.md new file mode 100755 index 00000000..6c6eab48 --- /dev/null +++ b/docs/models/operations/addenvironmentvariabletocontext200applicationjson1.md @@ -0,0 +1,11 @@ +# AddEnvironmentVariableToContext200ApplicationJson1 + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the environment variable was created. | 2015-09-21T17:29:21.042Z | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the environment variable was updated | 2015-09-21T17:29:21.042Z | +| `variable` | *string* | :heavy_check_mark: | The name of the environment variable | POSTGRES_USER | \ No newline at end of file diff --git a/docs/models/operations/addenvironmentvariabletocontext200applicationjsonmessageresponse.md b/docs/models/operations/addenvironmentvariabletocontext200applicationjsonmessageresponse.md new file mode 100755 index 00000000..2d9b2407 --- /dev/null +++ b/docs/models/operations/addenvironmentvariabletocontext200applicationjsonmessageresponse.md @@ -0,0 +1,10 @@ +# AddEnvironmentVariableToContext200ApplicationJSONMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/addenvironmentvariabletocontextdefaultapplicationjson.md b/docs/models/operations/addenvironmentvariabletocontextdefaultapplicationjson.md new file mode 100755 index 00000000..9c20e81d --- /dev/null +++ b/docs/models/operations/addenvironmentvariabletocontextdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# AddEnvironmentVariableToContextDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/addenvironmentvariabletocontextrequest.md b/docs/models/operations/addenvironmentvariabletocontextrequest.md new file mode 100755 index 00000000..93c6f215 --- /dev/null +++ b/docs/models/operations/addenvironmentvariabletocontextrequest.md @@ -0,0 +1,10 @@ +# AddEnvironmentVariableToContextRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `requestBody` | [AddEnvironmentVariableToContextRequestBody](../../models/operations/addenvironmentvariabletocontextrequestbody.md) | :heavy_minus_sign: | N/A | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | +| `envVarName` | *string* | :heavy_check_mark: | The name of the environment variable | \ No newline at end of file diff --git a/docs/models/operations/addenvironmentvariabletocontextrequestbody.md b/docs/models/operations/addenvironmentvariabletocontextrequestbody.md new file mode 100755 index 00000000..622b88e6 --- /dev/null +++ b/docs/models/operations/addenvironmentvariabletocontextrequestbody.md @@ -0,0 +1,8 @@ +# AddEnvironmentVariableToContextRequestBody + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `value` | *string* | :heavy_check_mark: | The value of the environment variable | some-secret-value | \ No newline at end of file diff --git a/docs/models/operations/addenvironmentvariabletocontextresponse.md b/docs/models/operations/addenvironmentvariabletocontextresponse.md new file mode 100755 index 00000000..d65cdcab --- /dev/null +++ b/docs/models/operations/addenvironmentvariabletocontextresponse.md @@ -0,0 +1,12 @@ +# AddEnvironmentVariableToContextResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `addEnvironmentVariableToContext200ApplicationJSONOneOf` | *any* | :heavy_minus_sign: | The new environment variable | +| `addEnvironmentVariableToContextDefaultApplicationJSONObject` | [AddEnvironmentVariableToContextDefaultApplicationJSON](../../models/operations/addenvironmentvariabletocontextdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/approvependingapprovaljobbyiddefaultapplicationjson.md b/docs/models/operations/approvependingapprovaljobbyiddefaultapplicationjson.md new file mode 100755 index 00000000..a01cd3aa --- /dev/null +++ b/docs/models/operations/approvependingapprovaljobbyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ApprovePendingApprovalJobByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/approvependingapprovaljobbyidmessageresponse.md b/docs/models/operations/approvependingapprovaljobbyidmessageresponse.md new file mode 100755 index 00000000..5436b3af --- /dev/null +++ b/docs/models/operations/approvependingapprovaljobbyidmessageresponse.md @@ -0,0 +1,10 @@ +# ApprovePendingApprovalJobByIdMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/approvependingapprovaljobbyidrequest.md b/docs/models/operations/approvependingapprovaljobbyidrequest.md new file mode 100755 index 00000000..0b068579 --- /dev/null +++ b/docs/models/operations/approvependingapprovaljobbyidrequest.md @@ -0,0 +1,9 @@ +# ApprovePendingApprovalJobByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | +| `approvalRequestId` | *string* | :heavy_check_mark: | The ID of the job being approved. | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/approvependingapprovaljobbyidresponse.md b/docs/models/operations/approvependingapprovaljobbyidresponse.md new file mode 100755 index 00000000..17980528 --- /dev/null +++ b/docs/models/operations/approvependingapprovaljobbyidresponse.md @@ -0,0 +1,12 @@ +# ApprovePendingApprovalJobByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [ApprovePendingApprovalJobByIdMessageResponse](../../models/operations/approvependingapprovaljobbyidmessageresponse.md) | :heavy_minus_sign: | A confirmation message. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `approvePendingApprovalJobByIdDefaultApplicationJSONObject` | [ApprovePendingApprovalJobByIdDefaultApplicationJSON](../../models/operations/approvependingapprovaljobbyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/canceljobdefaultapplicationjson.md b/docs/models/operations/canceljobdefaultapplicationjson.md new file mode 100755 index 00000000..cf10de0d --- /dev/null +++ b/docs/models/operations/canceljobdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CancelJobDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/canceljobmessageresponse.md b/docs/models/operations/canceljobmessageresponse.md new file mode 100755 index 00000000..e7e0719b --- /dev/null +++ b/docs/models/operations/canceljobmessageresponse.md @@ -0,0 +1,10 @@ +# CancelJobMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/canceljobrequest.md b/docs/models/operations/canceljobrequest.md new file mode 100755 index 00000000..3180fc93 --- /dev/null +++ b/docs/models/operations/canceljobrequest.md @@ -0,0 +1,9 @@ +# CancelJobRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `jobNumber` | *any* | :heavy_check_mark: | The number of the job. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/canceljobresponse.md b/docs/models/operations/canceljobresponse.md new file mode 100755 index 00000000..4c4f1bed --- /dev/null +++ b/docs/models/operations/canceljobresponse.md @@ -0,0 +1,12 @@ +# CancelJobResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [CancelJobMessageResponse](../../models/operations/canceljobmessageresponse.md) | :heavy_minus_sign: | N/A | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `cancelJobDefaultApplicationJSONObject` | [CancelJobDefaultApplicationJSON](../../models/operations/canceljobdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/cancelworkflowdefaultapplicationjson.md b/docs/models/operations/cancelworkflowdefaultapplicationjson.md new file mode 100755 index 00000000..2b378556 --- /dev/null +++ b/docs/models/operations/cancelworkflowdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CancelWorkflowDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/cancelworkflowmessageresponse.md b/docs/models/operations/cancelworkflowmessageresponse.md new file mode 100755 index 00000000..0a269cd7 --- /dev/null +++ b/docs/models/operations/cancelworkflowmessageresponse.md @@ -0,0 +1,10 @@ +# CancelWorkflowMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/cancelworkflowrequest.md b/docs/models/operations/cancelworkflowrequest.md new file mode 100755 index 00000000..98af27fa --- /dev/null +++ b/docs/models/operations/cancelworkflowrequest.md @@ -0,0 +1,8 @@ +# CancelWorkflowRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/cancelworkflowresponse.md b/docs/models/operations/cancelworkflowresponse.md new file mode 100755 index 00000000..ee50b9cb --- /dev/null +++ b/docs/models/operations/cancelworkflowresponse.md @@ -0,0 +1,12 @@ +# CancelWorkflowResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [CancelWorkflowMessageResponse](../../models/operations/cancelworkflowmessageresponse.md) | :heavy_minus_sign: | A confirmation message. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `cancelWorkflowDefaultApplicationJSONObject` | [CancelWorkflowDefaultApplicationJSON](../../models/operations/cancelworkflowdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/continuepipelinedefaultapplicationjson.md b/docs/models/operations/continuepipelinedefaultapplicationjson.md new file mode 100755 index 00000000..8700b07d --- /dev/null +++ b/docs/models/operations/continuepipelinedefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ContinuePipelineDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/continuepipelinemessageresponse.md b/docs/models/operations/continuepipelinemessageresponse.md new file mode 100755 index 00000000..44ffee2c --- /dev/null +++ b/docs/models/operations/continuepipelinemessageresponse.md @@ -0,0 +1,10 @@ +# ContinuePipelineMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/continuepipelinerequestbody.md b/docs/models/operations/continuepipelinerequestbody.md new file mode 100755 index 00000000..96840951 --- /dev/null +++ b/docs/models/operations/continuepipelinerequestbody.md @@ -0,0 +1,10 @@ +# ContinuePipelineRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `configuration` | *string* | :heavy_check_mark: | A configuration string for the pipeline. | +| `continuationKey` | *string* | :heavy_check_mark: | A pipeline continuation key. | +| `parameters` | Record | :heavy_minus_sign: | An object containing pipeline parameters and their values. | \ No newline at end of file diff --git a/docs/models/operations/continuepipelineresponse.md b/docs/models/operations/continuepipelineresponse.md new file mode 100755 index 00000000..1cf0e872 --- /dev/null +++ b/docs/models/operations/continuepipelineresponse.md @@ -0,0 +1,12 @@ +# ContinuePipelineResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [ContinuePipelineMessageResponse](../../models/operations/continuepipelinemessageresponse.md) | :heavy_minus_sign: | A confirmation message. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `continuePipelineDefaultApplicationJSONObject` | [ContinuePipelineDefaultApplicationJSON](../../models/operations/continuepipelinedefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeycheckoutkey.md b/docs/models/operations/createcheckoutkeycheckoutkey.md new file mode 100755 index 00000000..a68999a5 --- /dev/null +++ b/docs/models/operations/createcheckoutkeycheckoutkey.md @@ -0,0 +1,14 @@ +# CreateCheckoutKeyCheckoutKey + +A checkout key + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the checkout key was created. | 2015-09-21T17:29:21.042Z | +| `fingerprint` | *string* | :heavy_check_mark: | An SSH key fingerprint. | c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f | +| `preferred` | *boolean* | :heavy_check_mark: | A boolean value that indicates if this key is preferred. | true | +| `publicKey` | *string* | :heavy_check_mark: | A public SSH key. | ssh-rsa ... | +| `type` | [CreateCheckoutKeyCheckoutKeyCheckoutKeyType](../../models/operations/createcheckoutkeycheckoutkeycheckoutkeytype.md) | :heavy_check_mark: | The type of checkout key. This may be either `deploy-key` or `github-user-key`. | deploy-key | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeycheckoutkeycheckoutkeytype.md b/docs/models/operations/createcheckoutkeycheckoutkeycheckoutkeytype.md new file mode 100755 index 00000000..1e4334fe --- /dev/null +++ b/docs/models/operations/createcheckoutkeycheckoutkeycheckoutkeytype.md @@ -0,0 +1,11 @@ +# CreateCheckoutKeyCheckoutKeyCheckoutKeyType + +The type of checkout key. This may be either `deploy-key` or `github-user-key`. + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `DeployKey` | deploy-key | +| `GithubUserKey` | github-user-key | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeycheckoutkeyinput.md b/docs/models/operations/createcheckoutkeycheckoutkeyinput.md new file mode 100755 index 00000000..67c37357 --- /dev/null +++ b/docs/models/operations/createcheckoutkeycheckoutkeyinput.md @@ -0,0 +1,8 @@ +# CreateCheckoutKeyCheckoutKeyInput + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [CreateCheckoutKeyCheckoutKeyInputCheckoutKeyInputType](../../models/operations/createcheckoutkeycheckoutkeyinputcheckoutkeyinputtype.md) | :heavy_check_mark: | The type of checkout key to create. This may be either `deploy-key` or `user-key`. | deploy-key | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeycheckoutkeyinputcheckoutkeyinputtype.md b/docs/models/operations/createcheckoutkeycheckoutkeyinputcheckoutkeyinputtype.md new file mode 100755 index 00000000..6be65ea1 --- /dev/null +++ b/docs/models/operations/createcheckoutkeycheckoutkeyinputcheckoutkeyinputtype.md @@ -0,0 +1,11 @@ +# CreateCheckoutKeyCheckoutKeyInputCheckoutKeyInputType + +The type of checkout key to create. This may be either `deploy-key` or `user-key`. + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `UserKey` | user-key | +| `DeployKey` | deploy-key | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeydefaultapplicationjson.md b/docs/models/operations/createcheckoutkeydefaultapplicationjson.md new file mode 100755 index 00000000..37d8abc5 --- /dev/null +++ b/docs/models/operations/createcheckoutkeydefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CreateCheckoutKeyDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeyrequest.md b/docs/models/operations/createcheckoutkeyrequest.md new file mode 100755 index 00000000..9f567dfb --- /dev/null +++ b/docs/models/operations/createcheckoutkeyrequest.md @@ -0,0 +1,9 @@ +# CreateCheckoutKeyRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `requestBody` | [CreateCheckoutKeyCheckoutKeyInput](../../models/operations/createcheckoutkeycheckoutkeyinput.md) | :heavy_minus_sign: | N/A | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/createcheckoutkeyresponse.md b/docs/models/operations/createcheckoutkeyresponse.md new file mode 100755 index 00000000..fe308596 --- /dev/null +++ b/docs/models/operations/createcheckoutkeyresponse.md @@ -0,0 +1,12 @@ +# CreateCheckoutKeyResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `checkoutKey` | [CreateCheckoutKeyCheckoutKey](../../models/operations/createcheckoutkeycheckoutkey.md) | :heavy_minus_sign: | The checkout key. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `createCheckoutKeyDefaultApplicationJSONObject` | [CreateCheckoutKeyDefaultApplicationJSON](../../models/operations/createcheckoutkeydefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/createcontextcontext.md b/docs/models/operations/createcontextcontext.md new file mode 100755 index 00000000..90212d78 --- /dev/null +++ b/docs/models/operations/createcontextcontext.md @@ -0,0 +1,12 @@ +# CreateContextContext + +The new context + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the context was created. | 2015-09-21T17:29:21.042Z | +| `id` | *string* | :heavy_check_mark: | The unique ID of the context. | | +| `name` | *string* | :heavy_check_mark: | The user defined name of the context. | | \ No newline at end of file diff --git a/docs/models/operations/createcontextdefaultapplicationjson.md b/docs/models/operations/createcontextdefaultapplicationjson.md new file mode 100755 index 00000000..680abce2 --- /dev/null +++ b/docs/models/operations/createcontextdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CreateContextDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createcontextrequestbody.md b/docs/models/operations/createcontextrequestbody.md new file mode 100755 index 00000000..57c91127 --- /dev/null +++ b/docs/models/operations/createcontextrequestbody.md @@ -0,0 +1,9 @@ +# CreateContextRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The user defined name of the context. | +| `owner` | *any* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createcontextrequestbodyowner1.md b/docs/models/operations/createcontextrequestbodyowner1.md new file mode 100755 index 00000000..34918edf --- /dev/null +++ b/docs/models/operations/createcontextrequestbodyowner1.md @@ -0,0 +1,9 @@ +# CreateContextRequestBodyOwner1 + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | The unique ID of the owner of the context. Specify either this or slug. | | +| `type` | [CreateContextRequestBodyOwner1Type](../../models/operations/createcontextrequestbodyowner1type.md) | :heavy_minus_sign: | The type of the owner. Defaults to "organization". Accounts are only used as context owners in server. | organization | \ No newline at end of file diff --git a/docs/models/operations/createcontextrequestbodyowner1type.md b/docs/models/operations/createcontextrequestbodyowner1type.md new file mode 100755 index 00000000..36d22c3f --- /dev/null +++ b/docs/models/operations/createcontextrequestbodyowner1type.md @@ -0,0 +1,11 @@ +# CreateContextRequestBodyOwner1Type + +The type of the owner. Defaults to "organization". Accounts are only used as context owners in server. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Account` | account | +| `Organization` | organization | \ No newline at end of file diff --git a/docs/models/operations/createcontextrequestbodyowner2.md b/docs/models/operations/createcontextrequestbodyowner2.md new file mode 100755 index 00000000..16b7062a --- /dev/null +++ b/docs/models/operations/createcontextrequestbodyowner2.md @@ -0,0 +1,9 @@ +# CreateContextRequestBodyOwner2 + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `slug` | *string* | :heavy_check_mark: | A string that represents an organization. Specify either this or id. Cannot be used for accounts. | +| `type` | [CreateContextRequestBodyOwner2Type](../../models/operations/createcontextrequestbodyowner2type.md) | :heavy_minus_sign: | The type of owner. Defaults to "organization". Accounts are only used as context owners in server and must be specified by an id instead of a slug. | \ No newline at end of file diff --git a/docs/models/operations/createcontextrequestbodyowner2type.md b/docs/models/operations/createcontextrequestbodyowner2type.md new file mode 100755 index 00000000..43cdca8b --- /dev/null +++ b/docs/models/operations/createcontextrequestbodyowner2type.md @@ -0,0 +1,10 @@ +# CreateContextRequestBodyOwner2Type + +The type of owner. Defaults to "organization". Accounts are only used as context owners in server and must be specified by an id instead of a slug. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Organization` | organization | \ No newline at end of file diff --git a/docs/models/operations/createcontextresponse.md b/docs/models/operations/createcontextresponse.md new file mode 100755 index 00000000..0e5bb6c6 --- /dev/null +++ b/docs/models/operations/createcontextresponse.md @@ -0,0 +1,12 @@ +# CreateContextResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `context` | [CreateContextContext](../../models/operations/createcontextcontext.md) | :heavy_minus_sign: | The new context | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `createContextDefaultApplicationJSONObject` | [CreateContextDefaultApplicationJSON](../../models/operations/createcontextdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/createenvvardefaultapplicationjson.md b/docs/models/operations/createenvvardefaultapplicationjson.md new file mode 100755 index 00000000..babb6e3e --- /dev/null +++ b/docs/models/operations/createenvvardefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CreateEnvVarDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createenvvarenvironmentvariable.md b/docs/models/operations/createenvvarenvironmentvariable.md new file mode 100755 index 00000000..d1eab044 --- /dev/null +++ b/docs/models/operations/createenvvarenvironmentvariable.md @@ -0,0 +1,11 @@ +# CreateEnvVarEnvironmentVariable + +An environment variable request requires a name and a value + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the environment variable. | foo | +| `value` | *string* | :heavy_check_mark: | The value of the environment variable. | xxxx1234 | \ No newline at end of file diff --git a/docs/models/operations/createenvvarenvironmentvariable1.md b/docs/models/operations/createenvvarenvironmentvariable1.md new file mode 100755 index 00000000..5d328621 --- /dev/null +++ b/docs/models/operations/createenvvarenvironmentvariable1.md @@ -0,0 +1,12 @@ +# CreateEnvVarEnvironmentVariable1 + +An environment variable is a map containing a value and an optional timestamp. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | +| `createdAt` | *any* | :heavy_minus_sign: | The creation timestamp of the environment variable. | | +| `name` | *string* | :heavy_check_mark: | The name of the environment variable. | foo | +| `value` | *string* | :heavy_check_mark: | The value of the environment variable. | xxxx1234 | \ No newline at end of file diff --git a/docs/models/operations/createenvvarrequest.md b/docs/models/operations/createenvvarrequest.md new file mode 100755 index 00000000..9c7d5444 --- /dev/null +++ b/docs/models/operations/createenvvarrequest.md @@ -0,0 +1,9 @@ +# CreateEnvVarRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `requestBody` | [CreateEnvVarEnvironmentVariable](../../models/operations/createenvvarenvironmentvariable.md) | :heavy_minus_sign: | N/A | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/createenvvarresponse.md b/docs/models/operations/createenvvarresponse.md new file mode 100755 index 00000000..6236f889 --- /dev/null +++ b/docs/models/operations/createenvvarresponse.md @@ -0,0 +1,12 @@ +# CreateEnvVarResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `environmentVariable` | [CreateEnvVarEnvironmentVariable1](../../models/operations/createenvvarenvironmentvariable1.md) | :heavy_minus_sign: | The environment variable. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `createEnvVarDefaultApplicationJSONObject` | [CreateEnvVarDefaultApplicationJSON](../../models/operations/createenvvardefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundle400applicationjson.md b/docs/models/operations/createpolicybundle400applicationjson.md new file mode 100755 index 00000000..7f17792c --- /dev/null +++ b/docs/models/operations/createpolicybundle400applicationjson.md @@ -0,0 +1,11 @@ +# CreatePolicyBundle400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundle401applicationjson.md b/docs/models/operations/createpolicybundle401applicationjson.md new file mode 100755 index 00000000..dcae71a3 --- /dev/null +++ b/docs/models/operations/createpolicybundle401applicationjson.md @@ -0,0 +1,11 @@ +# CreatePolicyBundle401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundle403applicationjson.md b/docs/models/operations/createpolicybundle403applicationjson.md new file mode 100755 index 00000000..d665281c --- /dev/null +++ b/docs/models/operations/createpolicybundle403applicationjson.md @@ -0,0 +1,11 @@ +# CreatePolicyBundle403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundle413applicationjson.md b/docs/models/operations/createpolicybundle413applicationjson.md new file mode 100755 index 00000000..ff8e296d --- /dev/null +++ b/docs/models/operations/createpolicybundle413applicationjson.md @@ -0,0 +1,11 @@ +# CreatePolicyBundle413ApplicationJSON + +The request exceeds the maximum payload size for policy bundles ~2.5Mib + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | http: request payload too large | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundle500applicationjson.md b/docs/models/operations/createpolicybundle500applicationjson.md new file mode 100755 index 00000000..587ced5e --- /dev/null +++ b/docs/models/operations/createpolicybundle500applicationjson.md @@ -0,0 +1,10 @@ +# CreatePolicyBundle500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundlerequest.md b/docs/models/operations/createpolicybundlerequest.md new file mode 100755 index 00000000..d1f63075 --- /dev/null +++ b/docs/models/operations/createpolicybundlerequest.md @@ -0,0 +1,11 @@ +# CreatePolicyBundleRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `bundlePayload` | [shared.BundlePayload](../../models/shared/bundlepayload.md) | :heavy_minus_sign: | N/A | +| `context` | *string* | :heavy_check_mark: | N/A | +| `dry` | *boolean* | :heavy_minus_sign: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createpolicybundleresponse.md b/docs/models/operations/createpolicybundleresponse.md new file mode 100755 index 00000000..a920b82a --- /dev/null +++ b/docs/models/operations/createpolicybundleresponse.md @@ -0,0 +1,16 @@ +# CreatePolicyBundleResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `bundleDiff` | [shared.BundleDiff](../../models/shared/bundlediff.md) | :heavy_minus_sign: | Policy-Bundle diff successfully returned. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `createPolicyBundle400ApplicationJSONObject` | [CreatePolicyBundle400ApplicationJSON](../../models/operations/createpolicybundle400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `createPolicyBundle401ApplicationJSONObject` | [CreatePolicyBundle401ApplicationJSON](../../models/operations/createpolicybundle401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `createPolicyBundle403ApplicationJSONObject` | [CreatePolicyBundle403ApplicationJSON](../../models/operations/createpolicybundle403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `createPolicyBundle413ApplicationJSONObject` | [CreatePolicyBundle413ApplicationJSON](../../models/operations/createpolicybundle413applicationjson.md) | :heavy_minus_sign: | The request exceeds the maximum payload size for policy bundles ~2.5Mib
| +| `createPolicyBundle500ApplicationJSONObject` | [CreatePolicyBundle500ApplicationJSON](../../models/operations/createpolicybundle500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameters.md b/docs/models/operations/createschedulecreatescheduleparameters.md new file mode 100755 index 00000000..2c1765e1 --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameters.md @@ -0,0 +1,14 @@ +# CreateScheduleCreateScheduleParameters + +The parameters for a create schedule request + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributionActor` | [CreateScheduleCreateScheduleParametersAttributionActor](../../models/operations/createschedulecreatescheduleparametersattributionactor.md) | :heavy_check_mark: | The attribution-actor of the scheduled pipeline. | current | +| `description` | *string* | :heavy_minus_sign: | Description of the schedule. | | +| `name` | *string* | :heavy_check_mark: | Name of the schedule. | | +| `parameters` | Record | :heavy_check_mark: | Pipeline parameters represented as key-value pairs. Must contain branch or tag. | | +| `timetable` | *any* | :heavy_check_mark: | Timetable that specifies when a schedule triggers. | | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparametersattributionactor.md b/docs/models/operations/createschedulecreatescheduleparametersattributionactor.md new file mode 100755 index 00000000..9bff4b38 --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparametersattributionactor.md @@ -0,0 +1,11 @@ +# CreateScheduleCreateScheduleParametersAttributionActor + +The attribution-actor of the scheduled pipeline. + + +## Values + +| Name | Value | +| --------- | --------- | +| `Current` | current | +| `System` | system | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameterstimetable1.md b/docs/models/operations/createschedulecreatescheduleparameterstimetable1.md new file mode 100755 index 00000000..7b2ace94 --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameterstimetable1.md @@ -0,0 +1,14 @@ +# CreateScheduleCreateScheduleParametersTimetable1 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_minus_sign: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [CreateScheduleCreateScheduleParametersTimetable1DaysOfWeek](../../models/operations/createschedulecreatescheduleparameterstimetable1daysofweek.md)[] | :heavy_check_mark: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [CreateScheduleCreateScheduleParametersTimetable1Months](../../models/operations/createschedulecreatescheduleparameterstimetable1months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameterstimetable1daysofweek.md b/docs/models/operations/createschedulecreatescheduleparameterstimetable1daysofweek.md new file mode 100755 index 00000000..f4488afa --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameterstimetable1daysofweek.md @@ -0,0 +1,16 @@ +# CreateScheduleCreateScheduleParametersTimetable1DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameterstimetable1months.md b/docs/models/operations/createschedulecreatescheduleparameterstimetable1months.md new file mode 100755 index 00000000..ed4a83e3 --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameterstimetable1months.md @@ -0,0 +1,21 @@ +# CreateScheduleCreateScheduleParametersTimetable1Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameterstimetable2.md b/docs/models/operations/createschedulecreatescheduleparameterstimetable2.md new file mode 100755 index 00000000..b83acaf1 --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameterstimetable2.md @@ -0,0 +1,14 @@ +# CreateScheduleCreateScheduleParametersTimetable2 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_check_mark: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek](../../models/operations/createschedulecreatescheduleparameterstimetable2daysofweek.md)[] | :heavy_minus_sign: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [CreateScheduleCreateScheduleParametersTimetable2Months](../../models/operations/createschedulecreatescheduleparameterstimetable2months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameterstimetable2daysofweek.md b/docs/models/operations/createschedulecreatescheduleparameterstimetable2daysofweek.md new file mode 100755 index 00000000..d3e13117 --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameterstimetable2daysofweek.md @@ -0,0 +1,16 @@ +# CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/createschedulecreatescheduleparameterstimetable2months.md b/docs/models/operations/createschedulecreatescheduleparameterstimetable2months.md new file mode 100755 index 00000000..678aa7df --- /dev/null +++ b/docs/models/operations/createschedulecreatescheduleparameterstimetable2months.md @@ -0,0 +1,21 @@ +# CreateScheduleCreateScheduleParametersTimetable2Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/createscheduledefaultapplicationjson.md b/docs/models/operations/createscheduledefaultapplicationjson.md new file mode 100755 index 00000000..c30f68ea --- /dev/null +++ b/docs/models/operations/createscheduledefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CreateScheduleDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createschedulerequest.md b/docs/models/operations/createschedulerequest.md new file mode 100755 index 00000000..dfbee0de --- /dev/null +++ b/docs/models/operations/createschedulerequest.md @@ -0,0 +1,9 @@ +# CreateScheduleRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `requestBody` | [CreateScheduleCreateScheduleParameters](../../models/operations/createschedulecreatescheduleparameters.md) | :heavy_minus_sign: | N/A | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/createscheduleresponse.md b/docs/models/operations/createscheduleresponse.md new file mode 100755 index 00000000..5a8a0e6f --- /dev/null +++ b/docs/models/operations/createscheduleresponse.md @@ -0,0 +1,12 @@ +# CreateScheduleResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `schedule` | [CreateScheduleSchedule](../../models/operations/createscheduleschedule.md) | :heavy_minus_sign: | A schedule object. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `createScheduleDefaultApplicationJSONObject` | [CreateScheduleDefaultApplicationJSON](../../models/operations/createscheduledefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/createscheduleschedule.md b/docs/models/operations/createscheduleschedule.md new file mode 100755 index 00000000..f168cde4 --- /dev/null +++ b/docs/models/operations/createscheduleschedule.md @@ -0,0 +1,18 @@ +# CreateScheduleSchedule + +A schedule response + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `actor` | [CreateScheduleScheduleUser](../../models/operations/createschedulescheduleuser.md) | :heavy_check_mark: | The attribution actor who will run the scheduled pipeline. | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `description` | *string* | :heavy_check_mark: | Description of the schedule. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the schedule. | | +| `name` | *string* | :heavy_check_mark: | Name of the schedule. | | +| `parameters` | Record | :heavy_check_mark: | Pipeline parameters represented as key-value pairs. Must contain branch or tag. | | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the schedule | gh/CircleCI-Public/api-preview-docs | +| `timetable` | *any* | :heavy_check_mark: | Timetable that specifies when a schedule triggers. | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was last updated. | | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduletimetable1.md b/docs/models/operations/createschedulescheduletimetable1.md new file mode 100755 index 00000000..5c05a3f2 --- /dev/null +++ b/docs/models/operations/createschedulescheduletimetable1.md @@ -0,0 +1,14 @@ +# CreateScheduleScheduleTimetable1 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_minus_sign: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [CreateScheduleScheduleTimetable1DaysOfWeek](../../models/operations/createschedulescheduletimetable1daysofweek.md)[] | :heavy_check_mark: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [CreateScheduleScheduleTimetable1Months](../../models/operations/createschedulescheduletimetable1months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduletimetable1daysofweek.md b/docs/models/operations/createschedulescheduletimetable1daysofweek.md new file mode 100755 index 00000000..213ff92e --- /dev/null +++ b/docs/models/operations/createschedulescheduletimetable1daysofweek.md @@ -0,0 +1,16 @@ +# CreateScheduleScheduleTimetable1DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduletimetable1months.md b/docs/models/operations/createschedulescheduletimetable1months.md new file mode 100755 index 00000000..3c71daed --- /dev/null +++ b/docs/models/operations/createschedulescheduletimetable1months.md @@ -0,0 +1,21 @@ +# CreateScheduleScheduleTimetable1Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduletimetable2.md b/docs/models/operations/createschedulescheduletimetable2.md new file mode 100755 index 00000000..88234434 --- /dev/null +++ b/docs/models/operations/createschedulescheduletimetable2.md @@ -0,0 +1,14 @@ +# CreateScheduleScheduleTimetable2 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_check_mark: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [CreateScheduleScheduleTimetable2DaysOfWeek](../../models/operations/createschedulescheduletimetable2daysofweek.md)[] | :heavy_minus_sign: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [CreateScheduleScheduleTimetable2Months](../../models/operations/createschedulescheduletimetable2months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduletimetable2daysofweek.md b/docs/models/operations/createschedulescheduletimetable2daysofweek.md new file mode 100755 index 00000000..b2c5b743 --- /dev/null +++ b/docs/models/operations/createschedulescheduletimetable2daysofweek.md @@ -0,0 +1,16 @@ +# CreateScheduleScheduleTimetable2DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduletimetable2months.md b/docs/models/operations/createschedulescheduletimetable2months.md new file mode 100755 index 00000000..e99a005b --- /dev/null +++ b/docs/models/operations/createschedulescheduletimetable2months.md @@ -0,0 +1,21 @@ +# CreateScheduleScheduleTimetable2Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/createschedulescheduleuser.md b/docs/models/operations/createschedulescheduleuser.md new file mode 100755 index 00000000..a90dbd93 --- /dev/null +++ b/docs/models/operations/createschedulescheduleuser.md @@ -0,0 +1,12 @@ +# CreateScheduleScheduleUser + +The attribution actor who will run the scheduled pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | +| `name` | *string* | :heavy_check_mark: | The name of the user. | \ No newline at end of file diff --git a/docs/models/operations/createwebhookdefaultapplicationjson.md b/docs/models/operations/createwebhookdefaultapplicationjson.md new file mode 100755 index 00000000..d385641d --- /dev/null +++ b/docs/models/operations/createwebhookdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# CreateWebhookDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createwebhookrequestbody.md b/docs/models/operations/createwebhookrequestbody.md new file mode 100755 index 00000000..b4e94b5c --- /dev/null +++ b/docs/models/operations/createwebhookrequestbody.md @@ -0,0 +1,15 @@ +# CreateWebhookRequestBody + +The parameters for a create webhook request + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `events` | [CreateWebhookRequestBodyEvents](../../models/operations/createwebhookrequestbodyevents.md)[] | :heavy_check_mark: | Events that will trigger the webhook | +| `name` | *string* | :heavy_check_mark: | Name of the webhook | +| `scope` | [CreateWebhookRequestBodyScope](../../models/operations/createwebhookrequestbodyscope.md) | :heavy_check_mark: | The scope in which the relevant events that will trigger webhooks | +| `signingSecret` | *string* | :heavy_check_mark: | Secret used to build an HMAC hash of the payload and passed as a header in the webhook request | +| `url` | *string* | :heavy_check_mark: | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) | +| `verifyTls` | *boolean* | :heavy_check_mark: | Whether to enforce TLS certificate verification when delivering the webhook | \ No newline at end of file diff --git a/docs/models/operations/createwebhookrequestbodyevents.md b/docs/models/operations/createwebhookrequestbodyevents.md new file mode 100755 index 00000000..08dfb2cd --- /dev/null +++ b/docs/models/operations/createwebhookrequestbodyevents.md @@ -0,0 +1,9 @@ +# CreateWebhookRequestBodyEvents + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `WorkflowCompleted` | workflow-completed | +| `JobCompleted` | job-completed | \ No newline at end of file diff --git a/docs/models/operations/createwebhookrequestbodyscope.md b/docs/models/operations/createwebhookrequestbodyscope.md new file mode 100755 index 00000000..60ba2bf5 --- /dev/null +++ b/docs/models/operations/createwebhookrequestbodyscope.md @@ -0,0 +1,11 @@ +# CreateWebhookRequestBodyScope + +The scope in which the relevant events that will trigger webhooks + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | ID of the scope being used (at the moment, only project ID is supported) | +| `type` | [CreateWebhookRequestBodyScopeType](../../models/operations/createwebhookrequestbodyscopetype.md) | :heavy_check_mark: | Type of the scope being used | \ No newline at end of file diff --git a/docs/models/operations/createwebhookrequestbodyscopetype.md b/docs/models/operations/createwebhookrequestbodyscopetype.md new file mode 100755 index 00000000..4d0f7a26 --- /dev/null +++ b/docs/models/operations/createwebhookrequestbodyscopetype.md @@ -0,0 +1,10 @@ +# CreateWebhookRequestBodyScopeType + +Type of the scope being used + + +## Values + +| Name | Value | +| --------- | --------- | +| `Project` | project | \ No newline at end of file diff --git a/docs/models/operations/createwebhookresponse.md b/docs/models/operations/createwebhookresponse.md new file mode 100755 index 00000000..8bb9b1b0 --- /dev/null +++ b/docs/models/operations/createwebhookresponse.md @@ -0,0 +1,12 @@ +# CreateWebhookResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `webhook` | [CreateWebhookWebhook](../../models/operations/createwebhookwebhook.md) | :heavy_minus_sign: | A webhook | +| `createWebhookDefaultApplicationJSONObject` | [CreateWebhookDefaultApplicationJSON](../../models/operations/createwebhookdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/createwebhookwebhook.md b/docs/models/operations/createwebhookwebhook.md new file mode 100755 index 00000000..77a3644b --- /dev/null +++ b/docs/models/operations/createwebhookwebhook.md @@ -0,0 +1,18 @@ +# CreateWebhookWebhook + +A webhook + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was created. | 2015-09-21T17:29:21.042Z | +| `events` | [CreateWebhookWebhookEvents](../../models/operations/createwebhookwebhookevents.md)[] | :heavy_check_mark: | Events that will trigger the webhook | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the webhook | | +| `name` | *string* | :heavy_check_mark: | Name of the webhook | | +| `scope` | [CreateWebhookWebhookScope](../../models/operations/createwebhookwebhookscope.md) | :heavy_check_mark: | The scope in which the relevant events that will trigger webhooks | | +| `signingSecret` | *string* | :heavy_check_mark: | Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was last updated. | 2015-09-21T17:29:21.042Z | +| `url` | *string* | :heavy_check_mark: | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) | | +| `verifyTls` | *boolean* | :heavy_check_mark: | Whether to enforce TLS certificate verification when delivering the webhook | | \ No newline at end of file diff --git a/docs/models/operations/createwebhookwebhookevents.md b/docs/models/operations/createwebhookwebhookevents.md new file mode 100755 index 00000000..09e26ac8 --- /dev/null +++ b/docs/models/operations/createwebhookwebhookevents.md @@ -0,0 +1,9 @@ +# CreateWebhookWebhookEvents + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `WorkflowCompleted` | workflow-completed | +| `JobCompleted` | job-completed | \ No newline at end of file diff --git a/docs/models/operations/createwebhookwebhookscope.md b/docs/models/operations/createwebhookwebhookscope.md new file mode 100755 index 00000000..04a7ac3b --- /dev/null +++ b/docs/models/operations/createwebhookwebhookscope.md @@ -0,0 +1,11 @@ +# CreateWebhookWebhookScope + +The scope in which the relevant events that will trigger webhooks + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | ID of the scope being used (at the moment, only project ID is supported) | +| `type` | *string* | :heavy_check_mark: | Type of the scope being used | \ No newline at end of file diff --git a/docs/models/operations/deletecheckoutkeydefaultapplicationjson.md b/docs/models/operations/deletecheckoutkeydefaultapplicationjson.md new file mode 100755 index 00000000..34d4d46d --- /dev/null +++ b/docs/models/operations/deletecheckoutkeydefaultapplicationjson.md @@ -0,0 +1,10 @@ +# DeleteCheckoutKeyDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deletecheckoutkeymessageresponse.md b/docs/models/operations/deletecheckoutkeymessageresponse.md new file mode 100755 index 00000000..7dade166 --- /dev/null +++ b/docs/models/operations/deletecheckoutkeymessageresponse.md @@ -0,0 +1,10 @@ +# DeleteCheckoutKeyMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/deletecheckoutkeyrequest.md b/docs/models/operations/deletecheckoutkeyrequest.md new file mode 100755 index 00000000..43fb956c --- /dev/null +++ b/docs/models/operations/deletecheckoutkeyrequest.md @@ -0,0 +1,9 @@ +# DeleteCheckoutKeyRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `fingerprint` | *string* | :heavy_check_mark: | An SSH key fingerprint. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/deletecheckoutkeyresponse.md b/docs/models/operations/deletecheckoutkeyresponse.md new file mode 100755 index 00000000..1c01716d --- /dev/null +++ b/docs/models/operations/deletecheckoutkeyresponse.md @@ -0,0 +1,12 @@ +# DeleteCheckoutKeyResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [DeleteCheckoutKeyMessageResponse](../../models/operations/deletecheckoutkeymessageresponse.md) | :heavy_minus_sign: | A confirmation message. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `deleteCheckoutKeyDefaultApplicationJSONObject` | [DeleteCheckoutKeyDefaultApplicationJSON](../../models/operations/deletecheckoutkeydefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/deletecontextdefaultapplicationjson.md b/docs/models/operations/deletecontextdefaultapplicationjson.md new file mode 100755 index 00000000..a91539c1 --- /dev/null +++ b/docs/models/operations/deletecontextdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# DeleteContextDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deletecontextmessageresponse.md b/docs/models/operations/deletecontextmessageresponse.md new file mode 100755 index 00000000..11e51e61 --- /dev/null +++ b/docs/models/operations/deletecontextmessageresponse.md @@ -0,0 +1,10 @@ +# DeleteContextMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/deletecontextrequest.md b/docs/models/operations/deletecontextrequest.md new file mode 100755 index 00000000..8a806dd8 --- /dev/null +++ b/docs/models/operations/deletecontextrequest.md @@ -0,0 +1,8 @@ +# DeleteContextRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | \ No newline at end of file diff --git a/docs/models/operations/deletecontextresponse.md b/docs/models/operations/deletecontextresponse.md new file mode 100755 index 00000000..4e4cdcc5 --- /dev/null +++ b/docs/models/operations/deletecontextresponse.md @@ -0,0 +1,12 @@ +# DeleteContextResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [DeleteContextMessageResponse](../../models/operations/deletecontextmessageresponse.md) | :heavy_minus_sign: | A confirmation message | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `deleteContextDefaultApplicationJSONObject` | [DeleteContextDefaultApplicationJSON](../../models/operations/deletecontextdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/deleteenvironmentvariablefromcontextdefaultapplicationjson.md b/docs/models/operations/deleteenvironmentvariablefromcontextdefaultapplicationjson.md new file mode 100755 index 00000000..f57cda3f --- /dev/null +++ b/docs/models/operations/deleteenvironmentvariablefromcontextdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# DeleteEnvironmentVariableFromContextDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deleteenvironmentvariablefromcontextmessageresponse.md b/docs/models/operations/deleteenvironmentvariablefromcontextmessageresponse.md new file mode 100755 index 00000000..b87665be --- /dev/null +++ b/docs/models/operations/deleteenvironmentvariablefromcontextmessageresponse.md @@ -0,0 +1,10 @@ +# DeleteEnvironmentVariableFromContextMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/deleteenvironmentvariablefromcontextrequest.md b/docs/models/operations/deleteenvironmentvariablefromcontextrequest.md new file mode 100755 index 00000000..9222ff48 --- /dev/null +++ b/docs/models/operations/deleteenvironmentvariablefromcontextrequest.md @@ -0,0 +1,9 @@ +# DeleteEnvironmentVariableFromContextRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | +| `envVarName` | *string* | :heavy_check_mark: | The name of the environment variable | \ No newline at end of file diff --git a/docs/models/operations/deleteenvironmentvariablefromcontextresponse.md b/docs/models/operations/deleteenvironmentvariablefromcontextresponse.md new file mode 100755 index 00000000..2f616cc0 --- /dev/null +++ b/docs/models/operations/deleteenvironmentvariablefromcontextresponse.md @@ -0,0 +1,12 @@ +# DeleteEnvironmentVariableFromContextResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [DeleteEnvironmentVariableFromContextMessageResponse](../../models/operations/deleteenvironmentvariablefromcontextmessageresponse.md) | :heavy_minus_sign: | A confirmation message | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `deleteEnvironmentVariableFromContextDefaultApplicationJSONObject` | [DeleteEnvironmentVariableFromContextDefaultApplicationJSON](../../models/operations/deleteenvironmentvariablefromcontextdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/deleteenvvardefaultapplicationjson.md b/docs/models/operations/deleteenvvardefaultapplicationjson.md new file mode 100755 index 00000000..411e779c --- /dev/null +++ b/docs/models/operations/deleteenvvardefaultapplicationjson.md @@ -0,0 +1,10 @@ +# DeleteEnvVarDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deleteenvvarmessageresponse.md b/docs/models/operations/deleteenvvarmessageresponse.md new file mode 100755 index 00000000..68721231 --- /dev/null +++ b/docs/models/operations/deleteenvvarmessageresponse.md @@ -0,0 +1,10 @@ +# DeleteEnvVarMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/deleteenvvarrequest.md b/docs/models/operations/deleteenvvarrequest.md new file mode 100755 index 00000000..aa7e6595 --- /dev/null +++ b/docs/models/operations/deleteenvvarrequest.md @@ -0,0 +1,9 @@ +# DeleteEnvVarRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the environment variable. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/deleteenvvarresponse.md b/docs/models/operations/deleteenvvarresponse.md new file mode 100755 index 00000000..f3300071 --- /dev/null +++ b/docs/models/operations/deleteenvvarresponse.md @@ -0,0 +1,12 @@ +# DeleteEnvVarResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [DeleteEnvVarMessageResponse](../../models/operations/deleteenvvarmessageresponse.md) | :heavy_minus_sign: | A confirmation message. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `deleteEnvVarDefaultApplicationJSONObject` | [DeleteEnvVarDefaultApplicationJSON](../../models/operations/deleteenvvardefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/deleteorgclaims400applicationjson.md b/docs/models/operations/deleteorgclaims400applicationjson.md new file mode 100755 index 00000000..996dce05 --- /dev/null +++ b/docs/models/operations/deleteorgclaims400applicationjson.md @@ -0,0 +1,11 @@ +# DeleteOrgClaims400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/deleteorgclaims403applicationjson.md b/docs/models/operations/deleteorgclaims403applicationjson.md new file mode 100755 index 00000000..72ac3e4a --- /dev/null +++ b/docs/models/operations/deleteorgclaims403applicationjson.md @@ -0,0 +1,11 @@ +# DeleteOrgClaims403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/deleteorgclaims500applicationjson.md b/docs/models/operations/deleteorgclaims500applicationjson.md new file mode 100755 index 00000000..40a67acb --- /dev/null +++ b/docs/models/operations/deleteorgclaims500applicationjson.md @@ -0,0 +1,10 @@ +# DeleteOrgClaims500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | internal server error | \ No newline at end of file diff --git a/docs/models/operations/deleteorgclaimsrequest.md b/docs/models/operations/deleteorgclaimsrequest.md new file mode 100755 index 00000000..adeb0b3a --- /dev/null +++ b/docs/models/operations/deleteorgclaimsrequest.md @@ -0,0 +1,9 @@ +# DeleteOrgClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `claims` | *string* | :heavy_check_mark: | comma separated list of claims to delete. Valid values are "audience" and "ttl". | +| `orgID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deleteorgclaimsresponse.md b/docs/models/operations/deleteorgclaimsresponse.md new file mode 100755 index 00000000..98cd59a1 --- /dev/null +++ b/docs/models/operations/deleteorgclaimsresponse.md @@ -0,0 +1,14 @@ +# DeleteOrgClaimsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `claimResponse` | [shared.ClaimResponse](../../models/shared/claimresponse.md) | :heavy_minus_sign: | Claims successfully deleted. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `deleteOrgClaims400ApplicationJSONObject` | [DeleteOrgClaims400ApplicationJSON](../../models/operations/deleteorgclaims400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `deleteOrgClaims403ApplicationJSONObject` | [DeleteOrgClaims403ApplicationJSON](../../models/operations/deleteorgclaims403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `deleteOrgClaims500ApplicationJSONObject` | [DeleteOrgClaims500ApplicationJSON](../../models/operations/deleteorgclaims500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/deleteprojectclaims400applicationjson.md b/docs/models/operations/deleteprojectclaims400applicationjson.md new file mode 100755 index 00000000..0d5e98a7 --- /dev/null +++ b/docs/models/operations/deleteprojectclaims400applicationjson.md @@ -0,0 +1,11 @@ +# DeleteProjectClaims400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/deleteprojectclaims403applicationjson.md b/docs/models/operations/deleteprojectclaims403applicationjson.md new file mode 100755 index 00000000..16d559b5 --- /dev/null +++ b/docs/models/operations/deleteprojectclaims403applicationjson.md @@ -0,0 +1,11 @@ +# DeleteProjectClaims403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/deleteprojectclaims500applicationjson.md b/docs/models/operations/deleteprojectclaims500applicationjson.md new file mode 100755 index 00000000..95be8583 --- /dev/null +++ b/docs/models/operations/deleteprojectclaims500applicationjson.md @@ -0,0 +1,10 @@ +# DeleteProjectClaims500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | internal server error | \ No newline at end of file diff --git a/docs/models/operations/deleteprojectclaimsrequest.md b/docs/models/operations/deleteprojectclaimsrequest.md new file mode 100755 index 00000000..f059303c --- /dev/null +++ b/docs/models/operations/deleteprojectclaimsrequest.md @@ -0,0 +1,10 @@ +# DeleteProjectClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `claims` | *string* | :heavy_check_mark: | comma separated list of claims to delete. Valid values are "audience" and "ttl". | +| `orgID` | *string* | :heavy_check_mark: | N/A | +| `projectID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deleteprojectclaimsresponse.md b/docs/models/operations/deleteprojectclaimsresponse.md new file mode 100755 index 00000000..2a8b9eff --- /dev/null +++ b/docs/models/operations/deleteprojectclaimsresponse.md @@ -0,0 +1,14 @@ +# DeleteProjectClaimsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `claimResponse` | [shared.ClaimResponse](../../models/shared/claimresponse.md) | :heavy_minus_sign: | Claims successfully deleted. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `deleteProjectClaims400ApplicationJSONObject` | [DeleteProjectClaims400ApplicationJSON](../../models/operations/deleteprojectclaims400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `deleteProjectClaims403ApplicationJSONObject` | [DeleteProjectClaims403ApplicationJSON](../../models/operations/deleteprojectclaims403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `deleteProjectClaims500ApplicationJSONObject` | [DeleteProjectClaims500ApplicationJSON](../../models/operations/deleteprojectclaims500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/deleteschedulebyiddefaultapplicationjson.md b/docs/models/operations/deleteschedulebyiddefaultapplicationjson.md new file mode 100755 index 00000000..2b45ff6d --- /dev/null +++ b/docs/models/operations/deleteschedulebyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# DeleteScheduleByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deleteschedulebyidmessageresponse.md b/docs/models/operations/deleteschedulebyidmessageresponse.md new file mode 100755 index 00000000..577fb69f --- /dev/null +++ b/docs/models/operations/deleteschedulebyidmessageresponse.md @@ -0,0 +1,10 @@ +# DeleteScheduleByIdMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/deleteschedulebyidrequest.md b/docs/models/operations/deleteschedulebyidrequest.md new file mode 100755 index 00000000..ff93a395 --- /dev/null +++ b/docs/models/operations/deleteschedulebyidrequest.md @@ -0,0 +1,8 @@ +# DeleteScheduleByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `scheduleId` | *string* | :heavy_check_mark: | The unique ID of the schedule. | \ No newline at end of file diff --git a/docs/models/operations/deleteschedulebyidresponse.md b/docs/models/operations/deleteschedulebyidresponse.md new file mode 100755 index 00000000..37397620 --- /dev/null +++ b/docs/models/operations/deleteschedulebyidresponse.md @@ -0,0 +1,12 @@ +# DeleteScheduleByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [DeleteScheduleByIdMessageResponse](../../models/operations/deleteschedulebyidmessageresponse.md) | :heavy_minus_sign: | A confirmation message. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `deleteScheduleByIdDefaultApplicationJSONObject` | [DeleteScheduleByIdDefaultApplicationJSON](../../models/operations/deleteschedulebyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/deletewebhookdefaultapplicationjson.md b/docs/models/operations/deletewebhookdefaultapplicationjson.md new file mode 100755 index 00000000..df4c2558 --- /dev/null +++ b/docs/models/operations/deletewebhookdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# DeleteWebhookDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deletewebhookmessageresponse.md b/docs/models/operations/deletewebhookmessageresponse.md new file mode 100755 index 00000000..b19f7a3a --- /dev/null +++ b/docs/models/operations/deletewebhookmessageresponse.md @@ -0,0 +1,10 @@ +# DeleteWebhookMessageResponse + +message response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `message` | *string* | :heavy_check_mark: | A human-readable message | \ No newline at end of file diff --git a/docs/models/operations/deletewebhookrequest.md b/docs/models/operations/deletewebhookrequest.md new file mode 100755 index 00000000..aa30633d --- /dev/null +++ b/docs/models/operations/deletewebhookrequest.md @@ -0,0 +1,8 @@ +# DeleteWebhookRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `webhookId` | *string* | :heavy_check_mark: | ID of the webhook (UUID) | \ No newline at end of file diff --git a/docs/models/operations/deletewebhookresponse.md b/docs/models/operations/deletewebhookresponse.md new file mode 100755 index 00000000..20cd7a8d --- /dev/null +++ b/docs/models/operations/deletewebhookresponse.md @@ -0,0 +1,12 @@ +# DeleteWebhookResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `messageResponse` | [DeleteWebhookMessageResponse](../../models/operations/deletewebhookmessageresponse.md) | :heavy_minus_sign: | A confirmation message | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `deleteWebhookDefaultApplicationJSONObject` | [DeleteWebhookDefaultApplicationJSON](../../models/operations/deletewebhookdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getallinsightsbranchesdefaultapplicationjson.md b/docs/models/operations/getallinsightsbranchesdefaultapplicationjson.md new file mode 100755 index 00000000..59dccba0 --- /dev/null +++ b/docs/models/operations/getallinsightsbranchesdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetAllInsightsBranchesDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getallinsightsbranchesrequest.md b/docs/models/operations/getallinsightsbranchesrequest.md new file mode 100755 index 00000000..675fe389 --- /dev/null +++ b/docs/models/operations/getallinsightsbranchesrequest.md @@ -0,0 +1,9 @@ +# GetAllInsightsBranchesRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `workflowName` | *string* | :heavy_minus_sign: | The name of a workflow. If not passed we will scope the API call to the project. | \ No newline at end of file diff --git a/docs/models/operations/getallinsightsbranchesresponse.md b/docs/models/operations/getallinsightsbranchesresponse.md new file mode 100755 index 00000000..a87ca274 --- /dev/null +++ b/docs/models/operations/getallinsightsbranchesresponse.md @@ -0,0 +1,12 @@ +# GetAllInsightsBranchesResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getAllInsightsBranches200ApplicationJSONAny` | *any* | :heavy_minus_sign: | A list of branches for a project | +| `getAllInsightsBranchesDefaultApplicationJSONObject` | [GetAllInsightsBranchesDefaultApplicationJSON](../../models/operations/getallinsightsbranchesdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getcheckoutkeycheckoutkey.md b/docs/models/operations/getcheckoutkeycheckoutkey.md new file mode 100755 index 00000000..a2e2e856 --- /dev/null +++ b/docs/models/operations/getcheckoutkeycheckoutkey.md @@ -0,0 +1,14 @@ +# GetCheckoutKeyCheckoutKey + +A checkout key + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the checkout key was created. | 2015-09-21T17:29:21.042Z | +| `fingerprint` | *string* | :heavy_check_mark: | An SSH key fingerprint. | c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f | +| `preferred` | *boolean* | :heavy_check_mark: | A boolean value that indicates if this key is preferred. | true | +| `publicKey` | *string* | :heavy_check_mark: | A public SSH key. | ssh-rsa ... | +| `type` | [GetCheckoutKeyCheckoutKeyCheckoutKeyType](../../models/operations/getcheckoutkeycheckoutkeycheckoutkeytype.md) | :heavy_check_mark: | The type of checkout key. This may be either `deploy-key` or `github-user-key`. | deploy-key | \ No newline at end of file diff --git a/docs/models/operations/getcheckoutkeycheckoutkeycheckoutkeytype.md b/docs/models/operations/getcheckoutkeycheckoutkeycheckoutkeytype.md new file mode 100755 index 00000000..bb91dc95 --- /dev/null +++ b/docs/models/operations/getcheckoutkeycheckoutkeycheckoutkeytype.md @@ -0,0 +1,11 @@ +# GetCheckoutKeyCheckoutKeyCheckoutKeyType + +The type of checkout key. This may be either `deploy-key` or `github-user-key`. + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `DeployKey` | deploy-key | +| `GithubUserKey` | github-user-key | \ No newline at end of file diff --git a/docs/models/operations/getcheckoutkeydefaultapplicationjson.md b/docs/models/operations/getcheckoutkeydefaultapplicationjson.md new file mode 100755 index 00000000..e9f05503 --- /dev/null +++ b/docs/models/operations/getcheckoutkeydefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetCheckoutKeyDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getcheckoutkeyrequest.md b/docs/models/operations/getcheckoutkeyrequest.md new file mode 100755 index 00000000..69870a24 --- /dev/null +++ b/docs/models/operations/getcheckoutkeyrequest.md @@ -0,0 +1,9 @@ +# GetCheckoutKeyRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `fingerprint` | *string* | :heavy_check_mark: | An SSH key fingerprint. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getcheckoutkeyresponse.md b/docs/models/operations/getcheckoutkeyresponse.md new file mode 100755 index 00000000..1dd42ffc --- /dev/null +++ b/docs/models/operations/getcheckoutkeyresponse.md @@ -0,0 +1,12 @@ +# GetCheckoutKeyResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `checkoutKey` | [GetCheckoutKeyCheckoutKey](../../models/operations/getcheckoutkeycheckoutkey.md) | :heavy_minus_sign: | The checkout key. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getCheckoutKeyDefaultApplicationJSONObject` | [GetCheckoutKeyDefaultApplicationJSON](../../models/operations/getcheckoutkeydefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getcollaborationscollaboration.md b/docs/models/operations/getcollaborationscollaboration.md new file mode 100755 index 00000000..a5da6121 --- /dev/null +++ b/docs/models/operations/getcollaborationscollaboration.md @@ -0,0 +1,12 @@ +# GetCollaborationsCollaboration + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | +| `avatarUrl` | *string* | :heavy_check_mark: | URL to the user's avatar on the VCS | +| `id` | *string* | :heavy_check_mark: | The UUID of the organization | +| `name` | *string* | :heavy_check_mark: | The name of the organization | +| `slug` | *string* | :heavy_check_mark: | The slug of the organization | +| `vcsType` | *string* | :heavy_check_mark: | The VCS provider | \ No newline at end of file diff --git a/docs/models/operations/getcollaborationsdefaultapplicationjson.md b/docs/models/operations/getcollaborationsdefaultapplicationjson.md new file mode 100755 index 00000000..74affd61 --- /dev/null +++ b/docs/models/operations/getcollaborationsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetCollaborationsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getcollaborationsresponse.md b/docs/models/operations/getcollaborationsresponse.md new file mode 100755 index 00000000..4100334a --- /dev/null +++ b/docs/models/operations/getcollaborationsresponse.md @@ -0,0 +1,12 @@ +# GetCollaborationsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `collaborations` | [GetCollaborationsCollaboration](../../models/operations/getcollaborationscollaboration.md)[] | :heavy_minus_sign: | Collaborations | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getCollaborationsDefaultApplicationJSONObject` | [GetCollaborationsDefaultApplicationJSON](../../models/operations/getcollaborationsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getcontextcontext.md b/docs/models/operations/getcontextcontext.md new file mode 100755 index 00000000..09ad0cc2 --- /dev/null +++ b/docs/models/operations/getcontextcontext.md @@ -0,0 +1,12 @@ +# GetContextContext + +The context + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the context was created. | 2015-09-21T17:29:21.042Z | +| `id` | *string* | :heavy_check_mark: | The unique ID of the context. | | +| `name` | *string* | :heavy_check_mark: | The user defined name of the context. | | \ No newline at end of file diff --git a/docs/models/operations/getcontextdefaultapplicationjson.md b/docs/models/operations/getcontextdefaultapplicationjson.md new file mode 100755 index 00000000..3775e5ae --- /dev/null +++ b/docs/models/operations/getcontextdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetContextDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getcontextrequest.md b/docs/models/operations/getcontextrequest.md new file mode 100755 index 00000000..1cb2a7b3 --- /dev/null +++ b/docs/models/operations/getcontextrequest.md @@ -0,0 +1,8 @@ +# GetContextRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | \ No newline at end of file diff --git a/docs/models/operations/getcontextresponse.md b/docs/models/operations/getcontextresponse.md new file mode 100755 index 00000000..1bf04183 --- /dev/null +++ b/docs/models/operations/getcontextresponse.md @@ -0,0 +1,12 @@ +# GetContextResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `context` | [GetContextContext](../../models/operations/getcontextcontext.md) | :heavy_minus_sign: | The context | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getContextDefaultApplicationJSONObject` | [GetContextDefaultApplicationJSON](../../models/operations/getcontextdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getcurrentuserdefaultapplicationjson.md b/docs/models/operations/getcurrentuserdefaultapplicationjson.md new file mode 100755 index 00000000..6a6d4463 --- /dev/null +++ b/docs/models/operations/getcurrentuserdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetCurrentUserDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getcurrentuserresponse.md b/docs/models/operations/getcurrentuserresponse.md new file mode 100755 index 00000000..c4e008b2 --- /dev/null +++ b/docs/models/operations/getcurrentuserresponse.md @@ -0,0 +1,12 @@ +# GetCurrentUserResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `user` | [GetCurrentUserUser](../../models/operations/getcurrentuseruser.md) | :heavy_minus_sign: | User login information. | +| `getCurrentUserDefaultApplicationJSONObject` | [GetCurrentUserDefaultApplicationJSON](../../models/operations/getcurrentuserdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getcurrentuseruser.md b/docs/models/operations/getcurrentuseruser.md new file mode 100755 index 00000000..870cbdad --- /dev/null +++ b/docs/models/operations/getcurrentuseruser.md @@ -0,0 +1,12 @@ +# GetCurrentUserUser + +User login information. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | +| `name` | *string* | :heavy_check_mark: | The name of the user. | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlog400applicationjson.md b/docs/models/operations/getdecisionlog400applicationjson.md new file mode 100755 index 00000000..64ea8f2a --- /dev/null +++ b/docs/models/operations/getdecisionlog400applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLog400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlog401applicationjson.md b/docs/models/operations/getdecisionlog401applicationjson.md new file mode 100755 index 00000000..61290102 --- /dev/null +++ b/docs/models/operations/getdecisionlog401applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLog401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlog403applicationjson.md b/docs/models/operations/getdecisionlog403applicationjson.md new file mode 100755 index 00000000..ae0ebfb8 --- /dev/null +++ b/docs/models/operations/getdecisionlog403applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLog403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlog404applicationjson.md b/docs/models/operations/getdecisionlog404applicationjson.md new file mode 100755 index 00000000..07151a18 --- /dev/null +++ b/docs/models/operations/getdecisionlog404applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLog404ApplicationJSON + +There was no decision log found for given decision_id, and owner_id. + + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | decision log not found | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlog500applicationjson.md b/docs/models/operations/getdecisionlog500applicationjson.md new file mode 100755 index 00000000..6286f3e7 --- /dev/null +++ b/docs/models/operations/getdecisionlog500applicationjson.md @@ -0,0 +1,10 @@ +# GetDecisionLog500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundle400applicationjson.md b/docs/models/operations/getdecisionlogpolicybundle400applicationjson.md new file mode 100755 index 00000000..437fd7d6 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundle400applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogPolicyBundle400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundle401applicationjson.md b/docs/models/operations/getdecisionlogpolicybundle401applicationjson.md new file mode 100755 index 00000000..b39486f5 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundle401applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogPolicyBundle401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundle403applicationjson.md b/docs/models/operations/getdecisionlogpolicybundle403applicationjson.md new file mode 100755 index 00000000..7e329756 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundle403applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogPolicyBundle403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundle404applicationjson.md b/docs/models/operations/getdecisionlogpolicybundle404applicationjson.md new file mode 100755 index 00000000..9624b6a4 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundle404applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogPolicyBundle404ApplicationJSON + +There was no decision log found for given decision_id, and owner_id. + + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | decision log not found | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundle500applicationjson.md b/docs/models/operations/getdecisionlogpolicybundle500applicationjson.md new file mode 100755 index 00000000..55e36481 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundle500applicationjson.md @@ -0,0 +1,10 @@ +# GetDecisionLogPolicyBundle500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundlerequest.md b/docs/models/operations/getdecisionlogpolicybundlerequest.md new file mode 100755 index 00000000..a29ab5b8 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundlerequest.md @@ -0,0 +1,10 @@ +# GetDecisionLogPolicyBundleRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `context` | *string* | :heavy_check_mark: | N/A | +| `decisionID` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogpolicybundleresponse.md b/docs/models/operations/getdecisionlogpolicybundleresponse.md new file mode 100755 index 00000000..4b2c4e26 --- /dev/null +++ b/docs/models/operations/getdecisionlogpolicybundleresponse.md @@ -0,0 +1,16 @@ +# GetDecisionLogPolicyBundleResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `getDecisionLogPolicyBundle400ApplicationJSONObject` | [GetDecisionLogPolicyBundle400ApplicationJSON](../../models/operations/getdecisionlogpolicybundle400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getDecisionLogPolicyBundle401ApplicationJSONObject` | [GetDecisionLogPolicyBundle401ApplicationJSON](../../models/operations/getdecisionlogpolicybundle401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `getDecisionLogPolicyBundle403ApplicationJSONObject` | [GetDecisionLogPolicyBundle403ApplicationJSON](../../models/operations/getdecisionlogpolicybundle403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getDecisionLogPolicyBundle404ApplicationJSONObject` | [GetDecisionLogPolicyBundle404ApplicationJSON](../../models/operations/getdecisionlogpolicybundle404applicationjson.md) | :heavy_minus_sign: | There was no decision log found for given decision_id, and owner_id.
| +| `getDecisionLogPolicyBundle500ApplicationJSONObject` | [GetDecisionLogPolicyBundle500ApplicationJSON](../../models/operations/getdecisionlogpolicybundle500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `policyBundle` | Record | :heavy_minus_sign: | Policy-Bundle retrieved successfully for given decision log ID | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogrequest.md b/docs/models/operations/getdecisionlogrequest.md new file mode 100755 index 00000000..3aeb461c --- /dev/null +++ b/docs/models/operations/getdecisionlogrequest.md @@ -0,0 +1,10 @@ +# GetDecisionLogRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `context` | *string* | :heavy_check_mark: | N/A | +| `decisionID` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogresponse.md b/docs/models/operations/getdecisionlogresponse.md new file mode 100755 index 00000000..12c1b717 --- /dev/null +++ b/docs/models/operations/getdecisionlogresponse.md @@ -0,0 +1,16 @@ +# GetDecisionLogResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `decisionLog` | [shared.DecisionLog](../../models/shared/decisionlog.md) | :heavy_minus_sign: | Decision log successfully retrieved. | +| `getDecisionLog400ApplicationJSONObject` | [GetDecisionLog400ApplicationJSON](../../models/operations/getdecisionlog400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getDecisionLog401ApplicationJSONObject` | [GetDecisionLog401ApplicationJSON](../../models/operations/getdecisionlog401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `getDecisionLog403ApplicationJSONObject` | [GetDecisionLog403ApplicationJSON](../../models/operations/getdecisionlog403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getDecisionLog404ApplicationJSONObject` | [GetDecisionLog404ApplicationJSON](../../models/operations/getdecisionlog404applicationjson.md) | :heavy_minus_sign: | There was no decision log found for given decision_id, and owner_id.
| +| `getDecisionLog500ApplicationJSONObject` | [GetDecisionLog500ApplicationJSON](../../models/operations/getdecisionlog500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogs400applicationjson.md b/docs/models/operations/getdecisionlogs400applicationjson.md new file mode 100755 index 00000000..deaaed37 --- /dev/null +++ b/docs/models/operations/getdecisionlogs400applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogs400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogs401applicationjson.md b/docs/models/operations/getdecisionlogs401applicationjson.md new file mode 100755 index 00000000..fec4b617 --- /dev/null +++ b/docs/models/operations/getdecisionlogs401applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogs401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogs403applicationjson.md b/docs/models/operations/getdecisionlogs403applicationjson.md new file mode 100755 index 00000000..13854e32 --- /dev/null +++ b/docs/models/operations/getdecisionlogs403applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionLogs403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogs500applicationjson.md b/docs/models/operations/getdecisionlogs500applicationjson.md new file mode 100755 index 00000000..f9cb8fb4 --- /dev/null +++ b/docs/models/operations/getdecisionlogs500applicationjson.md @@ -0,0 +1,10 @@ +# GetDecisionLogs500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogsrequest.md b/docs/models/operations/getdecisionlogsrequest.md new file mode 100755 index 00000000..757b1a3f --- /dev/null +++ b/docs/models/operations/getdecisionlogsrequest.md @@ -0,0 +1,16 @@ +# GetDecisionLogsRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `after` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Return decisions made after this date. | +| `before` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Return decisions made before this date. | +| `branch` | *string* | :heavy_minus_sign: | Return decisions made on this branch. | +| `buildNumber` | *string* | :heavy_minus_sign: | Return decisions made for this build number. | +| `context` | *string* | :heavy_check_mark: | N/A | +| `offset` | *number* | :heavy_minus_sign: | Sets the offset when retrieving the decisions, for paging. | +| `ownerID` | *string* | :heavy_check_mark: | N/A | +| `projectId` | *string* | :heavy_minus_sign: | Return decisions made for this project. | +| `status` | *string* | :heavy_minus_sign: | Return decisions matching this decision status. | \ No newline at end of file diff --git a/docs/models/operations/getdecisionlogsresponse.md b/docs/models/operations/getdecisionlogsresponse.md new file mode 100755 index 00000000..6c3fea09 --- /dev/null +++ b/docs/models/operations/getdecisionlogsresponse.md @@ -0,0 +1,15 @@ +# GetDecisionLogsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `decisionLogs` | [shared.DecisionLog](../../models/shared/decisionlog.md)[] | :heavy_minus_sign: | Decision logs successfully retrieved. | +| `getDecisionLogs400ApplicationJSONObject` | [GetDecisionLogs400ApplicationJSON](../../models/operations/getdecisionlogs400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getDecisionLogs401ApplicationJSONObject` | [GetDecisionLogs401ApplicationJSON](../../models/operations/getdecisionlogs401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `getDecisionLogs403ApplicationJSONObject` | [GetDecisionLogs403ApplicationJSON](../../models/operations/getdecisionlogs403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getDecisionLogs500ApplicationJSONObject` | [GetDecisionLogs500ApplicationJSON](../../models/operations/getdecisionlogs500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getdecisionsettings400applicationjson.md b/docs/models/operations/getdecisionsettings400applicationjson.md new file mode 100755 index 00000000..9f00bd5f --- /dev/null +++ b/docs/models/operations/getdecisionsettings400applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionSettings400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getdecisionsettings401applicationjson.md b/docs/models/operations/getdecisionsettings401applicationjson.md new file mode 100755 index 00000000..2f8a10a4 --- /dev/null +++ b/docs/models/operations/getdecisionsettings401applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionSettings401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getdecisionsettings403applicationjson.md b/docs/models/operations/getdecisionsettings403applicationjson.md new file mode 100755 index 00000000..440caaa0 --- /dev/null +++ b/docs/models/operations/getdecisionsettings403applicationjson.md @@ -0,0 +1,11 @@ +# GetDecisionSettings403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getdecisionsettings500applicationjson.md b/docs/models/operations/getdecisionsettings500applicationjson.md new file mode 100755 index 00000000..51d57545 --- /dev/null +++ b/docs/models/operations/getdecisionsettings500applicationjson.md @@ -0,0 +1,10 @@ +# GetDecisionSettings500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/getdecisionsettingsrequest.md b/docs/models/operations/getdecisionsettingsrequest.md new file mode 100755 index 00000000..0804cf14 --- /dev/null +++ b/docs/models/operations/getdecisionsettingsrequest.md @@ -0,0 +1,9 @@ +# GetDecisionSettingsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `context` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getdecisionsettingsresponse.md b/docs/models/operations/getdecisionsettingsresponse.md new file mode 100755 index 00000000..10a91a36 --- /dev/null +++ b/docs/models/operations/getdecisionsettingsresponse.md @@ -0,0 +1,15 @@ +# GetDecisionSettingsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `decisionSettings` | [shared.DecisionSettings](../../models/shared/decisionsettings.md) | :heavy_minus_sign: | Decision settings successfully retrieved. | +| `getDecisionSettings400ApplicationJSONObject` | [GetDecisionSettings400ApplicationJSON](../../models/operations/getdecisionsettings400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getDecisionSettings401ApplicationJSONObject` | [GetDecisionSettings401ApplicationJSON](../../models/operations/getdecisionsettings401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `getDecisionSettings403ApplicationJSONObject` | [GetDecisionSettings403ApplicationJSON](../../models/operations/getdecisionsettings403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getDecisionSettings500ApplicationJSONObject` | [GetDecisionSettings500ApplicationJSON](../../models/operations/getdecisionsettings500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getenvvardefaultapplicationjson.md b/docs/models/operations/getenvvardefaultapplicationjson.md new file mode 100755 index 00000000..1d30fee2 --- /dev/null +++ b/docs/models/operations/getenvvardefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetEnvVarDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getenvvarenvironmentvariable.md b/docs/models/operations/getenvvarenvironmentvariable.md new file mode 100755 index 00000000..f8d4fa56 --- /dev/null +++ b/docs/models/operations/getenvvarenvironmentvariable.md @@ -0,0 +1,12 @@ +# GetEnvVarEnvironmentVariable + +An environment variable is a map containing a value and an optional timestamp. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | +| `createdAt` | *any* | :heavy_minus_sign: | The creation timestamp of the environment variable. | | +| `name` | *string* | :heavy_check_mark: | The name of the environment variable. | foo | +| `value` | *string* | :heavy_check_mark: | The value of the environment variable. | xxxx1234 | \ No newline at end of file diff --git a/docs/models/operations/getenvvarrequest.md b/docs/models/operations/getenvvarrequest.md new file mode 100755 index 00000000..1d960e80 --- /dev/null +++ b/docs/models/operations/getenvvarrequest.md @@ -0,0 +1,9 @@ +# GetEnvVarRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the environment variable. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getenvvarresponse.md b/docs/models/operations/getenvvarresponse.md new file mode 100755 index 00000000..50efce71 --- /dev/null +++ b/docs/models/operations/getenvvarresponse.md @@ -0,0 +1,12 @@ +# GetEnvVarResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `environmentVariable` | [GetEnvVarEnvironmentVariable](../../models/operations/getenvvarenvironmentvariable.md) | :heavy_minus_sign: | The environment variable. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getEnvVarDefaultApplicationJSONObject` | [GetEnvVarDefaultApplicationJSON](../../models/operations/getenvvardefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getflakytests200applicationjson.md b/docs/models/operations/getflakytests200applicationjson.md new file mode 100755 index 00000000..a8ae98d0 --- /dev/null +++ b/docs/models/operations/getflakytests200applicationjson.md @@ -0,0 +1,11 @@ +# GetFlakyTests200ApplicationJSON + +Flaky tests response + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `flakyTests` | [GetFlakyTests200ApplicationJSONFlakyTests](../../models/operations/getflakytests200applicationjsonflakytests.md)[] | :heavy_check_mark: | A list of all instances of flakes. Note that a test is no longer considered flaky after 2 weeks have passed without a flake. Each flake resets this timer. | | +| `totalFlakyTests` | *number* | :heavy_check_mark: | A count of unique tests that have failed. If your project has N tests that have flaked multiple times each, this will be equal to N. | 5 | \ No newline at end of file diff --git a/docs/models/operations/getflakytests200applicationjsonflakytests.md b/docs/models/operations/getflakytests200applicationjsonflakytests.md new file mode 100755 index 00000000..9f71ef93 --- /dev/null +++ b/docs/models/operations/getflakytests200applicationjsonflakytests.md @@ -0,0 +1,19 @@ +# GetFlakyTests200ApplicationJSONFlakyTests + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `classname` | *string* | :heavy_check_mark: | The class the test belongs to. | +| `file` | *string* | :heavy_check_mark: | The file the test belongs to. | +| `jobName` | *string* | :heavy_check_mark: | The name of the job. | +| `jobNumber` | *number* | :heavy_check_mark: | The number of the job. | +| `pipelineNumber` | *number* | :heavy_check_mark: | The number of the pipeline. | +| `source` | *string* | :heavy_check_mark: | The source of the test. | +| `testName` | *string* | :heavy_check_mark: | The name of the test. | +| `timeWasted` | *number* | :heavy_minus_sign: | N/A | +| `timesFlaked` | *number* | :heavy_check_mark: | The number of times the test flaked. | +| `workflowCreatedAt` | *any* | :heavy_check_mark: | The date and time when workflow was created. | +| `workflowId` | *any* | :heavy_check_mark: | The ID of the workflow associated with the provided test counts | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getflakytestsdefaultapplicationjson.md b/docs/models/operations/getflakytestsdefaultapplicationjson.md new file mode 100755 index 00000000..7fa868d8 --- /dev/null +++ b/docs/models/operations/getflakytestsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetFlakyTestsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getflakytestsrequest.md b/docs/models/operations/getflakytestsrequest.md new file mode 100755 index 00000000..3eb25370 --- /dev/null +++ b/docs/models/operations/getflakytestsrequest.md @@ -0,0 +1,8 @@ +# GetFlakyTestsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getflakytestsresponse.md b/docs/models/operations/getflakytestsresponse.md new file mode 100755 index 00000000..0c26f21f --- /dev/null +++ b/docs/models/operations/getflakytestsresponse.md @@ -0,0 +1,12 @@ +# GetFlakyTestsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getFlakyTests200ApplicationJSONObject` | [GetFlakyTests200ApplicationJSON](../../models/operations/getflakytests200applicationjson.md) | :heavy_minus_sign: | A list of flaky tests for a project | +| `getFlakyTestsDefaultApplicationJSONObject` | [GetFlakyTestsDefaultApplicationJSON](../../models/operations/getflakytestsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getjobartifactsartifactlistresponse.md b/docs/models/operations/getjobartifactsartifactlistresponse.md new file mode 100755 index 00000000..b7b5235a --- /dev/null +++ b/docs/models/operations/getjobartifactsartifactlistresponse.md @@ -0,0 +1,11 @@ +# GetJobArtifactsArtifactListResponse + +A paginated list of the job's artifacts. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `items` | [GetJobArtifactsArtifactListResponseArtifact](../../models/operations/getjobartifactsartifactlistresponseartifact.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getjobartifactsartifactlistresponseartifact.md b/docs/models/operations/getjobartifactsartifactlistresponseartifact.md new file mode 100755 index 00000000..098e0116 --- /dev/null +++ b/docs/models/operations/getjobartifactsartifactlistresponseartifact.md @@ -0,0 +1,12 @@ +# GetJobArtifactsArtifactListResponseArtifact + +An artifact + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | +| `nodeIndex` | *number* | :heavy_check_mark: | The index of the node that stored the artifact. | +| `path` | *string* | :heavy_check_mark: | The artifact path. | +| `url` | *string* | :heavy_check_mark: | The URL to download the artifact contents. | \ No newline at end of file diff --git a/docs/models/operations/getjobartifactsdefaultapplicationjson.md b/docs/models/operations/getjobartifactsdefaultapplicationjson.md new file mode 100755 index 00000000..0dbdab91 --- /dev/null +++ b/docs/models/operations/getjobartifactsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetJobArtifactsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getjobartifactsrequest.md b/docs/models/operations/getjobartifactsrequest.md new file mode 100755 index 00000000..bb3cafe7 --- /dev/null +++ b/docs/models/operations/getjobartifactsrequest.md @@ -0,0 +1,9 @@ +# GetJobArtifactsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `jobNumber` | *any* | :heavy_check_mark: | The number of the job. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getjobartifactsresponse.md b/docs/models/operations/getjobartifactsresponse.md new file mode 100755 index 00000000..679af540 --- /dev/null +++ b/docs/models/operations/getjobartifactsresponse.md @@ -0,0 +1,12 @@ +# GetJobArtifactsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `artifactListResponse` | [GetJobArtifactsArtifactListResponse](../../models/operations/getjobartifactsartifactlistresponse.md) | :heavy_minus_sign: | A paginated list of the job's artifacts. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getJobArtifactsDefaultApplicationJSONObject` | [GetJobArtifactsDefaultApplicationJSON](../../models/operations/getjobartifactsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsdefaultapplicationjson.md b/docs/models/operations/getjobdetailsdefaultapplicationjson.md new file mode 100755 index 00000000..e3b4de54 --- /dev/null +++ b/docs/models/operations/getjobdetailsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetJobDetailsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetails.md b/docs/models/operations/getjobdetailsjobdetails.md new file mode 100755 index 00000000..1efd8127 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetails.md @@ -0,0 +1,27 @@ +# GetJobDetailsJobDetails + +Job Details + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contexts` | [GetJobDetailsJobDetailsContexts](../../models/operations/getjobdetailsjobdetailscontexts.md)[] | :heavy_check_mark: | List of contexts used by the job. | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The time when the job was created. | +| `duration` | *number* | :heavy_check_mark: | Duration of a job in milliseconds. | +| `executor` | [GetJobDetailsJobDetailsExecutor](../../models/operations/getjobdetailsjobdetailsexecutor.md) | :heavy_check_mark: | Information about executor used for a job. | +| `latestWorkflow` | [GetJobDetailsJobDetailsLatestWorkflow](../../models/operations/getjobdetailsjobdetailslatestworkflow.md) | :heavy_check_mark: | Info about the latest workflow the job was a part of. | +| `messages` | [GetJobDetailsJobDetailsMessages](../../models/operations/getjobdetailsjobdetailsmessages.md)[] | :heavy_check_mark: | Messages from CircleCI execution platform. | +| `name` | *string* | :heavy_check_mark: | The name of the job. | +| `number` | *number* | :heavy_check_mark: | The number of the job. | +| `organization` | [GetJobDetailsJobDetailsOrganization](../../models/operations/getjobdetailsjobdetailsorganization.md) | :heavy_check_mark: | Information about an organization. | +| `parallelRuns` | [GetJobDetailsJobDetailsParallelRuns](../../models/operations/getjobdetailsjobdetailsparallelruns.md)[] | :heavy_check_mark: | Info about parallels runs and their status. | +| `parallelism` | *number* | :heavy_check_mark: | A number of parallel runs the job has. | +| `pipeline` | [GetJobDetailsJobDetailsPipeline](../../models/operations/getjobdetailsjobdetailspipeline.md) | :heavy_check_mark: | Info about a pipeline the job is a part of. | +| `project` | [GetJobDetailsJobDetailsProject](../../models/operations/getjobdetailsjobdetailsproject.md) | :heavy_check_mark: | Information about a project. | +| `queuedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The time when the job was placed in a queue. | +| `startedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the job started. | +| `status` | [GetJobDetailsJobDetailsStatus](../../models/operations/getjobdetailsjobdetailsstatus.md) | :heavy_check_mark: | The current status of the job. | +| `stoppedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The time when the job stopped. | +| `webUrl` | *string* | :heavy_check_mark: | URL of the job in CircleCI Web UI. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailscontexts.md b/docs/models/operations/getjobdetailsjobdetailscontexts.md new file mode 100755 index 00000000..a17c2ab6 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailscontexts.md @@ -0,0 +1,10 @@ +# GetJobDetailsJobDetailsContexts + +Information about the context. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `name` | *string* | :heavy_check_mark: | The name of the context. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailsexecutor.md b/docs/models/operations/getjobdetailsjobdetailsexecutor.md new file mode 100755 index 00000000..661674b4 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailsexecutor.md @@ -0,0 +1,11 @@ +# GetJobDetailsJobDetailsExecutor + +Information about executor used for a job. + + +## Fields + +| Field | Type | Required | Description | +| -------------------- | -------------------- | -------------------- | -------------------- | +| `resourceClass` | *string* | :heavy_check_mark: | Resource class name. | +| `type` | *string* | :heavy_minus_sign: | Executor type. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailslatestworkflow.md b/docs/models/operations/getjobdetailsjobdetailslatestworkflow.md new file mode 100755 index 00000000..2a2c5d91 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailslatestworkflow.md @@ -0,0 +1,11 @@ +# GetJobDetailsJobDetailsLatestWorkflow + +Info about the latest workflow the job was a part of. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | | +| `name` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailsmessages.md b/docs/models/operations/getjobdetailsjobdetailsmessages.md new file mode 100755 index 00000000..4c602aa9 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailsmessages.md @@ -0,0 +1,12 @@ +# GetJobDetailsJobDetailsMessages + +Message from CircleCI execution platform. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | Information describing message. | +| `reason` | *string* | :heavy_minus_sign: | Value describing the reason for message to be added to the job. | +| `type` | *string* | :heavy_check_mark: | Message type. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailsorganization.md b/docs/models/operations/getjobdetailsjobdetailsorganization.md new file mode 100755 index 00000000..9d39b9c9 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailsorganization.md @@ -0,0 +1,10 @@ +# GetJobDetailsJobDetailsOrganization + +Information about an organization. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | +| `name` | *string* | :heavy_check_mark: | The name of the organization. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailsparallelruns.md b/docs/models/operations/getjobdetailsjobdetailsparallelruns.md new file mode 100755 index 00000000..033b48e9 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailsparallelruns.md @@ -0,0 +1,11 @@ +# GetJobDetailsJobDetailsParallelRuns + +Info about a status of the parallel run. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `index` | *number* | :heavy_check_mark: | Index of the parallel run. | +| `status` | *string* | :heavy_check_mark: | Status of the parallel run. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailspipeline.md b/docs/models/operations/getjobdetailsjobdetailspipeline.md new file mode 100755 index 00000000..358a8b8c --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailspipeline.md @@ -0,0 +1,10 @@ +# GetJobDetailsJobDetailsPipeline + +Info about a pipeline the job is a part of. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailsproject.md b/docs/models/operations/getjobdetailsjobdetailsproject.md new file mode 100755 index 00000000..5b7a8e96 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailsproject.md @@ -0,0 +1,13 @@ +# GetJobDetailsJobDetailsProject + +Information about a project. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `externalUrl` | *string* | :heavy_check_mark: | URL to the repository hosting the project's code | https://github.com/CircleCI-Public/api-preview-docs | +| `id` | *string* | :heavy_check_mark: | N/A | | +| `name` | *string* | :heavy_check_mark: | The name of the project | api-preview-docs | +| `slug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | gh/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsjobdetailsstatus.md b/docs/models/operations/getjobdetailsjobdetailsstatus.md new file mode 100755 index 00000000..72ea8f92 --- /dev/null +++ b/docs/models/operations/getjobdetailsjobdetailsstatus.md @@ -0,0 +1,23 @@ +# GetJobDetailsJobDetailsStatus + +The current status of the job. + + +## Values + +| Name | Value | +| -------------------- | -------------------- | +| `Success` | success | +| `Running` | running | +| `NotRun` | not_run | +| `Failed` | failed | +| `Retried` | retried | +| `Queued` | queued | +| `NotRunning` | not_running | +| `InfrastructureFail` | infrastructure_fail | +| `Timedout` | timedout | +| `OnHold` | on_hold | +| `TerminatedUnknown` | terminated-unknown | +| `Blocked` | blocked | +| `Canceled` | canceled | +| `Unauthorized` | unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsrequest.md b/docs/models/operations/getjobdetailsrequest.md new file mode 100755 index 00000000..f3bf7058 --- /dev/null +++ b/docs/models/operations/getjobdetailsrequest.md @@ -0,0 +1,9 @@ +# GetJobDetailsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `jobNumber` | *any* | :heavy_check_mark: | The number of the job. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getjobdetailsresponse.md b/docs/models/operations/getjobdetailsresponse.md new file mode 100755 index 00000000..d1744adf --- /dev/null +++ b/docs/models/operations/getjobdetailsresponse.md @@ -0,0 +1,12 @@ +# GetJobDetailsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `jobDetails` | [GetJobDetailsJobDetails](../../models/operations/getjobdetailsjobdetails.md) | :heavy_minus_sign: | Job details. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getJobDetailsDefaultApplicationJSONObject` | [GetJobDetailsDefaultApplicationJSON](../../models/operations/getjobdetailsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseries200applicationjson.md b/docs/models/operations/getjobtimeseries200applicationjson.md new file mode 100755 index 00000000..6b55df55 --- /dev/null +++ b/docs/models/operations/getjobtimeseries200applicationjson.md @@ -0,0 +1,11 @@ +# GetJobTimeseries200ApplicationJSON + +Project level timeseries metrics response + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `items` | [GetJobTimeseries200ApplicationJSONItems](../../models/operations/getjobtimeseries200applicationjsonitems.md)[] | :heavy_check_mark: | Aggregate metrics for a workflow at a time granularity | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseries200applicationjsonitems.md b/docs/models/operations/getjobtimeseries200applicationjsonitems.md new file mode 100755 index 00000000..acd5b8e0 --- /dev/null +++ b/docs/models/operations/getjobtimeseries200applicationjsonitems.md @@ -0,0 +1,12 @@ +# GetJobTimeseries200ApplicationJSONItems + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `maxEndedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The end time of the last execution included in the metrics. | | +| `metrics` | [GetJobTimeseries200ApplicationJSONItemsMetrics](../../models/operations/getjobtimeseries200applicationjsonitemsmetrics.md) | :heavy_check_mark: | Metrics relating to a workflow's runs. | | +| `minStartedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The start time for the earliest execution included in the metrics. | | +| `name` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | +| `timestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The start of the interval for timeseries metrics. | | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseries200applicationjsonitemsmetrics.md b/docs/models/operations/getjobtimeseries200applicationjsonitemsmetrics.md new file mode 100755 index 00000000..bf4b486a --- /dev/null +++ b/docs/models/operations/getjobtimeseries200applicationjsonitemsmetrics.md @@ -0,0 +1,16 @@ +# GetJobTimeseries200ApplicationJSONItemsMetrics + +Metrics relating to a workflow's runs. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `durationMetrics` | [GetJobTimeseries200ApplicationJSONItemsMetricsDurationMetrics](../../models/operations/getjobtimeseries200applicationjsonitemsmetricsdurationmetrics.md) | :heavy_check_mark: | Metrics relating to the duration of runs for a workflow. | +| `failedRuns` | *number* | :heavy_check_mark: | The number of failed runs. | +| `medianCreditsUsed` | *number* | :heavy_check_mark: | The median credits consumed over the current timeseries interval. | +| `successfulRuns` | *number* | :heavy_check_mark: | The number of successful runs. | +| `throughput` | *number* | :heavy_check_mark: | The average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed over the current timeseries interval. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseries200applicationjsonitemsmetricsdurationmetrics.md b/docs/models/operations/getjobtimeseries200applicationjsonitemsmetricsdurationmetrics.md new file mode 100755 index 00000000..9cd285a4 --- /dev/null +++ b/docs/models/operations/getjobtimeseries200applicationjsonitemsmetricsdurationmetrics.md @@ -0,0 +1,14 @@ +# GetJobTimeseries200ApplicationJSONItemsMetricsDurationMetrics + +Metrics relating to the duration of runs for a workflow. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `max` | *number* | :heavy_check_mark: | The max duration, in seconds, among a group of runs. | +| `median` | *number* | :heavy_check_mark: | The median duration, in seconds, among a group of runs. | +| `min` | *number* | :heavy_check_mark: | The minimum duration, in seconds, among a group of runs. | +| `p95` | *number* | :heavy_check_mark: | The 95th percentile duration, in seconds, among a group of runs. | +| `total` | *number* | :heavy_check_mark: | The total duration, in seconds, added across a group of runs. | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseriesdefaultapplicationjson.md b/docs/models/operations/getjobtimeseriesdefaultapplicationjson.md new file mode 100755 index 00000000..992787e5 --- /dev/null +++ b/docs/models/operations/getjobtimeseriesdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetJobTimeseriesDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseriesgranularity.md b/docs/models/operations/getjobtimeseriesgranularity.md new file mode 100755 index 00000000..51b275dc --- /dev/null +++ b/docs/models/operations/getjobtimeseriesgranularity.md @@ -0,0 +1,11 @@ +# GetJobTimeseriesGranularity + +The granularity for which to query timeseries data. + + +## Values + +| Name | Value | +| -------- | -------- | +| `Daily` | daily | +| `Hourly` | hourly | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseriesrequest.md b/docs/models/operations/getjobtimeseriesrequest.md new file mode 100755 index 00000000..aefee51b --- /dev/null +++ b/docs/models/operations/getjobtimeseriesrequest.md @@ -0,0 +1,13 @@ +# GetJobTimeseriesRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. If not passed we will scope the API call to the default branch. | +| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Include only executions that started before this date. This date can be at most 90 days after the start-date. | +| `granularity` | [GetJobTimeseriesGranularity](../../models/operations/getjobtimeseriesgranularity.md) | :heavy_minus_sign: | The granularity for which to query timeseries data. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Include only executions that started at or after this date. This must be specified if an end-date is provided. | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getjobtimeseriesresponse.md b/docs/models/operations/getjobtimeseriesresponse.md new file mode 100755 index 00000000..cd7e55b0 --- /dev/null +++ b/docs/models/operations/getjobtimeseriesresponse.md @@ -0,0 +1,12 @@ +# GetJobTimeseriesResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getJobTimeseries200ApplicationJSONObject` | [GetJobTimeseries200ApplicationJSON](../../models/operations/getjobtimeseries200applicationjson.md) | :heavy_minus_sign: | An array of timeseries data, one entry per job. | +| `getJobTimeseriesDefaultApplicationJSONObject` | [GetJobTimeseriesDefaultApplicationJSON](../../models/operations/getjobtimeseriesdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getorgclaims400applicationjson.md b/docs/models/operations/getorgclaims400applicationjson.md new file mode 100755 index 00000000..886f490b --- /dev/null +++ b/docs/models/operations/getorgclaims400applicationjson.md @@ -0,0 +1,11 @@ +# GetOrgClaims400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getorgclaims403applicationjson.md b/docs/models/operations/getorgclaims403applicationjson.md new file mode 100755 index 00000000..931d34b6 --- /dev/null +++ b/docs/models/operations/getorgclaims403applicationjson.md @@ -0,0 +1,11 @@ +# GetOrgClaims403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getorgclaims500applicationjson.md b/docs/models/operations/getorgclaims500applicationjson.md new file mode 100755 index 00000000..c00352c2 --- /dev/null +++ b/docs/models/operations/getorgclaims500applicationjson.md @@ -0,0 +1,10 @@ +# GetOrgClaims500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | internal server error | \ No newline at end of file diff --git a/docs/models/operations/getorgclaimsrequest.md b/docs/models/operations/getorgclaimsrequest.md new file mode 100755 index 00000000..4a343638 --- /dev/null +++ b/docs/models/operations/getorgclaimsrequest.md @@ -0,0 +1,8 @@ +# GetOrgClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `orgID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getorgclaimsresponse.md b/docs/models/operations/getorgclaimsresponse.md new file mode 100755 index 00000000..1add2d44 --- /dev/null +++ b/docs/models/operations/getorgclaimsresponse.md @@ -0,0 +1,14 @@ +# GetOrgClaimsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `claimResponse` | [shared.ClaimResponse](../../models/shared/claimresponse.md) | :heavy_minus_sign: | Claims successfully fetched. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `getOrgClaims400ApplicationJSONObject` | [GetOrgClaims400ApplicationJSON](../../models/operations/getorgclaims400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getOrgClaims403ApplicationJSONObject` | [GetOrgClaims403ApplicationJSON](../../models/operations/getorgclaims403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getOrgClaims500ApplicationJSONObject` | [GetOrgClaims500ApplicationJSON](../../models/operations/getorgclaims500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjson.md b/docs/models/operations/getorgsummarydata200applicationjson.md new file mode 100755 index 00000000..bf3d9bd4 --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjson.md @@ -0,0 +1,12 @@ +# GetOrgSummaryData200ApplicationJSON + +Summary metrics with trends for the entire org, and for each project. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `allProjects` | *string*[] | :heavy_check_mark: | A list of all the project names in the organization. | +| `orgData` | [GetOrgSummaryData200ApplicationJSONOrgData](../../models/operations/getorgsummarydata200applicationjsonorgdata.md) | :heavy_check_mark: | Aggregated metrics for an org, with trends. | +| `orgProjectData` | [GetOrgSummaryData200ApplicationJSONOrgProjectData](../../models/operations/getorgsummarydata200applicationjsonorgprojectdata.md)[] | :heavy_check_mark: | Metrics for a single project, across all branches | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjsonorgdata.md b/docs/models/operations/getorgsummarydata200applicationjsonorgdata.md new file mode 100755 index 00000000..ff9669b0 --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjsonorgdata.md @@ -0,0 +1,11 @@ +# GetOrgSummaryData200ApplicationJSONOrgData + +Aggregated metrics for an org, with trends. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetOrgSummaryData200ApplicationJSONOrgDataMetrics](../../models/operations/getorgsummarydata200applicationjsonorgdatametrics.md) | :heavy_check_mark: | Metrics for a single org metrics. | +| `trends` | [GetOrgSummaryData200ApplicationJSONOrgDataTrends](../../models/operations/getorgsummarydata200applicationjsonorgdatatrends.md) | :heavy_check_mark: | Trends for a single org. | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjsonorgdatametrics.md b/docs/models/operations/getorgsummarydata200applicationjsonorgdatametrics.md new file mode 100755 index 00000000..56950b1e --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjsonorgdatametrics.md @@ -0,0 +1,14 @@ +# GetOrgSummaryData200ApplicationJSONOrgDataMetrics + +Metrics for a single org metrics. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `throughput` | *number* | :heavy_check_mark: | The average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed over the current timeseries interval. | +| `totalDurationSecs` | *number* | :heavy_check_mark: | Total duration, in seconds. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjsonorgdatatrends.md b/docs/models/operations/getorgsummarydata200applicationjsonorgdatatrends.md new file mode 100755 index 00000000..9dafdd90 --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjsonorgdatatrends.md @@ -0,0 +1,14 @@ +# GetOrgSummaryData200ApplicationJSONOrgDataTrends + +Trends for a single org. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | +| `successRate` | *number* | :heavy_check_mark: | The trend value for the success rate. | +| `throughput` | *number* | :heavy_check_mark: | Trend value for the average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The trend value for total credits consumed. | +| `totalDurationSecs` | *number* | :heavy_check_mark: | Trend value for total duration. | +| `totalRuns` | *number* | :heavy_check_mark: | The trend value for total number of runs. | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdata.md b/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdata.md new file mode 100755 index 00000000..86c60ab5 --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdata.md @@ -0,0 +1,10 @@ +# GetOrgSummaryData200ApplicationJSONOrgProjectData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetOrgSummaryData200ApplicationJSONOrgProjectDataMetrics](../../models/operations/getorgsummarydata200applicationjsonorgprojectdatametrics.md) | :heavy_check_mark: | Metrics for a single project, across all branches. | | +| `projectName` | *string* | :heavy_check_mark: | The name of the project. | api-preview-docs | +| `trends` | [GetOrgSummaryData200ApplicationJSONOrgProjectDataTrends](../../models/operations/getorgsummarydata200applicationjsonorgprojectdatatrends.md) | :heavy_check_mark: | Trends for a single project, across all branches. | | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatametrics.md b/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatametrics.md new file mode 100755 index 00000000..c4d8df11 --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatametrics.md @@ -0,0 +1,13 @@ +# GetOrgSummaryData200ApplicationJSONOrgProjectDataMetrics + +Metrics for a single project, across all branches. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed over the current timeseries interval. | +| `totalDurationSecs` | *number* | :heavy_check_mark: | Total duration, in seconds. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatatrends.md b/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatatrends.md new file mode 100755 index 00000000..216be4d9 --- /dev/null +++ b/docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatatrends.md @@ -0,0 +1,13 @@ +# GetOrgSummaryData200ApplicationJSONOrgProjectDataTrends + +Trends for a single project, across all branches. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `successRate` | *number* | :heavy_check_mark: | The trend value for the success rate. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The trend value for total credits consumed. | +| `totalDurationSecs` | *number* | :heavy_check_mark: | Trend value for total duration. | +| `totalRuns` | *number* | :heavy_check_mark: | The trend value for total number of runs. | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydatadefaultapplicationjson.md b/docs/models/operations/getorgsummarydatadefaultapplicationjson.md new file mode 100755 index 00000000..eb3cb770 --- /dev/null +++ b/docs/models/operations/getorgsummarydatadefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetOrgSummaryDataDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydataprojectnames.md b/docs/models/operations/getorgsummarydataprojectnames.md new file mode 100755 index 00000000..5403f9a5 --- /dev/null +++ b/docs/models/operations/getorgsummarydataprojectnames.md @@ -0,0 +1,9 @@ +# GetOrgSummaryDataProjectNames + +List of project names. + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydatareportingwindow.md b/docs/models/operations/getorgsummarydatareportingwindow.md new file mode 100755 index 00000000..667b8be3 --- /dev/null +++ b/docs/models/operations/getorgsummarydatareportingwindow.md @@ -0,0 +1,14 @@ +# GetOrgSummaryDataReportingWindow + +The time window used to calculate summary metrics. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Last7Days` | last-7-days | +| `Last90Days` | last-90-days | +| `Last24Hours` | last-24-hours | +| `Last30Days` | last-30-days | +| `Last60Days` | last-60-days | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydatarequest.md b/docs/models/operations/getorgsummarydatarequest.md new file mode 100755 index 00000000..1c29b533 --- /dev/null +++ b/docs/models/operations/getorgsummarydatarequest.md @@ -0,0 +1,10 @@ +# GetOrgSummaryDataRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `orgSlug` | *string* | :heavy_check_mark: | Org slug in the form `vcs-slug/org-name`. The `/` characters may be URL-escaped. | +| `projectNames` | [GetOrgSummaryDataProjectNames](../../models/operations/getorgsummarydataprojectnames.md) | :heavy_minus_sign: | List of project names. | +| `reportingWindow` | [GetOrgSummaryDataReportingWindow](../../models/operations/getorgsummarydatareportingwindow.md) | :heavy_minus_sign: | The time window used to calculate summary metrics. | \ No newline at end of file diff --git a/docs/models/operations/getorgsummarydataresponse.md b/docs/models/operations/getorgsummarydataresponse.md new file mode 100755 index 00000000..4af52e7f --- /dev/null +++ b/docs/models/operations/getorgsummarydataresponse.md @@ -0,0 +1,12 @@ +# GetOrgSummaryDataResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getOrgSummaryData200ApplicationJSONObject` | [GetOrgSummaryData200ApplicationJSON](../../models/operations/getorgsummarydata200applicationjson.md) | :heavy_minus_sign: | summary metrics with trends for an entire org and it's projects. | +| `getOrgSummaryDataDefaultApplicationJSONObject` | [GetOrgSummaryDataDefaultApplicationJSON](../../models/operations/getorgsummarydatadefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyiddefaultapplicationjson.md b/docs/models/operations/getpipelinebyiddefaultapplicationjson.md new file mode 100755 index 00000000..4c675741 --- /dev/null +++ b/docs/models/operations/getpipelinebyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetPipelineByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipeline.md b/docs/models/operations/getpipelinebyidpipeline.md new file mode 100755 index 00000000..d4e465ae --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipeline.md @@ -0,0 +1,19 @@ +# GetPipelineByIdPipeline + +A pipeline response. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `errors` | [GetPipelineByIdPipelineErrors](../../models/operations/getpipelinebyidpipelineerrors.md)[] | :heavy_check_mark: | A sequence of errors that have occurred within the pipeline. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `number` | *number* | :heavy_check_mark: | The number of the pipeline. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline. | gh/CircleCI-Public/api-preview-docs | +| `state` | [GetPipelineByIdPipelineState](../../models/operations/getpipelinebyidpipelinestate.md) | :heavy_check_mark: | The current state of the pipeline. | | +| `trigger` | [GetPipelineByIdPipelineTrigger](../../models/operations/getpipelinebyidpipelinetrigger.md) | :heavy_check_mark: | A summary of the trigger. | | +| `triggerParameters` | Record | :heavy_minus_sign: | N/A | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the pipeline was last updated. | | +| `vcs` | [GetPipelineByIdPipelineVcs](../../models/operations/getpipelinebyidpipelinevcs.md) | :heavy_minus_sign: | VCS information for the pipeline. | | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelineerrors.md b/docs/models/operations/getpipelinebyidpipelineerrors.md new file mode 100755 index 00000000..c4fb52f9 --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelineerrors.md @@ -0,0 +1,11 @@ +# GetPipelineByIdPipelineErrors + +An error with a type and message. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | A human-readable error message. | +| `type` | [GetPipelineByIdPipelineErrorsType](../../models/operations/getpipelinebyidpipelineerrorstype.md) | :heavy_check_mark: | The type of error. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelineerrorstype.md b/docs/models/operations/getpipelinebyidpipelineerrorstype.md new file mode 100755 index 00000000..43bf6680 --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelineerrorstype.md @@ -0,0 +1,15 @@ +# GetPipelineByIdPipelineErrorsType + +The type of error. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Config` | config | +| `ConfigFetch` | config-fetch | +| `Timeout` | timeout | +| `Permission` | permission | +| `Other` | other | +| `Plan` | plan | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelinestate.md b/docs/models/operations/getpipelinebyidpipelinestate.md new file mode 100755 index 00000000..26180b39 --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelinestate.md @@ -0,0 +1,14 @@ +# GetPipelineByIdPipelineState + +The current state of the pipeline. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Created` | created | +| `Errored` | errored | +| `SetupPending` | setup-pending | +| `Setup` | setup | +| `Pending` | pending | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelinetrigger.md b/docs/models/operations/getpipelinebyidpipelinetrigger.md new file mode 100755 index 00000000..f4096ee9 --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelinetrigger.md @@ -0,0 +1,12 @@ +# GetPipelineByIdPipelineTrigger + +A summary of the trigger. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `actor` | [GetPipelineByIdPipelineTriggerActor](../../models/operations/getpipelinebyidpipelinetriggeractor.md) | :heavy_check_mark: | The user who triggered the Pipeline. | +| `receivedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the trigger was received. | +| `type` | [GetPipelineByIdPipelineTriggerType](../../models/operations/getpipelinebyidpipelinetriggertype.md) | :heavy_check_mark: | The type of trigger. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelinetriggeractor.md b/docs/models/operations/getpipelinebyidpipelinetriggeractor.md new file mode 100755 index 00000000..72271493 --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelinetriggeractor.md @@ -0,0 +1,11 @@ +# GetPipelineByIdPipelineTriggerActor + +The user who triggered the Pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `avatarUrl` | *string* | :heavy_check_mark: | URL to the user's avatar on the VCS | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelinetriggertype.md b/docs/models/operations/getpipelinebyidpipelinetriggertype.md new file mode 100755 index 00000000..bae07eec --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelinetriggertype.md @@ -0,0 +1,13 @@ +# GetPipelineByIdPipelineTriggerType + +The type of trigger. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ScheduledPipeline` | scheduled_pipeline | +| `Explicit` | explicit | +| `Api` | api | +| `Webhook` | webhook | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelinevcs.md b/docs/models/operations/getpipelinebyidpipelinevcs.md new file mode 100755 index 00000000..9df3299f --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelinevcs.md @@ -0,0 +1,18 @@ +# GetPipelineByIdPipelineVcs + +VCS information for the pipeline. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull//head` for the PR ref or `pull//merge` for the merge ref (GitHub only). | feature/design-new-api | +| `commit` | [GetPipelineByIdPipelineVcsCommit](../../models/operations/getpipelinebyidpipelinevcscommit.md) | :heavy_minus_sign: | The latest commit in the pipeline. | | +| `originRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | +| `providerName` | *string* | :heavy_check_mark: | Name of the VCS provider (e.g. GitHub, Bitbucket). | GitHub | +| `reviewId` | *string* | :heavy_minus_sign: | The code review id. | 123 | +| `reviewUrl` | *string* | :heavy_minus_sign: | The code review URL. | https://github.com/CircleCI-Public/api-preview-docs/pull/123 | +| `revision` | *string* | :heavy_check_mark: | The code revision the pipeline ran. | f454a02b5d10fcccfd7d9dd7608a76d6493a98b4 | +| `tag` | *string* | :heavy_minus_sign: | The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. | v3.1.4159 | +| `targetRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidpipelinevcscommit.md b/docs/models/operations/getpipelinebyidpipelinevcscommit.md new file mode 100755 index 00000000..c8ad448e --- /dev/null +++ b/docs/models/operations/getpipelinebyidpipelinevcscommit.md @@ -0,0 +1,11 @@ +# GetPipelineByIdPipelineVcsCommit + +The latest commit in the pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the commit message. | +| `subject` | *string* | :heavy_check_mark: | The subject of the commit message. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidrequest.md b/docs/models/operations/getpipelinebyidrequest.md new file mode 100755 index 00000000..85e61d4c --- /dev/null +++ b/docs/models/operations/getpipelinebyidrequest.md @@ -0,0 +1,8 @@ +# GetPipelineByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `pipelineId` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebyidresponse.md b/docs/models/operations/getpipelinebyidresponse.md new file mode 100755 index 00000000..67a4d853 --- /dev/null +++ b/docs/models/operations/getpipelinebyidresponse.md @@ -0,0 +1,12 @@ +# GetPipelineByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipeline` | [GetPipelineByIdPipeline](../../models/operations/getpipelinebyidpipeline.md) | :heavy_minus_sign: | A pipeline object. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getPipelineByIdDefaultApplicationJSONObject` | [GetPipelineByIdDefaultApplicationJSON](../../models/operations/getpipelinebyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberdefaultapplicationjson.md b/docs/models/operations/getpipelinebynumberdefaultapplicationjson.md new file mode 100755 index 00000000..e666cf68 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetPipelineByNumberDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipeline.md b/docs/models/operations/getpipelinebynumberpipeline.md new file mode 100755 index 00000000..1b86df60 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipeline.md @@ -0,0 +1,19 @@ +# GetPipelineByNumberPipeline + +A pipeline response. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `errors` | [GetPipelineByNumberPipelineErrors](../../models/operations/getpipelinebynumberpipelineerrors.md)[] | :heavy_check_mark: | A sequence of errors that have occurred within the pipeline. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `number` | *number* | :heavy_check_mark: | The number of the pipeline. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline. | gh/CircleCI-Public/api-preview-docs | +| `state` | [GetPipelineByNumberPipelineState](../../models/operations/getpipelinebynumberpipelinestate.md) | :heavy_check_mark: | The current state of the pipeline. | | +| `trigger` | [GetPipelineByNumberPipelineTrigger](../../models/operations/getpipelinebynumberpipelinetrigger.md) | :heavy_check_mark: | A summary of the trigger. | | +| `triggerParameters` | Record | :heavy_minus_sign: | N/A | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the pipeline was last updated. | | +| `vcs` | [GetPipelineByNumberPipelineVcs](../../models/operations/getpipelinebynumberpipelinevcs.md) | :heavy_minus_sign: | VCS information for the pipeline. | | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelineerrors.md b/docs/models/operations/getpipelinebynumberpipelineerrors.md new file mode 100755 index 00000000..56b428d7 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelineerrors.md @@ -0,0 +1,11 @@ +# GetPipelineByNumberPipelineErrors + +An error with a type and message. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | A human-readable error message. | +| `type` | [GetPipelineByNumberPipelineErrorsType](../../models/operations/getpipelinebynumberpipelineerrorstype.md) | :heavy_check_mark: | The type of error. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelineerrorstype.md b/docs/models/operations/getpipelinebynumberpipelineerrorstype.md new file mode 100755 index 00000000..19bd25ae --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelineerrorstype.md @@ -0,0 +1,15 @@ +# GetPipelineByNumberPipelineErrorsType + +The type of error. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Config` | config | +| `ConfigFetch` | config-fetch | +| `Timeout` | timeout | +| `Permission` | permission | +| `Other` | other | +| `Plan` | plan | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelinestate.md b/docs/models/operations/getpipelinebynumberpipelinestate.md new file mode 100755 index 00000000..46911c50 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelinestate.md @@ -0,0 +1,14 @@ +# GetPipelineByNumberPipelineState + +The current state of the pipeline. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Created` | created | +| `Errored` | errored | +| `SetupPending` | setup-pending | +| `Setup` | setup | +| `Pending` | pending | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelinetrigger.md b/docs/models/operations/getpipelinebynumberpipelinetrigger.md new file mode 100755 index 00000000..0215a877 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelinetrigger.md @@ -0,0 +1,12 @@ +# GetPipelineByNumberPipelineTrigger + +A summary of the trigger. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `actor` | [GetPipelineByNumberPipelineTriggerActor](../../models/operations/getpipelinebynumberpipelinetriggeractor.md) | :heavy_check_mark: | The user who triggered the Pipeline. | +| `receivedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the trigger was received. | +| `type` | [GetPipelineByNumberPipelineTriggerType](../../models/operations/getpipelinebynumberpipelinetriggertype.md) | :heavy_check_mark: | The type of trigger. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelinetriggeractor.md b/docs/models/operations/getpipelinebynumberpipelinetriggeractor.md new file mode 100755 index 00000000..f97ce73d --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelinetriggeractor.md @@ -0,0 +1,11 @@ +# GetPipelineByNumberPipelineTriggerActor + +The user who triggered the Pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `avatarUrl` | *string* | :heavy_check_mark: | URL to the user's avatar on the VCS | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelinetriggertype.md b/docs/models/operations/getpipelinebynumberpipelinetriggertype.md new file mode 100755 index 00000000..452f13c6 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelinetriggertype.md @@ -0,0 +1,13 @@ +# GetPipelineByNumberPipelineTriggerType + +The type of trigger. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ScheduledPipeline` | scheduled_pipeline | +| `Explicit` | explicit | +| `Api` | api | +| `Webhook` | webhook | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelinevcs.md b/docs/models/operations/getpipelinebynumberpipelinevcs.md new file mode 100755 index 00000000..e46770f0 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelinevcs.md @@ -0,0 +1,18 @@ +# GetPipelineByNumberPipelineVcs + +VCS information for the pipeline. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull//head` for the PR ref or `pull//merge` for the merge ref (GitHub only). | feature/design-new-api | +| `commit` | [GetPipelineByNumberPipelineVcsCommit](../../models/operations/getpipelinebynumberpipelinevcscommit.md) | :heavy_minus_sign: | The latest commit in the pipeline. | | +| `originRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | +| `providerName` | *string* | :heavy_check_mark: | Name of the VCS provider (e.g. GitHub, Bitbucket). | GitHub | +| `reviewId` | *string* | :heavy_minus_sign: | The code review id. | 123 | +| `reviewUrl` | *string* | :heavy_minus_sign: | The code review URL. | https://github.com/CircleCI-Public/api-preview-docs/pull/123 | +| `revision` | *string* | :heavy_check_mark: | The code revision the pipeline ran. | f454a02b5d10fcccfd7d9dd7608a76d6493a98b4 | +| `tag` | *string* | :heavy_minus_sign: | The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. | v3.1.4159 | +| `targetRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberpipelinevcscommit.md b/docs/models/operations/getpipelinebynumberpipelinevcscommit.md new file mode 100755 index 00000000..23a86d0a --- /dev/null +++ b/docs/models/operations/getpipelinebynumberpipelinevcscommit.md @@ -0,0 +1,11 @@ +# GetPipelineByNumberPipelineVcsCommit + +The latest commit in the pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the commit message. | +| `subject` | *string* | :heavy_check_mark: | The subject of the commit message. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberrequest.md b/docs/models/operations/getpipelinebynumberrequest.md new file mode 100755 index 00000000..1cb8b6ee --- /dev/null +++ b/docs/models/operations/getpipelinebynumberrequest.md @@ -0,0 +1,9 @@ +# GetPipelineByNumberRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `pipelineNumber` | *any* | :heavy_check_mark: | The number of the pipeline. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getpipelinebynumberresponse.md b/docs/models/operations/getpipelinebynumberresponse.md new file mode 100755 index 00000000..2f9c3d05 --- /dev/null +++ b/docs/models/operations/getpipelinebynumberresponse.md @@ -0,0 +1,12 @@ +# GetPipelineByNumberResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipeline` | [GetPipelineByNumberPipeline](../../models/operations/getpipelinebynumberpipeline.md) | :heavy_minus_sign: | A pipeline object. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getPipelineByNumberDefaultApplicationJSONObject` | [GetPipelineByNumberDefaultApplicationJSON](../../models/operations/getpipelinebynumberdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getpipelineconfigbyiddefaultapplicationjson.md b/docs/models/operations/getpipelineconfigbyiddefaultapplicationjson.md new file mode 100755 index 00000000..1d63735b --- /dev/null +++ b/docs/models/operations/getpipelineconfigbyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetPipelineConfigByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getpipelineconfigbyidpipelineconfig.md b/docs/models/operations/getpipelineconfigbyidpipelineconfig.md new file mode 100755 index 00000000..f261b7e8 --- /dev/null +++ b/docs/models/operations/getpipelineconfigbyidpipelineconfig.md @@ -0,0 +1,13 @@ +# GetPipelineConfigByIdPipelineConfig + +The configuration strings for the pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `compiled` | *string* | :heavy_check_mark: | The compiled configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's configuration, then this field may be empty. | +| `compiledSetupConfig` | *string* | :heavy_minus_sign: | The compiled setup configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's setup workflows, then this field may be empty. | +| `setupConfig` | *string* | :heavy_minus_sign: | The setup configuration for the pipeline used for Setup Workflows. If there were errors processing the pipeline's configuration or if setup workflows are not enabled, then this field should not exist | +| `source` | *string* | :heavy_check_mark: | The source configuration for the pipeline, before any config compilation has been performed. If there is no config, then this field will be empty. | \ No newline at end of file diff --git a/docs/models/operations/getpipelineconfigbyidrequest.md b/docs/models/operations/getpipelineconfigbyidrequest.md new file mode 100755 index 00000000..6cea4e3f --- /dev/null +++ b/docs/models/operations/getpipelineconfigbyidrequest.md @@ -0,0 +1,8 @@ +# GetPipelineConfigByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `pipelineId` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | \ No newline at end of file diff --git a/docs/models/operations/getpipelineconfigbyidresponse.md b/docs/models/operations/getpipelineconfigbyidresponse.md new file mode 100755 index 00000000..3e137db8 --- /dev/null +++ b/docs/models/operations/getpipelineconfigbyidresponse.md @@ -0,0 +1,12 @@ +# GetPipelineConfigByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipelineConfig` | [GetPipelineConfigByIdPipelineConfig](../../models/operations/getpipelineconfigbyidpipelineconfig.md) | :heavy_minus_sign: | The configuration strings for the pipeline. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getPipelineConfigByIdDefaultApplicationJSONObject` | [GetPipelineConfigByIdDefaultApplicationJSON](../../models/operations/getpipelineconfigbyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getpolicybundle400applicationjson.md b/docs/models/operations/getpolicybundle400applicationjson.md new file mode 100755 index 00000000..3f8007a0 --- /dev/null +++ b/docs/models/operations/getpolicybundle400applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyBundle400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getpolicybundle401applicationjson.md b/docs/models/operations/getpolicybundle401applicationjson.md new file mode 100755 index 00000000..6eacfee9 --- /dev/null +++ b/docs/models/operations/getpolicybundle401applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyBundle401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getpolicybundle403applicationjson.md b/docs/models/operations/getpolicybundle403applicationjson.md new file mode 100755 index 00000000..16920535 --- /dev/null +++ b/docs/models/operations/getpolicybundle403applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyBundle403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getpolicybundle500applicationjson.md b/docs/models/operations/getpolicybundle500applicationjson.md new file mode 100755 index 00000000..02518f72 --- /dev/null +++ b/docs/models/operations/getpolicybundle500applicationjson.md @@ -0,0 +1,10 @@ +# GetPolicyBundle500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/getpolicybundlerequest.md b/docs/models/operations/getpolicybundlerequest.md new file mode 100755 index 00000000..354bb852 --- /dev/null +++ b/docs/models/operations/getpolicybundlerequest.md @@ -0,0 +1,9 @@ +# GetPolicyBundleRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `context` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getpolicybundleresponse.md b/docs/models/operations/getpolicybundleresponse.md new file mode 100755 index 00000000..72edbac6 --- /dev/null +++ b/docs/models/operations/getpolicybundleresponse.md @@ -0,0 +1,15 @@ +# GetPolicyBundleResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `getPolicyBundle400ApplicationJSONObject` | [GetPolicyBundle400ApplicationJSON](../../models/operations/getpolicybundle400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getPolicyBundle401ApplicationJSONObject` | [GetPolicyBundle401ApplicationJSON](../../models/operations/getpolicybundle401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `getPolicyBundle403ApplicationJSONObject` | [GetPolicyBundle403ApplicationJSON](../../models/operations/getpolicybundle403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getPolicyBundle500ApplicationJSONObject` | [GetPolicyBundle500ApplicationJSON](../../models/operations/getpolicybundle500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `policyBundle` | Record | :heavy_minus_sign: | Policy-Bundle retrieved successfully. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocument400applicationjson.md b/docs/models/operations/getpolicydocument400applicationjson.md new file mode 100755 index 00000000..c7beef18 --- /dev/null +++ b/docs/models/operations/getpolicydocument400applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyDocument400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocument401applicationjson.md b/docs/models/operations/getpolicydocument401applicationjson.md new file mode 100755 index 00000000..0547e2c6 --- /dev/null +++ b/docs/models/operations/getpolicydocument401applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyDocument401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocument403applicationjson.md b/docs/models/operations/getpolicydocument403applicationjson.md new file mode 100755 index 00000000..b05a2a7b --- /dev/null +++ b/docs/models/operations/getpolicydocument403applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyDocument403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocument404applicationjson.md b/docs/models/operations/getpolicydocument404applicationjson.md new file mode 100755 index 00000000..8298bcde --- /dev/null +++ b/docs/models/operations/getpolicydocument404applicationjson.md @@ -0,0 +1,11 @@ +# GetPolicyDocument404ApplicationJSON + +There was no policy that was found with the given owner_id and policy name. + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | policy not found | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocument500applicationjson.md b/docs/models/operations/getpolicydocument500applicationjson.md new file mode 100755 index 00000000..0a040df8 --- /dev/null +++ b/docs/models/operations/getpolicydocument500applicationjson.md @@ -0,0 +1,10 @@ +# GetPolicyDocument500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocumentrequest.md b/docs/models/operations/getpolicydocumentrequest.md new file mode 100755 index 00000000..2eae3eed --- /dev/null +++ b/docs/models/operations/getpolicydocumentrequest.md @@ -0,0 +1,10 @@ +# GetPolicyDocumentRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| `context` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | +| `policyName` | *string* | :heavy_check_mark: | the policy name set by the rego policy_name rule | \ No newline at end of file diff --git a/docs/models/operations/getpolicydocumentresponse.md b/docs/models/operations/getpolicydocumentresponse.md new file mode 100755 index 00000000..47358057 --- /dev/null +++ b/docs/models/operations/getpolicydocumentresponse.md @@ -0,0 +1,16 @@ +# GetPolicyDocumentResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `getPolicyDocument400ApplicationJSONObject` | [GetPolicyDocument400ApplicationJSON](../../models/operations/getpolicydocument400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getPolicyDocument401ApplicationJSONObject` | [GetPolicyDocument401ApplicationJSON](../../models/operations/getpolicydocument401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `getPolicyDocument403ApplicationJSONObject` | [GetPolicyDocument403ApplicationJSON](../../models/operations/getpolicydocument403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getPolicyDocument404ApplicationJSONObject` | [GetPolicyDocument404ApplicationJSON](../../models/operations/getpolicydocument404applicationjson.md) | :heavy_minus_sign: | There was no policy that was found with the given owner_id and policy name.
| +| `getPolicyDocument500ApplicationJSONObject` | [GetPolicyDocument500ApplicationJSON](../../models/operations/getpolicydocument500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `policy` | [shared.Policy](../../models/shared/policy.md) | :heavy_minus_sign: | Policy retrieved successfully. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getprojectbyslugdefaultapplicationjson.md b/docs/models/operations/getprojectbyslugdefaultapplicationjson.md new file mode 100755 index 00000000..461214d8 --- /dev/null +++ b/docs/models/operations/getprojectbyslugdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetProjectBySlugDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectbyslugproject.md b/docs/models/operations/getprojectbyslugproject.md new file mode 100755 index 00000000..1a90e6e7 --- /dev/null +++ b/docs/models/operations/getprojectbyslugproject.md @@ -0,0 +1,16 @@ +# GetProjectBySlugProject + +NOTE: The definition of Project is subject to change. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | N/A | | +| `name` | *string* | :heavy_check_mark: | The name of the project | api-preview-docs | +| `organizationId` | *string* | :heavy_check_mark: | The id of the organization the project belongs to | CircleCI-Public | +| `organizationName` | *string* | :heavy_check_mark: | The name of the organization the project belongs to | CircleCI-Public | +| `organizationSlug` | *string* | :heavy_check_mark: | The slug of the organization the project belongs to | CircleCI-Public | +| `slug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | gh/CircleCI-Public/api-preview-docs | +| `vcsInfo` | [GetProjectBySlugProjectVcsInfo](../../models/operations/getprojectbyslugprojectvcsinfo.md) | :heavy_check_mark: | Information about the VCS that hosts the project source code. | | \ No newline at end of file diff --git a/docs/models/operations/getprojectbyslugprojectvcsinfo.md b/docs/models/operations/getprojectbyslugprojectvcsinfo.md new file mode 100755 index 00000000..519a7a8c --- /dev/null +++ b/docs/models/operations/getprojectbyslugprojectvcsinfo.md @@ -0,0 +1,12 @@ +# GetProjectBySlugProjectVcsInfo + +Information about the VCS that hosts the project source code. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `defaultBranch` | *string* | :heavy_check_mark: | N/A | master | +| `provider` | [GetProjectBySlugProjectVcsInfoProvider](../../models/operations/getprojectbyslugprojectvcsinfoprovider.md) | :heavy_check_mark: | The VCS provider | | +| `vcsUrl` | *string* | :heavy_check_mark: | URL to the repository hosting the project's code | https://github.com/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/getprojectbyslugprojectvcsinfoprovider.md b/docs/models/operations/getprojectbyslugprojectvcsinfoprovider.md new file mode 100755 index 00000000..90ae1a99 --- /dev/null +++ b/docs/models/operations/getprojectbyslugprojectvcsinfoprovider.md @@ -0,0 +1,12 @@ +# GetProjectBySlugProjectVcsInfoProvider + +The VCS provider + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `Bitbucket` | Bitbucket | +| `CircleCI` | CircleCI | +| `GitHub` | GitHub | \ No newline at end of file diff --git a/docs/models/operations/getprojectbyslugrequest.md b/docs/models/operations/getprojectbyslugrequest.md new file mode 100755 index 00000000..9f5f4451 --- /dev/null +++ b/docs/models/operations/getprojectbyslugrequest.md @@ -0,0 +1,8 @@ +# GetProjectBySlugRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/getprojectbyslugresponse.md b/docs/models/operations/getprojectbyslugresponse.md new file mode 100755 index 00000000..63324c57 --- /dev/null +++ b/docs/models/operations/getprojectbyslugresponse.md @@ -0,0 +1,12 @@ +# GetProjectBySlugResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `project` | [GetProjectBySlugProject](../../models/operations/getprojectbyslugproject.md) | :heavy_minus_sign: | A project object | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getProjectBySlugDefaultApplicationJSONObject` | [GetProjectBySlugDefaultApplicationJSON](../../models/operations/getprojectbyslugdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getprojectclaims400applicationjson.md b/docs/models/operations/getprojectclaims400applicationjson.md new file mode 100755 index 00000000..2d4cfb6a --- /dev/null +++ b/docs/models/operations/getprojectclaims400applicationjson.md @@ -0,0 +1,11 @@ +# GetProjectClaims400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/getprojectclaims403applicationjson.md b/docs/models/operations/getprojectclaims403applicationjson.md new file mode 100755 index 00000000..c98471f7 --- /dev/null +++ b/docs/models/operations/getprojectclaims403applicationjson.md @@ -0,0 +1,11 @@ +# GetProjectClaims403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/getprojectclaims500applicationjson.md b/docs/models/operations/getprojectclaims500applicationjson.md new file mode 100755 index 00000000..1a2421a6 --- /dev/null +++ b/docs/models/operations/getprojectclaims500applicationjson.md @@ -0,0 +1,10 @@ +# GetProjectClaims500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | internal server error | \ No newline at end of file diff --git a/docs/models/operations/getprojectclaimsrequest.md b/docs/models/operations/getprojectclaimsrequest.md new file mode 100755 index 00000000..3d49e58b --- /dev/null +++ b/docs/models/operations/getprojectclaimsrequest.md @@ -0,0 +1,9 @@ +# GetProjectClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `orgID` | *string* | :heavy_check_mark: | N/A | +| `projectID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectclaimsresponse.md b/docs/models/operations/getprojectclaimsresponse.md new file mode 100755 index 00000000..b81c3e6d --- /dev/null +++ b/docs/models/operations/getprojectclaimsresponse.md @@ -0,0 +1,14 @@ +# GetProjectClaimsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `claimResponse` | [shared.ClaimResponse](../../models/shared/claimresponse.md) | :heavy_minus_sign: | Claims successfully fetched. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `getProjectClaims400ApplicationJSONObject` | [GetProjectClaims400ApplicationJSON](../../models/operations/getprojectclaims400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `getProjectClaims403ApplicationJSONObject` | [GetProjectClaims403ApplicationJSON](../../models/operations/getprojectclaims403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `getProjectClaims500ApplicationJSONObject` | [GetProjectClaims500ApplicationJSON](../../models/operations/getprojectclaims500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetrics200applicationjson.md b/docs/models/operations/getprojectworkflowjobmetrics200applicationjson.md new file mode 100755 index 00000000..5f4c4005 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetrics200applicationjson.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowJobMetrics200ApplicationJSON + +Paginated workflow job summary metrics. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [GetProjectWorkflowJobMetrics200ApplicationJSONItems](../../models/operations/getprojectworkflowjobmetrics200applicationjsonitems.md)[] | :heavy_check_mark: | Job summary metrics. | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitems.md b/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitems.md new file mode 100755 index 00000000..cd5e8b16 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitems.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowJobMetrics200ApplicationJSONItems + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetProjectWorkflowJobMetrics200ApplicationJSONItemsMetrics](../../models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetrics.md) | :heavy_check_mark: | Metrics relating to a workflow job's runs. | +| `name` | *string* | :heavy_check_mark: | The name of the job. | +| `windowEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The timestamp of the last build within the requested reporting window. | +| `windowStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The timestamp of the first build within the requested reporting window. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetrics.md b/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetrics.md new file mode 100755 index 00000000..819c6111 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetrics.md @@ -0,0 +1,16 @@ +# GetProjectWorkflowJobMetrics200ApplicationJSONItemsMetrics + +Metrics relating to a workflow job's runs. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `durationMetrics` | [GetProjectWorkflowJobMetrics200ApplicationJSONItemsMetricsDurationMetrics](../../models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetricsdurationmetrics.md) | :heavy_check_mark: | Metrics relating to the duration of runs for a workflow job. | +| `failedRuns` | *number* | :heavy_check_mark: | The number of failed runs. | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `successfulRuns` | *number* | :heavy_check_mark: | The number of successful runs. | +| `throughput` | *number* | :heavy_check_mark: | The average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed by the job in the aggregation window. Note that Insights is not a real time financial reporting tool and should not be used for credit reporting. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetricsdurationmetrics.md b/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetricsdurationmetrics.md new file mode 100755 index 00000000..6e603416 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetricsdurationmetrics.md @@ -0,0 +1,15 @@ +# GetProjectWorkflowJobMetrics200ApplicationJSONItemsMetricsDurationMetrics + +Metrics relating to the duration of runs for a workflow job. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `max` | *number* | :heavy_check_mark: | The max duration, in seconds, among a group of runs. | +| `mean` | *number* | :heavy_check_mark: | The mean duration, in seconds, among a group of runs. | +| `median` | *number* | :heavy_check_mark: | The median duration, in seconds, among a group of runs. | +| `min` | *number* | :heavy_check_mark: | The minimum duration, in seconds, among a group of runs. | +| `p95` | *number* | :heavy_check_mark: | The 95th percentile duration, in seconds, among a group of runs. | +| `standardDeviation` | *number* | :heavy_check_mark: | The standard deviation, in seconds, among a group of runs. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetricsdefaultapplicationjson.md b/docs/models/operations/getprojectworkflowjobmetricsdefaultapplicationjson.md new file mode 100755 index 00000000..060ecc19 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetricsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetProjectWorkflowJobMetricsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetricsreportingwindow.md b/docs/models/operations/getprojectworkflowjobmetricsreportingwindow.md new file mode 100755 index 00000000..21527553 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetricsreportingwindow.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowJobMetricsReportingWindow + +The time window used to calculate summary metrics. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Last7Days` | last-7-days | +| `Last90Days` | last-90-days | +| `Last24Hours` | last-24-hours | +| `Last30Days` | last-30-days | +| `Last60Days` | last-60-days | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetricsrequest.md b/docs/models/operations/getprojectworkflowjobmetricsrequest.md new file mode 100755 index 00000000..b1348e8d --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetricsrequest.md @@ -0,0 +1,13 @@ +# GetProjectWorkflowJobMetricsRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `allBranches` | *boolean* | :heavy_minus_sign: | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. If not passed we will scope the API call to the default branch. | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `reportingWindow` | [GetProjectWorkflowJobMetricsReportingWindow](../../models/operations/getprojectworkflowjobmetricsreportingwindow.md) | :heavy_minus_sign: | The time window used to calculate summary metrics. | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowjobmetricsresponse.md b/docs/models/operations/getprojectworkflowjobmetricsresponse.md new file mode 100755 index 00000000..b65d2cb5 --- /dev/null +++ b/docs/models/operations/getprojectworkflowjobmetricsresponse.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowJobMetricsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getProjectWorkflowJobMetrics200ApplicationJSONObject` | [GetProjectWorkflowJobMetrics200ApplicationJSON](../../models/operations/getprojectworkflowjobmetrics200applicationjson.md) | :heavy_minus_sign: | A paginated list of summary metrics by workflow job. | +| `getProjectWorkflowJobMetricsDefaultApplicationJSONObject` | [GetProjectWorkflowJobMetricsDefaultApplicationJSON](../../models/operations/getprojectworkflowjobmetricsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetrics200applicationjson.md b/docs/models/operations/getprojectworkflowmetrics200applicationjson.md new file mode 100755 index 00000000..7fe72079 --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetrics200applicationjson.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowMetrics200ApplicationJSON + +Paginated workflow summary metrics. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [GetProjectWorkflowMetrics200ApplicationJSONItems](../../models/operations/getprojectworkflowmetrics200applicationjsonitems.md)[] | :heavy_check_mark: | Workflow summary metrics. | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetrics200applicationjsonitems.md b/docs/models/operations/getprojectworkflowmetrics200applicationjsonitems.md new file mode 100755 index 00000000..ca0fd30e --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetrics200applicationjsonitems.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowMetrics200ApplicationJSONItems + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetProjectWorkflowMetrics200ApplicationJSONItemsMetrics](../../models/operations/getprojectworkflowmetrics200applicationjsonitemsmetrics.md) | :heavy_check_mark: | Metrics relating to a workflow's runs. | | +| `name` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | +| `projectId` | *any* | :heavy_check_mark: | The unique ID of the project | | +| `windowEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The timestamp of the last build within the requested reporting window. | | +| `windowStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The timestamp of the first build within the requested reporting window. | | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetrics.md b/docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetrics.md new file mode 100755 index 00000000..ee64c574 --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetrics.md @@ -0,0 +1,18 @@ +# GetProjectWorkflowMetrics200ApplicationJSONItemsMetrics + +Metrics relating to a workflow's runs. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `durationMetrics` | [GetProjectWorkflowMetrics200ApplicationJSONItemsMetricsDurationMetrics](../../models/operations/getprojectworkflowmetrics200applicationjsonitemsmetricsdurationmetrics.md) | :heavy_check_mark: | Metrics relating to the duration of runs for a workflow. | +| `failedRuns` | *number* | :heavy_check_mark: | The number of failed runs. | +| `mttr` | *number* | :heavy_check_mark: | The mean time to recovery (mean time between failures and their next success) in seconds. | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `successfulRuns` | *number* | :heavy_check_mark: | The number of successful runs. | +| `throughput` | *number* | :heavy_check_mark: | The average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed by the workflow in the aggregation window. Note that Insights is not a real time financial reporting tool and should not be used for credit reporting. | +| `totalRecoveries` | *number* | :heavy_check_mark: | The number of recovered workflow executions per day. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetricsdurationmetrics.md b/docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetricsdurationmetrics.md new file mode 100755 index 00000000..ed577b10 --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetricsdurationmetrics.md @@ -0,0 +1,15 @@ +# GetProjectWorkflowMetrics200ApplicationJSONItemsMetricsDurationMetrics + +Metrics relating to the duration of runs for a workflow. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `max` | *number* | :heavy_check_mark: | The max duration, in seconds, among a group of runs. | +| `mean` | *number* | :heavy_check_mark: | The mean duration, in seconds, among a group of runs. | +| `median` | *number* | :heavy_check_mark: | The median duration, in seconds, among a group of runs. | +| `min` | *number* | :heavy_check_mark: | The minimum duration, in seconds, among a group of runs. | +| `p95` | *number* | :heavy_check_mark: | The 95th percentile duration, in seconds, among a group of runs. | +| `standardDeviation` | *number* | :heavy_check_mark: | The standard deviation, in seconds, among a group of runs. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetricsdefaultapplicationjson.md b/docs/models/operations/getprojectworkflowmetricsdefaultapplicationjson.md new file mode 100755 index 00000000..8a538b35 --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetricsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetProjectWorkflowMetricsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetricsreportingwindow.md b/docs/models/operations/getprojectworkflowmetricsreportingwindow.md new file mode 100755 index 00000000..640642d7 --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetricsreportingwindow.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowMetricsReportingWindow + +The time window used to calculate summary metrics. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Last7Days` | last-7-days | +| `Last90Days` | last-90-days | +| `Last24Hours` | last-24-hours | +| `Last30Days` | last-30-days | +| `Last60Days` | last-60-days | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetricsrequest.md b/docs/models/operations/getprojectworkflowmetricsrequest.md new file mode 100755 index 00000000..e723ebfc --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetricsrequest.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowMetricsRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `allBranches` | *boolean* | :heavy_minus_sign: | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. If not passed we will scope the API call to the default branch. | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `reportingWindow` | [GetProjectWorkflowMetricsReportingWindow](../../models/operations/getprojectworkflowmetricsreportingwindow.md) | :heavy_minus_sign: | The time window used to calculate summary metrics. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowmetricsresponse.md b/docs/models/operations/getprojectworkflowmetricsresponse.md new file mode 100755 index 00000000..1b5f0af3 --- /dev/null +++ b/docs/models/operations/getprojectworkflowmetricsresponse.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowMetricsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getProjectWorkflowMetrics200ApplicationJSONObject` | [GetProjectWorkflowMetrics200ApplicationJSON](../../models/operations/getprojectworkflowmetrics200applicationjson.md) | :heavy_minus_sign: | A paginated list of summary metrics by workflow | +| `getProjectWorkflowMetricsDefaultApplicationJSONObject` | [GetProjectWorkflowMetricsDefaultApplicationJSON](../../models/operations/getprojectworkflowmetricsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowruns200applicationjson.md b/docs/models/operations/getprojectworkflowruns200applicationjson.md new file mode 100755 index 00000000..f73adbf5 --- /dev/null +++ b/docs/models/operations/getprojectworkflowruns200applicationjson.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowRuns200ApplicationJSON + +Paginated recent workflow runs. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `items` | [GetProjectWorkflowRuns200ApplicationJSONItems](../../models/operations/getprojectworkflowruns200applicationjsonitems.md)[] | :heavy_check_mark: | Recent workflow runs. | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowruns200applicationjsonitems.md b/docs/models/operations/getprojectworkflowruns200applicationjsonitems.md new file mode 100755 index 00000000..98e4c794 --- /dev/null +++ b/docs/models/operations/getprojectworkflowruns200applicationjsonitems.md @@ -0,0 +1,15 @@ +# GetProjectWorkflowRuns200ApplicationJSONItems + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_check_mark: | The VCS branch of a Workflow's trigger. | main | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the workflow was created. | | +| `creditsUsed` | *number* | :heavy_check_mark: | The number of credits used during execution. Note that Insights is not a real time financial reporting tool and should not be used for credit reporting. | | +| `duration` | *number* | :heavy_check_mark: | The duration in seconds of a run. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | | +| `isApproval` | *boolean* | :heavy_check_mark: | Describes if the job is an approval job or not. Approval jobs are intermediary jobs that are created to pause the workflow until approved. | false | +| `status` | [GetProjectWorkflowRuns200ApplicationJSONItemsStatus](../../models/operations/getprojectworkflowruns200applicationjsonitemsstatus.md) | :heavy_check_mark: | Workflow status. | | +| `stoppedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the workflow stopped. | | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowruns200applicationjsonitemsstatus.md b/docs/models/operations/getprojectworkflowruns200applicationjsonitemsstatus.md new file mode 100755 index 00000000..03f3db6e --- /dev/null +++ b/docs/models/operations/getprojectworkflowruns200applicationjsonitemsstatus.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowRuns200ApplicationJSONItemsStatus + +Workflow status. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Success` | success | +| `Failed` | failed | +| `Error` | error | +| `Canceled` | canceled | +| `Unauthorized` | unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowrunsdefaultapplicationjson.md b/docs/models/operations/getprojectworkflowrunsdefaultapplicationjson.md new file mode 100755 index 00000000..82bc17bc --- /dev/null +++ b/docs/models/operations/getprojectworkflowrunsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetProjectWorkflowRunsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowrunsrequest.md b/docs/models/operations/getprojectworkflowrunsrequest.md new file mode 100755 index 00000000..a3589d28 --- /dev/null +++ b/docs/models/operations/getprojectworkflowrunsrequest.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowRunsRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `allBranches` | *boolean* | :heavy_minus_sign: | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. If not passed we will scope the API call to the default branch. | +| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Include only executions that started before this date. This date can be at most 90 days after the start-date. | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Include only executions that started at or after this date. This must be specified if an end-date is provided. | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowrunsresponse.md b/docs/models/operations/getprojectworkflowrunsresponse.md new file mode 100755 index 00000000..cbec9b75 --- /dev/null +++ b/docs/models/operations/getprojectworkflowrunsresponse.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowRunsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getProjectWorkflowRuns200ApplicationJSONObject` | [GetProjectWorkflowRuns200ApplicationJSON](../../models/operations/getprojectworkflowruns200applicationjson.md) | :heavy_minus_sign: | A paginated list of recent workflow runs | +| `getProjectWorkflowRunsDefaultApplicationJSONObject` | [GetProjectWorkflowRunsDefaultApplicationJSON](../../models/operations/getprojectworkflowrunsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjson.md b/docs/models/operations/getprojectworkflowspagedata200applicationjson.md new file mode 100755 index 00000000..77184c4a --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjson.md @@ -0,0 +1,16 @@ +# GetProjectWorkflowsPageData200ApplicationJSON + +Aggregated summary metrics and trends by workflow and branches + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `allBranches` | *string*[] | :heavy_minus_sign: | A list of all the branches for a given project. | +| `allWorkflows` | *string*[] | :heavy_minus_sign: | A list of all the workflows for a given project. | +| `orgId` | *any* | :heavy_minus_sign: | The unique ID of the organization | +| `projectData` | [GetProjectWorkflowsPageData200ApplicationJSONProjectData](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectdata.md) | :heavy_minus_sign: | Metrics and trends data aggregated for a given project. | +| `projectId` | *any* | :heavy_minus_sign: | The unique ID of the project | +| `projectWorkflowBranchData` | [GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchData](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdata.md)[] | :heavy_minus_sign: | A list of metrics and trends data for branches for a given project. | +| `projectWorkflowData` | [GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowData](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdata.md)[] | :heavy_minus_sign: | A list of metrics and trends data for workflows for a given project. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdata.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdata.md new file mode 100755 index 00000000..9b55e0d3 --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdata.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectData + +Metrics and trends data aggregated for a given project. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetProjectWorkflowsPageData200ApplicationJSONProjectDataMetrics](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectdatametrics.md) | :heavy_check_mark: | Metrics aggregated across all workflows and branches for a project. | +| `trends` | [GetProjectWorkflowsPageData200ApplicationJSONProjectDataTrends](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectdatatrends.md) | :heavy_check_mark: | Metric trends aggregated across all workflows and branches for a project. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatametrics.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatametrics.md new file mode 100755 index 00000000..8f7bb60b --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatametrics.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectDataMetrics + +Metrics aggregated across all workflows and branches for a project. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `throughput` | *number* | :heavy_check_mark: | The average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed over the current timeseries interval. | +| `totalDurationSecs` | *number* | :heavy_check_mark: | Total duration, in seconds. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatatrends.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatatrends.md new file mode 100755 index 00000000..12a34dd7 --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatatrends.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectDataTrends + +Metric trends aggregated across all workflows and branches for a project. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | +| `successRate` | *number* | :heavy_check_mark: | The trend value for the success rate. | +| `throughput` | *number* | :heavy_check_mark: | Trend value for the average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The trend value for total credits consumed. | +| `totalDurationSecs` | *number* | :heavy_check_mark: | Trend value for total duration. | +| `totalRuns` | *number* | :heavy_check_mark: | The trend value for total number of runs. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdata.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdata.md new file mode 100755 index 00000000..1d6c83a9 --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdata.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_check_mark: | The VCS branch of a workflow's trigger. | main | +| `metrics` | [GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchDataMetrics](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatametrics.md) | :heavy_check_mark: | Metrics aggregated across a workflow or branchfor a project. | | +| `trends` | [GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchDataTrends](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatatrends.md) | :heavy_check_mark: | Trends aggregated across a workflow or branch for a project. | | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatametrics.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatametrics.md new file mode 100755 index 00000000..4beb133b --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatametrics.md @@ -0,0 +1,13 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchDataMetrics + +Metrics aggregated across a workflow or branchfor a project. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `p95DurationSecs` | *number* | :heavy_check_mark: | The 95th percentile duration among a group of workflow runs. | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed over the current timeseries interval. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatatrends.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatatrends.md new file mode 100755 index 00000000..a84ea492 --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatatrends.md @@ -0,0 +1,13 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchDataTrends + +Trends aggregated across a workflow or branch for a project. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `p95DurationSecs` | *number* | :heavy_check_mark: | The 95th percentile duration among a group of workflow runs. | +| `successRate` | *number* | :heavy_check_mark: | The trend value for the success rate. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The trend value for total credits consumed. | +| `totalRuns` | *number* | :heavy_check_mark: | The trend value for total number of runs. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdata.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdata.md new file mode 100755 index 00000000..472edaab --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdata.md @@ -0,0 +1,10 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowDataMetrics](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatametrics.md) | :heavy_check_mark: | Metrics aggregated across a workflow or branchfor a project. | | +| `trends` | [GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowDataTrends](../../models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatatrends.md) | :heavy_check_mark: | Trends aggregated across a workflow or branch for a project. | | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatametrics.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatametrics.md new file mode 100755 index 00000000..3a11cccf --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatametrics.md @@ -0,0 +1,13 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowDataMetrics + +Metrics aggregated across a workflow or branchfor a project. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `p95DurationSecs` | *number* | :heavy_check_mark: | The 95th percentile duration among a group of workflow runs. | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed over the current timeseries interval. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatatrends.md b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatatrends.md new file mode 100755 index 00000000..c5115ccc --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatatrends.md @@ -0,0 +1,13 @@ +# GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowDataTrends + +Trends aggregated across a workflow or branch for a project. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `p95DurationSecs` | *number* | :heavy_check_mark: | The 95th percentile duration among a group of workflow runs. | +| `successRate` | *number* | :heavy_check_mark: | The trend value for the success rate. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The trend value for total credits consumed. | +| `totalRuns` | *number* | :heavy_check_mark: | The trend value for total number of runs. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedatabranches.md b/docs/models/operations/getprojectworkflowspagedatabranches.md new file mode 100755 index 00000000..63cf527e --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedatabranches.md @@ -0,0 +1,9 @@ +# GetProjectWorkflowsPageDataBranches + +The names of VCS branches to include in branch-level workflow metrics. + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedatadefaultapplicationjson.md b/docs/models/operations/getprojectworkflowspagedatadefaultapplicationjson.md new file mode 100755 index 00000000..0482b5dd --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedatadefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetProjectWorkflowsPageDataDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedatareportingwindow.md b/docs/models/operations/getprojectworkflowspagedatareportingwindow.md new file mode 100755 index 00000000..c7f93711 --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedatareportingwindow.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowsPageDataReportingWindow + +The time window used to calculate summary metrics. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Last7Days` | last-7-days | +| `Last90Days` | last-90-days | +| `Last24Hours` | last-24-hours | +| `Last30Days` | last-30-days | +| `Last60Days` | last-60-days | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedatarequest.md b/docs/models/operations/getprojectworkflowspagedatarequest.md new file mode 100755 index 00000000..e1f2a69f --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedatarequest.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowsPageDataRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `branches` | [GetProjectWorkflowsPageDataBranches](../../models/operations/getprojectworkflowspagedatabranches.md) | :heavy_minus_sign: | The names of VCS branches to include in branch-level workflow metrics. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `reportingWindow` | [GetProjectWorkflowsPageDataReportingWindow](../../models/operations/getprojectworkflowspagedatareportingwindow.md) | :heavy_minus_sign: | The time window used to calculate summary metrics. | +| `workflowNames` | [GetProjectWorkflowsPageDataWorkflowNames](../../models/operations/getprojectworkflowspagedataworkflownames.md) | :heavy_minus_sign: | The names of workflows to include in workflow-level metrics. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedataresponse.md b/docs/models/operations/getprojectworkflowspagedataresponse.md new file mode 100755 index 00000000..8407d7be --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedataresponse.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowsPageDataResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getProjectWorkflowsPageData200ApplicationJSONObject` | [GetProjectWorkflowsPageData200ApplicationJSON](../../models/operations/getprojectworkflowspagedata200applicationjson.md) | :heavy_minus_sign: | Aggregated summary metrics and trends by workflow and branches | +| `getProjectWorkflowsPageDataDefaultApplicationJSONObject` | [GetProjectWorkflowsPageDataDefaultApplicationJSON](../../models/operations/getprojectworkflowspagedatadefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowspagedataworkflownames.md b/docs/models/operations/getprojectworkflowspagedataworkflownames.md new file mode 100755 index 00000000..d4f3fd3e --- /dev/null +++ b/docs/models/operations/getprojectworkflowspagedataworkflownames.md @@ -0,0 +1,9 @@ +# GetProjectWorkflowsPageDataWorkflowNames + +The names of workflows to include in workflow-level metrics. + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetrics200applicationjson.md b/docs/models/operations/getprojectworkflowtestmetrics200applicationjson.md new file mode 100755 index 00000000..172b2517 --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetrics200applicationjson.md @@ -0,0 +1,16 @@ +# GetProjectWorkflowTestMetrics200ApplicationJSON + +Project level test metrics response + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `averageTestCount` | *number* | :heavy_check_mark: | The average number of tests executed per run | +| `mostFailedTests` | [GetProjectWorkflowTestMetrics200ApplicationJSONMostFailedTests](../../models/operations/getprojectworkflowtestmetrics200applicationjsonmostfailedtests.md)[] | :heavy_check_mark: | Metrics for the most frequently failing tests | +| `mostFailedTestsExtra` | *number* | :heavy_check_mark: | The number of tests with the same success rate being omitted from most_failed_tests | +| `slowestTests` | [GetProjectWorkflowTestMetrics200ApplicationJSONSlowestTests](../../models/operations/getprojectworkflowtestmetrics200applicationjsonslowesttests.md)[] | :heavy_check_mark: | Metrics for the slowest running tests | +| `slowestTestsExtra` | *number* | :heavy_check_mark: | The number of tests with the same duration rate being omitted from slowest_tests | +| `testRuns` | [GetProjectWorkflowTestMetrics200ApplicationJSONTestRuns](../../models/operations/getprojectworkflowtestmetrics200applicationjsontestruns.md)[] | :heavy_check_mark: | Test counts grouped by pipeline number and workflow id | +| `totalTestRuns` | *number* | :heavy_check_mark: | The total number of test runs | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetrics200applicationjsonmostfailedtests.md b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsonmostfailedtests.md new file mode 100755 index 00000000..cfe3cd8e --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsonmostfailedtests.md @@ -0,0 +1,16 @@ +# GetProjectWorkflowTestMetrics200ApplicationJSONMostFailedTests + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `classname` | *string* | :heavy_check_mark: | The class the test belongs to. | +| `failedRuns` | *number* | :heavy_check_mark: | The number of times the test failed | +| `file` | *string* | :heavy_check_mark: | The file the test belongs to. | +| `flaky` | *boolean* | :heavy_check_mark: | Whether the test is flaky. | +| `jobName` | *string* | :heavy_check_mark: | The name of the job. | +| `p95Duration` | *number* | :heavy_check_mark: | The 95th percentile duration, in seconds, among a group of test runs. | +| `source` | *string* | :heavy_check_mark: | The source of the test. | +| `testName` | *string* | :heavy_check_mark: | The name of the test. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of times the test was run. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetrics200applicationjsonslowesttests.md b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsonslowesttests.md new file mode 100755 index 00000000..a597f26b --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsonslowesttests.md @@ -0,0 +1,16 @@ +# GetProjectWorkflowTestMetrics200ApplicationJSONSlowestTests + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `classname` | *string* | :heavy_check_mark: | The class the test belongs to. | +| `failedRuns` | *number* | :heavy_check_mark: | The number of times the test failed | +| `file` | *string* | :heavy_check_mark: | The file the test belongs to. | +| `flaky` | *boolean* | :heavy_check_mark: | Whether the test is flaky. | +| `jobName` | *string* | :heavy_check_mark: | The name of the job. | +| `p95Duration` | *number* | :heavy_check_mark: | The 95th percentile duration, in seconds, among a group of test runs. | +| `source` | *string* | :heavy_check_mark: | The source of the test. | +| `testName` | *string* | :heavy_check_mark: | The name of the test. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of times the test was run. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestruns.md b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestruns.md new file mode 100755 index 00000000..4ea7a2e3 --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestruns.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowTestMetrics200ApplicationJSONTestRuns + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `pipelineNumber` | *number* | :heavy_check_mark: | The number of the pipeline associated with the provided test counts | +| `successRate` | *number* | :heavy_check_mark: | The success rate calculated from test counts | +| `testCounts` | [GetProjectWorkflowTestMetrics200ApplicationJSONTestRunsTestCounts](../../models/operations/getprojectworkflowtestmetrics200applicationjsontestrunstestcounts.md) | :heavy_check_mark: | Test counts for a given pipeline number | +| `workflowId` | *any* | :heavy_check_mark: | The ID of the workflow associated with the provided test counts | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestrunstestcounts.md b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestrunstestcounts.md new file mode 100755 index 00000000..389a19f2 --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestrunstestcounts.md @@ -0,0 +1,14 @@ +# GetProjectWorkflowTestMetrics200ApplicationJSONTestRunsTestCounts + +Test counts for a given pipeline number + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `error` | *number* | :heavy_check_mark: | The number of tests with the error status | +| `failure` | *number* | :heavy_check_mark: | The number of tests with the failure status | +| `skipped` | *number* | :heavy_check_mark: | The number of tests with the skipped status | +| `success` | *number* | :heavy_check_mark: | The number of tests with the success status | +| `total` | *number* | :heavy_check_mark: | The total number of tests | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetricsdefaultapplicationjson.md b/docs/models/operations/getprojectworkflowtestmetricsdefaultapplicationjson.md new file mode 100755 index 00000000..9662fbf6 --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetricsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetProjectWorkflowTestMetricsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetricsrequest.md b/docs/models/operations/getprojectworkflowtestmetricsrequest.md new file mode 100755 index 00000000..6a22fa03 --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetricsrequest.md @@ -0,0 +1,11 @@ +# GetProjectWorkflowTestMetricsRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `allBranches` | *boolean* | :heavy_minus_sign: | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. If not passed we will scope the API call to the default branch. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getprojectworkflowtestmetricsresponse.md b/docs/models/operations/getprojectworkflowtestmetricsresponse.md new file mode 100755 index 00000000..9bdfc0f5 --- /dev/null +++ b/docs/models/operations/getprojectworkflowtestmetricsresponse.md @@ -0,0 +1,12 @@ +# GetProjectWorkflowTestMetricsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getProjectWorkflowTestMetrics200ApplicationJSONObject` | [GetProjectWorkflowTestMetrics200ApplicationJSON](../../models/operations/getprojectworkflowtestmetrics200applicationjson.md) | :heavy_minus_sign: | A list of test metrics by workflow | +| `getProjectWorkflowTestMetricsDefaultApplicationJSONObject` | [GetProjectWorkflowTestMetricsDefaultApplicationJSON](../../models/operations/getprojectworkflowtestmetricsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyiddefaultapplicationjson.md b/docs/models/operations/getschedulebyiddefaultapplicationjson.md new file mode 100755 index 00000000..50296391 --- /dev/null +++ b/docs/models/operations/getschedulebyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetScheduleByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidrequest.md b/docs/models/operations/getschedulebyidrequest.md new file mode 100755 index 00000000..400e5187 --- /dev/null +++ b/docs/models/operations/getschedulebyidrequest.md @@ -0,0 +1,8 @@ +# GetScheduleByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `scheduleId` | *string* | :heavy_check_mark: | The unique ID of the schedule. | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidresponse.md b/docs/models/operations/getschedulebyidresponse.md new file mode 100755 index 00000000..0624f638 --- /dev/null +++ b/docs/models/operations/getschedulebyidresponse.md @@ -0,0 +1,12 @@ +# GetScheduleByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `schedule` | [GetScheduleByIdSchedule](../../models/operations/getschedulebyidschedule.md) | :heavy_minus_sign: | A schedule object. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getScheduleByIdDefaultApplicationJSONObject` | [GetScheduleByIdDefaultApplicationJSON](../../models/operations/getschedulebyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidschedule.md b/docs/models/operations/getschedulebyidschedule.md new file mode 100755 index 00000000..ef059d59 --- /dev/null +++ b/docs/models/operations/getschedulebyidschedule.md @@ -0,0 +1,18 @@ +# GetScheduleByIdSchedule + +A schedule response + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `actor` | [GetScheduleByIdScheduleUser](../../models/operations/getschedulebyidscheduleuser.md) | :heavy_check_mark: | The attribution actor who will run the scheduled pipeline. | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `description` | *string* | :heavy_check_mark: | Description of the schedule. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the schedule. | | +| `name` | *string* | :heavy_check_mark: | Name of the schedule. | | +| `parameters` | Record | :heavy_check_mark: | Pipeline parameters represented as key-value pairs. Must contain branch or tag. | | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the schedule | gh/CircleCI-Public/api-preview-docs | +| `timetable` | *any* | :heavy_check_mark: | Timetable that specifies when a schedule triggers. | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was last updated. | | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduletimetable1.md b/docs/models/operations/getschedulebyidscheduletimetable1.md new file mode 100755 index 00000000..ae5e2fa0 --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduletimetable1.md @@ -0,0 +1,14 @@ +# GetScheduleByIdScheduleTimetable1 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_minus_sign: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [GetScheduleByIdScheduleTimetable1DaysOfWeek](../../models/operations/getschedulebyidscheduletimetable1daysofweek.md)[] | :heavy_check_mark: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [GetScheduleByIdScheduleTimetable1Months](../../models/operations/getschedulebyidscheduletimetable1months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduletimetable1daysofweek.md b/docs/models/operations/getschedulebyidscheduletimetable1daysofweek.md new file mode 100755 index 00000000..46ae305a --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduletimetable1daysofweek.md @@ -0,0 +1,16 @@ +# GetScheduleByIdScheduleTimetable1DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduletimetable1months.md b/docs/models/operations/getschedulebyidscheduletimetable1months.md new file mode 100755 index 00000000..d62694d5 --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduletimetable1months.md @@ -0,0 +1,21 @@ +# GetScheduleByIdScheduleTimetable1Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduletimetable2.md b/docs/models/operations/getschedulebyidscheduletimetable2.md new file mode 100755 index 00000000..0c871754 --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduletimetable2.md @@ -0,0 +1,14 @@ +# GetScheduleByIdScheduleTimetable2 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_check_mark: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [GetScheduleByIdScheduleTimetable2DaysOfWeek](../../models/operations/getschedulebyidscheduletimetable2daysofweek.md)[] | :heavy_minus_sign: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [GetScheduleByIdScheduleTimetable2Months](../../models/operations/getschedulebyidscheduletimetable2months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduletimetable2daysofweek.md b/docs/models/operations/getschedulebyidscheduletimetable2daysofweek.md new file mode 100755 index 00000000..23c83be3 --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduletimetable2daysofweek.md @@ -0,0 +1,16 @@ +# GetScheduleByIdScheduleTimetable2DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduletimetable2months.md b/docs/models/operations/getschedulebyidscheduletimetable2months.md new file mode 100755 index 00000000..c0ce55ba --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduletimetable2months.md @@ -0,0 +1,21 @@ +# GetScheduleByIdScheduleTimetable2Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/getschedulebyidscheduleuser.md b/docs/models/operations/getschedulebyidscheduleuser.md new file mode 100755 index 00000000..1825871d --- /dev/null +++ b/docs/models/operations/getschedulebyidscheduleuser.md @@ -0,0 +1,12 @@ +# GetScheduleByIdScheduleUser + +The attribution actor who will run the scheduled pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | +| `name` | *string* | :heavy_check_mark: | The name of the user. | \ No newline at end of file diff --git a/docs/models/operations/gettestsdefaultapplicationjson.md b/docs/models/operations/gettestsdefaultapplicationjson.md new file mode 100755 index 00000000..9fe244ab --- /dev/null +++ b/docs/models/operations/gettestsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetTestsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettestsrequest.md b/docs/models/operations/gettestsrequest.md new file mode 100755 index 00000000..56e2d755 --- /dev/null +++ b/docs/models/operations/gettestsrequest.md @@ -0,0 +1,9 @@ +# GetTestsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `jobNumber` | *any* | :heavy_check_mark: | The number of the job. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/gettestsresponse.md b/docs/models/operations/gettestsresponse.md new file mode 100755 index 00000000..eea9a879 --- /dev/null +++ b/docs/models/operations/gettestsresponse.md @@ -0,0 +1,12 @@ +# GetTestsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `testsResponse` | [GetTestsTestsResponse](../../models/operations/getteststestsresponse.md) | :heavy_minus_sign: | A paginated list of test results. | +| `getTestsDefaultApplicationJSONObject` | [GetTestsDefaultApplicationJSON](../../models/operations/gettestsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getteststestsresponse.md b/docs/models/operations/getteststestsresponse.md new file mode 100755 index 00000000..89a32729 --- /dev/null +++ b/docs/models/operations/getteststestsresponse.md @@ -0,0 +1,11 @@ +# GetTestsTestsResponse + +A paginated list of test results. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `items` | [GetTestsTestsResponseItems](../../models/operations/getteststestsresponseitems.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getteststestsresponseitems.md b/docs/models/operations/getteststestsresponseitems.md new file mode 100755 index 00000000..15d63544 --- /dev/null +++ b/docs/models/operations/getteststestsresponseitems.md @@ -0,0 +1,14 @@ +# GetTestsTestsResponseItems + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `classname` | *string* | :heavy_check_mark: | The programmatic location of the test. | | +| `file` | *string* | :heavy_check_mark: | The file in which the test is defined. | | +| `message` | *string* | :heavy_check_mark: | The failure message associated with the test. | | +| `name` | *string* | :heavy_check_mark: | The name of the test. | | +| `result` | *string* | :heavy_check_mark: | Indication of whether the test succeeded. | | +| `runTime` | *number* | :heavy_check_mark: | The time it took to run the test in seconds | | +| `source` | *string* | :heavy_check_mark: | The program that generated the test results | | \ No newline at end of file diff --git a/docs/models/operations/getuserdefaultapplicationjson.md b/docs/models/operations/getuserdefaultapplicationjson.md new file mode 100755 index 00000000..d47bc12f --- /dev/null +++ b/docs/models/operations/getuserdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetUserDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getuserrequest.md b/docs/models/operations/getuserrequest.md new file mode 100755 index 00000000..b0edc479 --- /dev/null +++ b/docs/models/operations/getuserrequest.md @@ -0,0 +1,8 @@ +# GetUserRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------- | -------------------------- | -------------------------- | -------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | \ No newline at end of file diff --git a/docs/models/operations/getuserresponse.md b/docs/models/operations/getuserresponse.md new file mode 100755 index 00000000..7e5f4fd7 --- /dev/null +++ b/docs/models/operations/getuserresponse.md @@ -0,0 +1,12 @@ +# GetUserResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `user` | [GetUserUser](../../models/operations/getuseruser.md) | :heavy_minus_sign: | User login information. | +| `getUserDefaultApplicationJSONObject` | [GetUserDefaultApplicationJSON](../../models/operations/getuserdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getuseruser.md b/docs/models/operations/getuseruser.md new file mode 100755 index 00000000..f92fea16 --- /dev/null +++ b/docs/models/operations/getuseruser.md @@ -0,0 +1,12 @@ +# GetUserUser + +User login information. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | +| `name` | *string* | :heavy_check_mark: | The name of the user. | \ No newline at end of file diff --git a/docs/models/operations/getwebhookbyiddefaultapplicationjson.md b/docs/models/operations/getwebhookbyiddefaultapplicationjson.md new file mode 100755 index 00000000..c89f7045 --- /dev/null +++ b/docs/models/operations/getwebhookbyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetWebhookByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getwebhookbyidrequest.md b/docs/models/operations/getwebhookbyidrequest.md new file mode 100755 index 00000000..cbd68451 --- /dev/null +++ b/docs/models/operations/getwebhookbyidrequest.md @@ -0,0 +1,8 @@ +# GetWebhookByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `webhookId` | *string* | :heavy_check_mark: | ID of the webhook (UUID) | \ No newline at end of file diff --git a/docs/models/operations/getwebhookbyidresponse.md b/docs/models/operations/getwebhookbyidresponse.md new file mode 100755 index 00000000..f796279e --- /dev/null +++ b/docs/models/operations/getwebhookbyidresponse.md @@ -0,0 +1,12 @@ +# GetWebhookByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `webhook` | [GetWebhookByIdWebhook](../../models/operations/getwebhookbyidwebhook.md) | :heavy_minus_sign: | A webhook | +| `getWebhookByIdDefaultApplicationJSONObject` | [GetWebhookByIdDefaultApplicationJSON](../../models/operations/getwebhookbyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getwebhookbyidwebhook.md b/docs/models/operations/getwebhookbyidwebhook.md new file mode 100755 index 00000000..1096a858 --- /dev/null +++ b/docs/models/operations/getwebhookbyidwebhook.md @@ -0,0 +1,18 @@ +# GetWebhookByIdWebhook + +A webhook + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was created. | 2015-09-21T17:29:21.042Z | +| `events` | [GetWebhookByIdWebhookEvents](../../models/operations/getwebhookbyidwebhookevents.md)[] | :heavy_check_mark: | Events that will trigger the webhook | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the webhook | | +| `name` | *string* | :heavy_check_mark: | Name of the webhook | | +| `scope` | [GetWebhookByIdWebhookScope](../../models/operations/getwebhookbyidwebhookscope.md) | :heavy_check_mark: | The scope in which the relevant events that will trigger webhooks | | +| `signingSecret` | *string* | :heavy_check_mark: | Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was last updated. | 2015-09-21T17:29:21.042Z | +| `url` | *string* | :heavy_check_mark: | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) | | +| `verifyTls` | *boolean* | :heavy_check_mark: | Whether to enforce TLS certificate verification when delivering the webhook | | \ No newline at end of file diff --git a/docs/models/operations/getwebhookbyidwebhookevents.md b/docs/models/operations/getwebhookbyidwebhookevents.md new file mode 100755 index 00000000..265312df --- /dev/null +++ b/docs/models/operations/getwebhookbyidwebhookevents.md @@ -0,0 +1,9 @@ +# GetWebhookByIdWebhookEvents + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `WorkflowCompleted` | workflow-completed | +| `JobCompleted` | job-completed | \ No newline at end of file diff --git a/docs/models/operations/getwebhookbyidwebhookscope.md b/docs/models/operations/getwebhookbyidwebhookscope.md new file mode 100755 index 00000000..b21e011a --- /dev/null +++ b/docs/models/operations/getwebhookbyidwebhookscope.md @@ -0,0 +1,11 @@ +# GetWebhookByIdWebhookScope + +The scope in which the relevant events that will trigger webhooks + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | ID of the scope being used (at the moment, only project ID is supported) | +| `type` | *string* | :heavy_check_mark: | Type of the scope being used | \ No newline at end of file diff --git a/docs/models/operations/getwebhooks200applicationjson.md b/docs/models/operations/getwebhooks200applicationjson.md new file mode 100755 index 00000000..b704d08c --- /dev/null +++ b/docs/models/operations/getwebhooks200applicationjson.md @@ -0,0 +1,11 @@ +# GetWebhooks200ApplicationJSON + +A list of webhooks + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `items` | [GetWebhooks200ApplicationJSONWebhook](../../models/operations/getwebhooks200applicationjsonwebhook.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/getwebhooks200applicationjsonwebhook.md b/docs/models/operations/getwebhooks200applicationjsonwebhook.md new file mode 100755 index 00000000..5b4db824 --- /dev/null +++ b/docs/models/operations/getwebhooks200applicationjsonwebhook.md @@ -0,0 +1,16 @@ +# GetWebhooks200ApplicationJSONWebhook + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was created. | 2015-09-21T17:29:21.042Z | +| `events` | [GetWebhooks200ApplicationJSONWebhookEvents](../../models/operations/getwebhooks200applicationjsonwebhookevents.md)[] | :heavy_check_mark: | Events that will trigger the webhook | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the webhook | | +| `name` | *string* | :heavy_check_mark: | Name of the webhook | | +| `scope` | [GetWebhooks200ApplicationJSONWebhookScope](../../models/operations/getwebhooks200applicationjsonwebhookscope.md) | :heavy_check_mark: | The scope in which the relevant events that will trigger webhooks | | +| `signingSecret` | *string* | :heavy_check_mark: | Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was last updated. | 2015-09-21T17:29:21.042Z | +| `url` | *string* | :heavy_check_mark: | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) | | +| `verifyTls` | *boolean* | :heavy_check_mark: | Whether to enforce TLS certificate verification when delivering the webhook | | \ No newline at end of file diff --git a/docs/models/operations/getwebhooks200applicationjsonwebhookevents.md b/docs/models/operations/getwebhooks200applicationjsonwebhookevents.md new file mode 100755 index 00000000..6eeefd77 --- /dev/null +++ b/docs/models/operations/getwebhooks200applicationjsonwebhookevents.md @@ -0,0 +1,9 @@ +# GetWebhooks200ApplicationJSONWebhookEvents + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `WorkflowCompleted` | workflow-completed | +| `JobCompleted` | job-completed | \ No newline at end of file diff --git a/docs/models/operations/getwebhooks200applicationjsonwebhookscope.md b/docs/models/operations/getwebhooks200applicationjsonwebhookscope.md new file mode 100755 index 00000000..ed1b14ae --- /dev/null +++ b/docs/models/operations/getwebhooks200applicationjsonwebhookscope.md @@ -0,0 +1,11 @@ +# GetWebhooks200ApplicationJSONWebhookScope + +The scope in which the relevant events that will trigger webhooks + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | ID of the scope being used (at the moment, only project ID is supported) | +| `type` | *string* | :heavy_check_mark: | Type of the scope being used | \ No newline at end of file diff --git a/docs/models/operations/getwebhooksdefaultapplicationjson.md b/docs/models/operations/getwebhooksdefaultapplicationjson.md new file mode 100755 index 00000000..f2657b85 --- /dev/null +++ b/docs/models/operations/getwebhooksdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetWebhooksDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getwebhooksrequest.md b/docs/models/operations/getwebhooksrequest.md new file mode 100755 index 00000000..c758180e --- /dev/null +++ b/docs/models/operations/getwebhooksrequest.md @@ -0,0 +1,9 @@ +# GetWebhooksRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `scopeId` | *string* | :heavy_check_mark: | ID of the scope being used (at the moment, only project ID is supported) | +| `scopeType` | [GetWebhooksScopeType](../../models/operations/getwebhooksscopetype.md) | :heavy_check_mark: | Type of the scope being used | \ No newline at end of file diff --git a/docs/models/operations/getwebhooksresponse.md b/docs/models/operations/getwebhooksresponse.md new file mode 100755 index 00000000..6fe0045e --- /dev/null +++ b/docs/models/operations/getwebhooksresponse.md @@ -0,0 +1,12 @@ +# GetWebhooksResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getWebhooks200ApplicationJSONObject` | [GetWebhooks200ApplicationJSON](../../models/operations/getwebhooks200applicationjson.md) | :heavy_minus_sign: | A list of webhooks | +| `getWebhooksDefaultApplicationJSONObject` | [GetWebhooksDefaultApplicationJSON](../../models/operations/getwebhooksdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getwebhooksscopetype.md b/docs/models/operations/getwebhooksscopetype.md new file mode 100755 index 00000000..624709ee --- /dev/null +++ b/docs/models/operations/getwebhooksscopetype.md @@ -0,0 +1,10 @@ +# GetWebhooksScopeType + +Type of the scope being used + + +## Values + +| Name | Value | +| --------- | --------- | +| `Project` | project | \ No newline at end of file diff --git a/docs/models/operations/getworkflowbyiddefaultapplicationjson.md b/docs/models/operations/getworkflowbyiddefaultapplicationjson.md new file mode 100755 index 00000000..5adf874f --- /dev/null +++ b/docs/models/operations/getworkflowbyiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetWorkflowByIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getworkflowbyidrequest.md b/docs/models/operations/getworkflowbyidrequest.md new file mode 100755 index 00000000..f43eebc2 --- /dev/null +++ b/docs/models/operations/getworkflowbyidrequest.md @@ -0,0 +1,8 @@ +# GetWorkflowByIdRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowbyidresponse.md b/docs/models/operations/getworkflowbyidresponse.md new file mode 100755 index 00000000..51946a43 --- /dev/null +++ b/docs/models/operations/getworkflowbyidresponse.md @@ -0,0 +1,12 @@ +# GetWorkflowByIdResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `workflow` | [GetWorkflowByIdWorkflow](../../models/operations/getworkflowbyidworkflow.md) | :heavy_minus_sign: | A workflow object. | +| `getWorkflowByIdDefaultApplicationJSONObject` | [GetWorkflowByIdDefaultApplicationJSON](../../models/operations/getworkflowbyiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowbyidworkflow.md b/docs/models/operations/getworkflowbyidworkflow.md new file mode 100755 index 00000000..1970ca4c --- /dev/null +++ b/docs/models/operations/getworkflowbyidworkflow.md @@ -0,0 +1,21 @@ +# GetWorkflowByIdWorkflow + +A workflow + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `canceledBy` | *string* | :heavy_minus_sign: | N/A | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the workflow was created. | | +| `erroredBy` | *string* | :heavy_minus_sign: | N/A | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | | +| `name` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | +| `pipelineId` | *string* | :heavy_check_mark: | The ID of the pipeline this workflow belongs to. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `pipelineNumber` | *number* | :heavy_check_mark: | The number of the pipeline this workflow belongs to. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline this workflow belongs to. | gh/CircleCI-Public/api-preview-docs | +| `startedBy` | *string* | :heavy_check_mark: | N/A | | +| `status` | [GetWorkflowByIdWorkflowStatus](../../models/operations/getworkflowbyidworkflowstatus.md) | :heavy_check_mark: | The current status of the workflow. | | +| `stoppedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the workflow stopped. | | +| `tag` | [GetWorkflowByIdWorkflowTag](../../models/operations/getworkflowbyidworkflowtag.md) | :heavy_minus_sign: | Tag used for the workflow | setup | \ No newline at end of file diff --git a/docs/models/operations/getworkflowbyidworkflowstatus.md b/docs/models/operations/getworkflowbyidworkflowstatus.md new file mode 100755 index 00000000..b30064f7 --- /dev/null +++ b/docs/models/operations/getworkflowbyidworkflowstatus.md @@ -0,0 +1,18 @@ +# GetWorkflowByIdWorkflowStatus + +The current status of the workflow. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Success` | success | +| `Running` | running | +| `NotRun` | not_run | +| `Failed` | failed | +| `Error` | error | +| `Failing` | failing | +| `OnHold` | on_hold | +| `Canceled` | canceled | +| `Unauthorized` | unauthorized | \ No newline at end of file diff --git a/docs/models/operations/getworkflowbyidworkflowtag.md b/docs/models/operations/getworkflowbyidworkflowtag.md new file mode 100755 index 00000000..199bc82a --- /dev/null +++ b/docs/models/operations/getworkflowbyidworkflowtag.md @@ -0,0 +1,10 @@ +# GetWorkflowByIdWorkflowTag + +Tag used for the workflow + + +## Values + +| Name | Value | +| ------- | ------- | +| `Setup` | setup | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummary200applicationjson.md b/docs/models/operations/getworkflowsummary200applicationjson.md new file mode 100755 index 00000000..15c15f33 --- /dev/null +++ b/docs/models/operations/getworkflowsummary200applicationjson.md @@ -0,0 +1,12 @@ +# GetWorkflowSummary200ApplicationJSON + +Workflow level aggregated metrics and trends response + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `metrics` | [GetWorkflowSummary200ApplicationJSONMetrics](../../models/operations/getworkflowsummary200applicationjsonmetrics.md) | :heavy_check_mark: | Metrics aggregated across a workflow for a given time window. | +| `trends` | [GetWorkflowSummary200ApplicationJSONTrends](../../models/operations/getworkflowsummary200applicationjsontrends.md) | :heavy_check_mark: | Trends for aggregated metrics across a workflow for a given time window. | +| `workflowNames` | *string*[] | :heavy_check_mark: | A list of all the workflow names for a given project. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummary200applicationjsonmetrics.md b/docs/models/operations/getworkflowsummary200applicationjsonmetrics.md new file mode 100755 index 00000000..6503865a --- /dev/null +++ b/docs/models/operations/getworkflowsummary200applicationjsonmetrics.md @@ -0,0 +1,20 @@ +# GetWorkflowSummary200ApplicationJSONMetrics + +Metrics aggregated across a workflow for a given time window. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `completedRuns` | *number* | :heavy_check_mark: | The number of runs that ran to completion within the aggregation window | +| `durationMetrics` | [GetWorkflowSummary200ApplicationJSONMetricsDurationMetrics](../../models/operations/getworkflowsummary200applicationjsonmetricsdurationmetrics.md) | :heavy_check_mark: | Metrics relating to the duration of runs for a workflow. | +| `failedRuns` | *number* | :heavy_check_mark: | The number of failed runs. | +| `mttr` | *number* | :heavy_check_mark: | The mean time to recovery (mean time between failures and their next success) in seconds. | +| `successRate` | *number* | :heavy_check_mark: | N/A | +| `successfulRuns` | *number* | :heavy_check_mark: | The number of successful runs. | +| `throughput` | *number* | :heavy_check_mark: | The average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The total credits consumed by the workflow in the aggregation window. Note that Insights is not a real time financial reporting tool and should not be used for credit reporting. | +| `totalRuns` | *number* | :heavy_check_mark: | The total number of runs, including runs that are still on-hold or running. | +| `windowEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The timestamp of the last build within the requested reporting window. | +| `windowStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The timestamp of the first build within the requested reporting window. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummary200applicationjsonmetricsdurationmetrics.md b/docs/models/operations/getworkflowsummary200applicationjsonmetricsdurationmetrics.md new file mode 100755 index 00000000..bfff214a --- /dev/null +++ b/docs/models/operations/getworkflowsummary200applicationjsonmetricsdurationmetrics.md @@ -0,0 +1,15 @@ +# GetWorkflowSummary200ApplicationJSONMetricsDurationMetrics + +Metrics relating to the duration of runs for a workflow. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `max` | *number* | :heavy_check_mark: | The max duration, in seconds, among a group of runs. | +| `mean` | *number* | :heavy_check_mark: | The mean duration, in seconds, among a group of runs. | +| `median` | *number* | :heavy_check_mark: | The median duration, in seconds, among a group of runs. | +| `min` | *number* | :heavy_check_mark: | The minimum duration, in seconds, among a group of runs. | +| `p95` | *number* | :heavy_check_mark: | The 95th percentile duration, in seconds, among a group of runs. | +| `standardDeviation` | *number* | :heavy_check_mark: | The standard deviation, in seconds, among a group of runs. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummary200applicationjsontrends.md b/docs/models/operations/getworkflowsummary200applicationjsontrends.md new file mode 100755 index 00000000..7a1be959 --- /dev/null +++ b/docs/models/operations/getworkflowsummary200applicationjsontrends.md @@ -0,0 +1,17 @@ +# GetWorkflowSummary200ApplicationJSONTrends + +Trends for aggregated metrics across a workflow for a given time window. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `failedRuns` | *number* | :heavy_check_mark: | The trend value for number of failed runs. | +| `medianDurationSecs` | *number* | :heavy_check_mark: | Trend value for the 50th percentile duration for a workflow for a given time window. | +| `mttr` | *number* | :heavy_check_mark: | trend for mean time to recovery (mean time between failures and their next success). | +| `p95DurationSecs` | *number* | :heavy_check_mark: | Trend value for the 95th percentile duration for a workflow for a given time window. | +| `successRate` | *number* | :heavy_check_mark: | The trend value for the success rate. | +| `throughput` | *number* | :heavy_check_mark: | Trend value for the average number of runs per day. | +| `totalCreditsUsed` | *number* | :heavy_check_mark: | The trend value for total credits consumed. | +| `totalRuns` | *number* | :heavy_check_mark: | The trend value for total number of runs. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummarydefaultapplicationjson.md b/docs/models/operations/getworkflowsummarydefaultapplicationjson.md new file mode 100755 index 00000000..cd4662e7 --- /dev/null +++ b/docs/models/operations/getworkflowsummarydefaultapplicationjson.md @@ -0,0 +1,10 @@ +# GetWorkflowSummaryDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummaryrequest.md b/docs/models/operations/getworkflowsummaryrequest.md new file mode 100755 index 00000000..464b7da6 --- /dev/null +++ b/docs/models/operations/getworkflowsummaryrequest.md @@ -0,0 +1,11 @@ +# GetWorkflowSummaryRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `allBranches` | *boolean* | :heavy_minus_sign: | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. If not passed we will scope the API call to the default branch. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | +| `workflowName` | *string* | :heavy_check_mark: | The name of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/getworkflowsummaryresponse.md b/docs/models/operations/getworkflowsummaryresponse.md new file mode 100755 index 00000000..46f6198a --- /dev/null +++ b/docs/models/operations/getworkflowsummaryresponse.md @@ -0,0 +1,12 @@ +# GetWorkflowSummaryResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `getWorkflowSummary200ApplicationJSONObject` | [GetWorkflowSummary200ApplicationJSON](../../models/operations/getworkflowsummary200applicationjson.md) | :heavy_minus_sign: | Metrics and trends for a workflow | +| `getWorkflowSummaryDefaultApplicationJSONObject` | [GetWorkflowSummaryDefaultApplicationJSON](../../models/operations/getworkflowsummarydefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listcheckoutkeyscheckoutkeylistresponse.md b/docs/models/operations/listcheckoutkeyscheckoutkeylistresponse.md new file mode 100755 index 00000000..4fb532fd --- /dev/null +++ b/docs/models/operations/listcheckoutkeyscheckoutkeylistresponse.md @@ -0,0 +1,11 @@ +# ListCheckoutKeysCheckoutKeyListResponse + +A sequence of checkout keys. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListCheckoutKeysCheckoutKeyListResponseCheckoutKey](../../models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkey.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkey.md b/docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkey.md new file mode 100755 index 00000000..be520ecf --- /dev/null +++ b/docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkey.md @@ -0,0 +1,14 @@ +# ListCheckoutKeysCheckoutKeyListResponseCheckoutKey + +A checkout key + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the checkout key was created. | 2015-09-21T17:29:21.042Z | +| `fingerprint` | *string* | :heavy_check_mark: | An SSH key fingerprint. | c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f | +| `preferred` | *boolean* | :heavy_check_mark: | A boolean value that indicates if this key is preferred. | true | +| `publicKey` | *string* | :heavy_check_mark: | A public SSH key. | ssh-rsa ... | +| `type` | [ListCheckoutKeysCheckoutKeyListResponseCheckoutKeyCheckoutKeyType](../../models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkeycheckoutkeytype.md) | :heavy_check_mark: | The type of checkout key. This may be either `deploy-key` or `github-user-key`. | deploy-key | \ No newline at end of file diff --git a/docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkeycheckoutkeytype.md b/docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkeycheckoutkeytype.md new file mode 100755 index 00000000..432e59f8 --- /dev/null +++ b/docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkeycheckoutkeytype.md @@ -0,0 +1,11 @@ +# ListCheckoutKeysCheckoutKeyListResponseCheckoutKeyCheckoutKeyType + +The type of checkout key. This may be either `deploy-key` or `github-user-key`. + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `DeployKey` | deploy-key | +| `GithubUserKey` | github-user-key | \ No newline at end of file diff --git a/docs/models/operations/listcheckoutkeysdefaultapplicationjson.md b/docs/models/operations/listcheckoutkeysdefaultapplicationjson.md new file mode 100755 index 00000000..9c3d7a69 --- /dev/null +++ b/docs/models/operations/listcheckoutkeysdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListCheckoutKeysDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listcheckoutkeysrequest.md b/docs/models/operations/listcheckoutkeysrequest.md new file mode 100755 index 00000000..d6c767de --- /dev/null +++ b/docs/models/operations/listcheckoutkeysrequest.md @@ -0,0 +1,8 @@ +# ListCheckoutKeysRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/listcheckoutkeysresponse.md b/docs/models/operations/listcheckoutkeysresponse.md new file mode 100755 index 00000000..ad8309e2 --- /dev/null +++ b/docs/models/operations/listcheckoutkeysresponse.md @@ -0,0 +1,12 @@ +# ListCheckoutKeysResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `checkoutKeyListResponse` | [ListCheckoutKeysCheckoutKeyListResponse](../../models/operations/listcheckoutkeyscheckoutkeylistresponse.md) | :heavy_minus_sign: | A sequence of checkout keys. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listCheckoutKeysDefaultApplicationJSONObject` | [ListCheckoutKeysDefaultApplicationJSON](../../models/operations/listcheckoutkeysdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listcontexts200applicationjson.md b/docs/models/operations/listcontexts200applicationjson.md new file mode 100755 index 00000000..e195a669 --- /dev/null +++ b/docs/models/operations/listcontexts200applicationjson.md @@ -0,0 +1,11 @@ +# ListContexts200ApplicationJSON + +A paginated list of contexts + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `items` | [ListContexts200ApplicationJSONContext](../../models/operations/listcontexts200applicationjsoncontext.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listcontexts200applicationjsoncontext.md b/docs/models/operations/listcontexts200applicationjsoncontext.md new file mode 100755 index 00000000..3c186d86 --- /dev/null +++ b/docs/models/operations/listcontexts200applicationjsoncontext.md @@ -0,0 +1,10 @@ +# ListContexts200ApplicationJSONContext + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the context was created. | 2015-09-21T17:29:21.042Z | +| `id` | *string* | :heavy_check_mark: | The unique ID of the context. | | +| `name` | *string* | :heavy_check_mark: | The user defined name of the context. | | \ No newline at end of file diff --git a/docs/models/operations/listcontextsdefaultapplicationjson.md b/docs/models/operations/listcontextsdefaultapplicationjson.md new file mode 100755 index 00000000..7326ebc6 --- /dev/null +++ b/docs/models/operations/listcontextsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListContextsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listcontextsownertype.md b/docs/models/operations/listcontextsownertype.md new file mode 100755 index 00000000..e145460b --- /dev/null +++ b/docs/models/operations/listcontextsownertype.md @@ -0,0 +1,11 @@ +# ListContextsOwnerType + +The type of the owner. Defaults to "organization". Accounts are only used as context owners in server. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Account` | account | +| `Organization` | organization | \ No newline at end of file diff --git a/docs/models/operations/listcontextsrequest.md b/docs/models/operations/listcontextsrequest.md new file mode 100755 index 00000000..99fabb1b --- /dev/null +++ b/docs/models/operations/listcontextsrequest.md @@ -0,0 +1,11 @@ +# ListContextsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `ownerId` | *string* | :heavy_minus_sign: | The unique ID of the owner of the context. Specify either this or owner-slug. | +| `ownerSlug` | *string* | :heavy_minus_sign: | A string that represents an organization. Specify either this or owner-id. Cannot be used for accounts. | +| `ownerType` | [ListContextsOwnerType](../../models/operations/listcontextsownertype.md) | :heavy_minus_sign: | The type of the owner. Defaults to "organization". Accounts are only used as context owners in server. | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listcontextsresponse.md b/docs/models/operations/listcontextsresponse.md new file mode 100755 index 00000000..5afdb81d --- /dev/null +++ b/docs/models/operations/listcontextsresponse.md @@ -0,0 +1,12 @@ +# ListContextsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listContexts200ApplicationJSONObject` | [ListContexts200ApplicationJSON](../../models/operations/listcontexts200applicationjson.md) | :heavy_minus_sign: | A paginated list of contexts | +| `listContextsDefaultApplicationJSONObject` | [ListContextsDefaultApplicationJSON](../../models/operations/listcontextsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listenvironmentvariablesfromcontext200applicationjson.md b/docs/models/operations/listenvironmentvariablesfromcontext200applicationjson.md new file mode 100755 index 00000000..a1b2a989 --- /dev/null +++ b/docs/models/operations/listenvironmentvariablesfromcontext200applicationjson.md @@ -0,0 +1,11 @@ +# ListEnvironmentVariablesFromContext200ApplicationJSON + +A paginated list of environment variables + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListEnvironmentVariablesFromContext200ApplicationJSONItems](../../models/operations/listenvironmentvariablesfromcontext200applicationjsonitems.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listenvironmentvariablesfromcontext200applicationjsonitems.md b/docs/models/operations/listenvironmentvariablesfromcontext200applicationjsonitems.md new file mode 100755 index 00000000..9868a3ab --- /dev/null +++ b/docs/models/operations/listenvironmentvariablesfromcontext200applicationjsonitems.md @@ -0,0 +1,11 @@ +# ListEnvironmentVariablesFromContext200ApplicationJSONItems + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the environment variable was created. | 2015-09-21T17:29:21.042Z | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the environment variable was updated | 2015-09-21T17:29:21.042Z | +| `variable` | *string* | :heavy_check_mark: | The name of the environment variable | POSTGRES_USER | \ No newline at end of file diff --git a/docs/models/operations/listenvironmentvariablesfromcontextdefaultapplicationjson.md b/docs/models/operations/listenvironmentvariablesfromcontextdefaultapplicationjson.md new file mode 100755 index 00000000..2842eff4 --- /dev/null +++ b/docs/models/operations/listenvironmentvariablesfromcontextdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListEnvironmentVariablesFromContextDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listenvironmentvariablesfromcontextrequest.md b/docs/models/operations/listenvironmentvariablesfromcontextrequest.md new file mode 100755 index 00000000..82bc2383 --- /dev/null +++ b/docs/models/operations/listenvironmentvariablesfromcontextrequest.md @@ -0,0 +1,9 @@ +# ListEnvironmentVariablesFromContextRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `contextId` | *string* | :heavy_check_mark: | ID of the context (UUID) | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listenvironmentvariablesfromcontextresponse.md b/docs/models/operations/listenvironmentvariablesfromcontextresponse.md new file mode 100755 index 00000000..15c6728f --- /dev/null +++ b/docs/models/operations/listenvironmentvariablesfromcontextresponse.md @@ -0,0 +1,12 @@ +# ListEnvironmentVariablesFromContextResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listEnvironmentVariablesFromContext200ApplicationJSONObject` | [ListEnvironmentVariablesFromContext200ApplicationJSON](../../models/operations/listenvironmentvariablesfromcontext200applicationjson.md) | :heavy_minus_sign: | A paginated list of environment variables | +| `listEnvironmentVariablesFromContextDefaultApplicationJSONObject` | [ListEnvironmentVariablesFromContextDefaultApplicationJSON](../../models/operations/listenvironmentvariablesfromcontextdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listenvvarsdefaultapplicationjson.md b/docs/models/operations/listenvvarsdefaultapplicationjson.md new file mode 100755 index 00000000..f4b62764 --- /dev/null +++ b/docs/models/operations/listenvvarsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListEnvVarsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listenvvarsenvironmentvariablelistresponse.md b/docs/models/operations/listenvvarsenvironmentvariablelistresponse.md new file mode 100755 index 00000000..70637eb7 --- /dev/null +++ b/docs/models/operations/listenvvarsenvironmentvariablelistresponse.md @@ -0,0 +1,11 @@ +# ListEnvVarsEnvironmentVariableListResponse + +A sequence of environment variables. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListEnvVarsEnvironmentVariableListResponseEnvironmentVariable](../../models/operations/listenvvarsenvironmentvariablelistresponseenvironmentvariable.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listenvvarsenvironmentvariablelistresponseenvironmentvariable.md b/docs/models/operations/listenvvarsenvironmentvariablelistresponseenvironmentvariable.md new file mode 100755 index 00000000..66bece73 --- /dev/null +++ b/docs/models/operations/listenvvarsenvironmentvariablelistresponseenvironmentvariable.md @@ -0,0 +1,12 @@ +# ListEnvVarsEnvironmentVariableListResponseEnvironmentVariable + +An environment variable is a map containing a value and an optional timestamp. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | +| `createdAt` | *any* | :heavy_minus_sign: | The creation timestamp of the environment variable. | | +| `name` | *string* | :heavy_check_mark: | The name of the environment variable. | foo | +| `value` | *string* | :heavy_check_mark: | The value of the environment variable. | xxxx1234 | \ No newline at end of file diff --git a/docs/models/operations/listenvvarsrequest.md b/docs/models/operations/listenvvarsrequest.md new file mode 100755 index 00000000..cd6af660 --- /dev/null +++ b/docs/models/operations/listenvvarsrequest.md @@ -0,0 +1,8 @@ +# ListEnvVarsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/listenvvarsresponse.md b/docs/models/operations/listenvvarsresponse.md new file mode 100755 index 00000000..760b6ab3 --- /dev/null +++ b/docs/models/operations/listenvvarsresponse.md @@ -0,0 +1,12 @@ +# ListEnvVarsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `environmentVariableListResponse` | [ListEnvVarsEnvironmentVariableListResponse](../../models/operations/listenvvarsenvironmentvariablelistresponse.md) | :heavy_minus_sign: | A sequence of environment variables. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listEnvVarsDefaultApplicationJSONObject` | [ListEnvVarsDefaultApplicationJSON](../../models/operations/listenvvarsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinesdefaultapplicationjson.md b/docs/models/operations/listmypipelinesdefaultapplicationjson.md new file mode 100755 index 00000000..0dd56c3f --- /dev/null +++ b/docs/models/operations/listmypipelinesdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListMyPipelinesDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponse.md b/docs/models/operations/listmypipelinespipelinelistresponse.md new file mode 100755 index 00000000..c08f4285 --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponse.md @@ -0,0 +1,11 @@ +# ListMyPipelinesPipelineListResponse + +List of pipelines + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListMyPipelinesPipelineListResponsePipeline](../../models/operations/listmypipelinespipelinelistresponsepipeline.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipeline.md b/docs/models/operations/listmypipelinespipelinelistresponsepipeline.md new file mode 100755 index 00000000..07667174 --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipeline.md @@ -0,0 +1,19 @@ +# ListMyPipelinesPipelineListResponsePipeline + +A pipeline response. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `errors` | [ListMyPipelinesPipelineListResponsePipelineErrors](../../models/operations/listmypipelinespipelinelistresponsepipelineerrors.md)[] | :heavy_check_mark: | A sequence of errors that have occurred within the pipeline. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `number` | *number* | :heavy_check_mark: | The number of the pipeline. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline. | gh/CircleCI-Public/api-preview-docs | +| `state` | [ListMyPipelinesPipelineListResponsePipelineState](../../models/operations/listmypipelinespipelinelistresponsepipelinestate.md) | :heavy_check_mark: | The current state of the pipeline. | | +| `trigger` | [ListMyPipelinesPipelineListResponsePipelineTrigger](../../models/operations/listmypipelinespipelinelistresponsepipelinetrigger.md) | :heavy_check_mark: | A summary of the trigger. | | +| `triggerParameters` | Record | :heavy_minus_sign: | N/A | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the pipeline was last updated. | | +| `vcs` | [ListMyPipelinesPipelineListResponsePipelineVcs](../../models/operations/listmypipelinespipelinelistresponsepipelinevcs.md) | :heavy_minus_sign: | VCS information for the pipeline. | | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelineerrors.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelineerrors.md new file mode 100755 index 00000000..73410df5 --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelineerrors.md @@ -0,0 +1,11 @@ +# ListMyPipelinesPipelineListResponsePipelineErrors + +An error with a type and message. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | A human-readable error message. | +| `type` | [ListMyPipelinesPipelineListResponsePipelineErrorsType](../../models/operations/listmypipelinespipelinelistresponsepipelineerrorstype.md) | :heavy_check_mark: | The type of error. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelineerrorstype.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelineerrorstype.md new file mode 100755 index 00000000..77e56aa9 --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelineerrorstype.md @@ -0,0 +1,15 @@ +# ListMyPipelinesPipelineListResponsePipelineErrorsType + +The type of error. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Config` | config | +| `ConfigFetch` | config-fetch | +| `Timeout` | timeout | +| `Permission` | permission | +| `Other` | other | +| `Plan` | plan | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelinestate.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelinestate.md new file mode 100755 index 00000000..38c038c5 --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelinestate.md @@ -0,0 +1,14 @@ +# ListMyPipelinesPipelineListResponsePipelineState + +The current state of the pipeline. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Created` | created | +| `Errored` | errored | +| `SetupPending` | setup-pending | +| `Setup` | setup | +| `Pending` | pending | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelinetrigger.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelinetrigger.md new file mode 100755 index 00000000..ebe6be6c --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelinetrigger.md @@ -0,0 +1,12 @@ +# ListMyPipelinesPipelineListResponsePipelineTrigger + +A summary of the trigger. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `actor` | [ListMyPipelinesPipelineListResponsePipelineTriggerActor](../../models/operations/listmypipelinespipelinelistresponsepipelinetriggeractor.md) | :heavy_check_mark: | The user who triggered the Pipeline. | +| `receivedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the trigger was received. | +| `type` | [ListMyPipelinesPipelineListResponsePipelineTriggerType](../../models/operations/listmypipelinespipelinelistresponsepipelinetriggertype.md) | :heavy_check_mark: | The type of trigger. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggeractor.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggeractor.md new file mode 100755 index 00000000..3c11eca2 --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggeractor.md @@ -0,0 +1,11 @@ +# ListMyPipelinesPipelineListResponsePipelineTriggerActor + +The user who triggered the Pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `avatarUrl` | *string* | :heavy_check_mark: | URL to the user's avatar on the VCS | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggertype.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggertype.md new file mode 100755 index 00000000..96f789bb --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggertype.md @@ -0,0 +1,13 @@ +# ListMyPipelinesPipelineListResponsePipelineTriggerType + +The type of trigger. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ScheduledPipeline` | scheduled_pipeline | +| `Explicit` | explicit | +| `Api` | api | +| `Webhook` | webhook | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelinevcs.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelinevcs.md new file mode 100755 index 00000000..344f1ffa --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelinevcs.md @@ -0,0 +1,18 @@ +# ListMyPipelinesPipelineListResponsePipelineVcs + +VCS information for the pipeline. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull//head` for the PR ref or `pull//merge` for the merge ref (GitHub only). | feature/design-new-api | +| `commit` | [ListMyPipelinesPipelineListResponsePipelineVcsCommit](../../models/operations/listmypipelinespipelinelistresponsepipelinevcscommit.md) | :heavy_minus_sign: | The latest commit in the pipeline. | | +| `originRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | +| `providerName` | *string* | :heavy_check_mark: | Name of the VCS provider (e.g. GitHub, Bitbucket). | GitHub | +| `reviewId` | *string* | :heavy_minus_sign: | The code review id. | 123 | +| `reviewUrl` | *string* | :heavy_minus_sign: | The code review URL. | https://github.com/CircleCI-Public/api-preview-docs/pull/123 | +| `revision` | *string* | :heavy_check_mark: | The code revision the pipeline ran. | f454a02b5d10fcccfd7d9dd7608a76d6493a98b4 | +| `tag` | *string* | :heavy_minus_sign: | The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. | v3.1.4159 | +| `targetRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinespipelinelistresponsepipelinevcscommit.md b/docs/models/operations/listmypipelinespipelinelistresponsepipelinevcscommit.md new file mode 100755 index 00000000..181450eb --- /dev/null +++ b/docs/models/operations/listmypipelinespipelinelistresponsepipelinevcscommit.md @@ -0,0 +1,11 @@ +# ListMyPipelinesPipelineListResponsePipelineVcsCommit + +The latest commit in the pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the commit message. | +| `subject` | *string* | :heavy_check_mark: | The subject of the commit message. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinesrequest.md b/docs/models/operations/listmypipelinesrequest.md new file mode 100755 index 00000000..5bb117e5 --- /dev/null +++ b/docs/models/operations/listmypipelinesrequest.md @@ -0,0 +1,9 @@ +# ListMyPipelinesRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/listmypipelinesresponse.md b/docs/models/operations/listmypipelinesresponse.md new file mode 100755 index 00000000..6682af06 --- /dev/null +++ b/docs/models/operations/listmypipelinesresponse.md @@ -0,0 +1,12 @@ +# ListMyPipelinesResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipelineListResponse` | [ListMyPipelinesPipelineListResponse](../../models/operations/listmypipelinespipelinelistresponse.md) | :heavy_minus_sign: | A sequence of pipelines. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listMyPipelinesDefaultApplicationJSONObject` | [ListMyPipelinesDefaultApplicationJSON](../../models/operations/listmypipelinesdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesdefaultapplicationjson.md b/docs/models/operations/listpipelinesdefaultapplicationjson.md new file mode 100755 index 00000000..6b095897 --- /dev/null +++ b/docs/models/operations/listpipelinesdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListPipelinesDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectdefaultapplicationjson.md b/docs/models/operations/listpipelinesforprojectdefaultapplicationjson.md new file mode 100755 index 00000000..0b32df59 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListPipelinesForProjectDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponse.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponse.md new file mode 100755 index 00000000..55c89259 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponse.md @@ -0,0 +1,11 @@ +# ListPipelinesForProjectPipelineListResponse + +List of pipelines + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListPipelinesForProjectPipelineListResponsePipeline](../../models/operations/listpipelinesforprojectpipelinelistresponsepipeline.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipeline.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipeline.md new file mode 100755 index 00000000..75ae7bd8 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipeline.md @@ -0,0 +1,19 @@ +# ListPipelinesForProjectPipelineListResponsePipeline + +A pipeline response. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `errors` | [ListPipelinesForProjectPipelineListResponsePipelineErrors](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrors.md)[] | :heavy_check_mark: | A sequence of errors that have occurred within the pipeline. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `number` | *number* | :heavy_check_mark: | The number of the pipeline. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline. | gh/CircleCI-Public/api-preview-docs | +| `state` | [ListPipelinesForProjectPipelineListResponsePipelineState](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelinestate.md) | :heavy_check_mark: | The current state of the pipeline. | | +| `trigger` | [ListPipelinesForProjectPipelineListResponsePipelineTrigger](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelinetrigger.md) | :heavy_check_mark: | A summary of the trigger. | | +| `triggerParameters` | Record | :heavy_minus_sign: | N/A | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the pipeline was last updated. | | +| `vcs` | [ListPipelinesForProjectPipelineListResponsePipelineVcs](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcs.md) | :heavy_minus_sign: | VCS information for the pipeline. | | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrors.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrors.md new file mode 100755 index 00000000..c71f9403 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrors.md @@ -0,0 +1,11 @@ +# ListPipelinesForProjectPipelineListResponsePipelineErrors + +An error with a type and message. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | A human-readable error message. | +| `type` | [ListPipelinesForProjectPipelineListResponsePipelineErrorsType](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrorstype.md) | :heavy_check_mark: | The type of error. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrorstype.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrorstype.md new file mode 100755 index 00000000..29b3d62c --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrorstype.md @@ -0,0 +1,15 @@ +# ListPipelinesForProjectPipelineListResponsePipelineErrorsType + +The type of error. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Config` | config | +| `ConfigFetch` | config-fetch | +| `Timeout` | timeout | +| `Permission` | permission | +| `Other` | other | +| `Plan` | plan | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinestate.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinestate.md new file mode 100755 index 00000000..4a079ca4 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinestate.md @@ -0,0 +1,14 @@ +# ListPipelinesForProjectPipelineListResponsePipelineState + +The current state of the pipeline. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Created` | created | +| `Errored` | errored | +| `SetupPending` | setup-pending | +| `Setup` | setup | +| `Pending` | pending | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetrigger.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetrigger.md new file mode 100755 index 00000000..30010190 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetrigger.md @@ -0,0 +1,12 @@ +# ListPipelinesForProjectPipelineListResponsePipelineTrigger + +A summary of the trigger. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `actor` | [ListPipelinesForProjectPipelineListResponsePipelineTriggerActor](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggeractor.md) | :heavy_check_mark: | The user who triggered the Pipeline. | +| `receivedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the trigger was received. | +| `type` | [ListPipelinesForProjectPipelineListResponsePipelineTriggerType](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggertype.md) | :heavy_check_mark: | The type of trigger. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggeractor.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggeractor.md new file mode 100755 index 00000000..a4933023 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggeractor.md @@ -0,0 +1,11 @@ +# ListPipelinesForProjectPipelineListResponsePipelineTriggerActor + +The user who triggered the Pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `avatarUrl` | *string* | :heavy_check_mark: | URL to the user's avatar on the VCS | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggertype.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggertype.md new file mode 100755 index 00000000..214d94bc --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggertype.md @@ -0,0 +1,13 @@ +# ListPipelinesForProjectPipelineListResponsePipelineTriggerType + +The type of trigger. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ScheduledPipeline` | scheduled_pipeline | +| `Explicit` | explicit | +| `Api` | api | +| `Webhook` | webhook | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcs.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcs.md new file mode 100755 index 00000000..a7b852f7 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcs.md @@ -0,0 +1,18 @@ +# ListPipelinesForProjectPipelineListResponsePipelineVcs + +VCS information for the pipeline. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull//head` for the PR ref or `pull//merge` for the merge ref (GitHub only). | feature/design-new-api | +| `commit` | [ListPipelinesForProjectPipelineListResponsePipelineVcsCommit](../../models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcscommit.md) | :heavy_minus_sign: | The latest commit in the pipeline. | | +| `originRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | +| `providerName` | *string* | :heavy_check_mark: | Name of the VCS provider (e.g. GitHub, Bitbucket). | GitHub | +| `reviewId` | *string* | :heavy_minus_sign: | The code review id. | 123 | +| `reviewUrl` | *string* | :heavy_minus_sign: | The code review URL. | https://github.com/CircleCI-Public/api-preview-docs/pull/123 | +| `revision` | *string* | :heavy_check_mark: | The code revision the pipeline ran. | f454a02b5d10fcccfd7d9dd7608a76d6493a98b4 | +| `tag` | *string* | :heavy_minus_sign: | The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. | v3.1.4159 | +| `targetRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcscommit.md b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcscommit.md new file mode 100755 index 00000000..a50d5a55 --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcscommit.md @@ -0,0 +1,11 @@ +# ListPipelinesForProjectPipelineListResponsePipelineVcsCommit + +The latest commit in the pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the commit message. | +| `subject` | *string* | :heavy_check_mark: | The subject of the commit message. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectrequest.md b/docs/models/operations/listpipelinesforprojectrequest.md new file mode 100755 index 00000000..5b40f7ef --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectrequest.md @@ -0,0 +1,10 @@ +# ListPipelinesForProjectRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The name of a vcs branch. | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesforprojectresponse.md b/docs/models/operations/listpipelinesforprojectresponse.md new file mode 100755 index 00000000..73653c5e --- /dev/null +++ b/docs/models/operations/listpipelinesforprojectresponse.md @@ -0,0 +1,12 @@ +# ListPipelinesForProjectResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipelineListResponse` | [ListPipelinesForProjectPipelineListResponse](../../models/operations/listpipelinesforprojectpipelinelistresponse.md) | :heavy_minus_sign: | A sequence of pipelines. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listPipelinesForProjectDefaultApplicationJSONObject` | [ListPipelinesForProjectDefaultApplicationJSON](../../models/operations/listpipelinesforprojectdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponse.md b/docs/models/operations/listpipelinespipelinelistresponse.md new file mode 100755 index 00000000..848f2e4a --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponse.md @@ -0,0 +1,11 @@ +# ListPipelinesPipelineListResponse + +List of pipelines + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListPipelinesPipelineListResponsePipeline](../../models/operations/listpipelinespipelinelistresponsepipeline.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipeline.md b/docs/models/operations/listpipelinespipelinelistresponsepipeline.md new file mode 100755 index 00000000..8f0612ed --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipeline.md @@ -0,0 +1,19 @@ +# ListPipelinesPipelineListResponsePipeline + +A pipeline response. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `errors` | [ListPipelinesPipelineListResponsePipelineErrors](../../models/operations/listpipelinespipelinelistresponsepipelineerrors.md)[] | :heavy_check_mark: | A sequence of errors that have occurred within the pipeline. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `number` | *number* | :heavy_check_mark: | The number of the pipeline. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline. | gh/CircleCI-Public/api-preview-docs | +| `state` | [ListPipelinesPipelineListResponsePipelineState](../../models/operations/listpipelinespipelinelistresponsepipelinestate.md) | :heavy_check_mark: | The current state of the pipeline. | | +| `trigger` | [ListPipelinesPipelineListResponsePipelineTrigger](../../models/operations/listpipelinespipelinelistresponsepipelinetrigger.md) | :heavy_check_mark: | A summary of the trigger. | | +| `triggerParameters` | Record | :heavy_minus_sign: | N/A | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time the pipeline was last updated. | | +| `vcs` | [ListPipelinesPipelineListResponsePipelineVcs](../../models/operations/listpipelinespipelinelistresponsepipelinevcs.md) | :heavy_minus_sign: | VCS information for the pipeline. | | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelineerrors.md b/docs/models/operations/listpipelinespipelinelistresponsepipelineerrors.md new file mode 100755 index 00000000..df363496 --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelineerrors.md @@ -0,0 +1,11 @@ +# ListPipelinesPipelineListResponsePipelineErrors + +An error with a type and message. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | *string* | :heavy_check_mark: | A human-readable error message. | +| `type` | [ListPipelinesPipelineListResponsePipelineErrorsType](../../models/operations/listpipelinespipelinelistresponsepipelineerrorstype.md) | :heavy_check_mark: | The type of error. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelineerrorstype.md b/docs/models/operations/listpipelinespipelinelistresponsepipelineerrorstype.md new file mode 100755 index 00000000..3996136b --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelineerrorstype.md @@ -0,0 +1,15 @@ +# ListPipelinesPipelineListResponsePipelineErrorsType + +The type of error. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `Config` | config | +| `ConfigFetch` | config-fetch | +| `Timeout` | timeout | +| `Permission` | permission | +| `Other` | other | +| `Plan` | plan | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelinestate.md b/docs/models/operations/listpipelinespipelinelistresponsepipelinestate.md new file mode 100755 index 00000000..34eed7d0 --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelinestate.md @@ -0,0 +1,14 @@ +# ListPipelinesPipelineListResponsePipelineState + +The current state of the pipeline. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Created` | created | +| `Errored` | errored | +| `SetupPending` | setup-pending | +| `Setup` | setup | +| `Pending` | pending | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelinetrigger.md b/docs/models/operations/listpipelinespipelinelistresponsepipelinetrigger.md new file mode 100755 index 00000000..fea5fad4 --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelinetrigger.md @@ -0,0 +1,12 @@ +# ListPipelinesPipelineListResponsePipelineTrigger + +A summary of the trigger. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `actor` | [ListPipelinesPipelineListResponsePipelineTriggerActor](../../models/operations/listpipelinespipelinelistresponsepipelinetriggeractor.md) | :heavy_check_mark: | The user who triggered the Pipeline. | +| `receivedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the trigger was received. | +| `type` | [ListPipelinesPipelineListResponsePipelineTriggerType](../../models/operations/listpipelinespipelinelistresponsepipelinetriggertype.md) | :heavy_check_mark: | The type of trigger. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelinetriggeractor.md b/docs/models/operations/listpipelinespipelinelistresponsepipelinetriggeractor.md new file mode 100755 index 00000000..a3e09b5f --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelinetriggeractor.md @@ -0,0 +1,11 @@ +# ListPipelinesPipelineListResponsePipelineTriggerActor + +The user who triggered the Pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `avatarUrl` | *string* | :heavy_check_mark: | URL to the user's avatar on the VCS | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelinetriggertype.md b/docs/models/operations/listpipelinespipelinelistresponsepipelinetriggertype.md new file mode 100755 index 00000000..3a212e62 --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelinetriggertype.md @@ -0,0 +1,13 @@ +# ListPipelinesPipelineListResponsePipelineTriggerType + +The type of trigger. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ScheduledPipeline` | scheduled_pipeline | +| `Explicit` | explicit | +| `Api` | api | +| `Webhook` | webhook | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelinevcs.md b/docs/models/operations/listpipelinespipelinelistresponsepipelinevcs.md new file mode 100755 index 00000000..0711fb98 --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelinevcs.md @@ -0,0 +1,18 @@ +# ListPipelinesPipelineListResponsePipelineVcs + +VCS information for the pipeline. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull//head` for the PR ref or `pull//merge` for the merge ref (GitHub only). | feature/design-new-api | +| `commit` | [ListPipelinesPipelineListResponsePipelineVcsCommit](../../models/operations/listpipelinespipelinelistresponsepipelinevcscommit.md) | :heavy_minus_sign: | The latest commit in the pipeline. | | +| `originRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | +| `providerName` | *string* | :heavy_check_mark: | Name of the VCS provider (e.g. GitHub, Bitbucket). | GitHub | +| `reviewId` | *string* | :heavy_minus_sign: | The code review id. | 123 | +| `reviewUrl` | *string* | :heavy_minus_sign: | The code review URL. | https://github.com/CircleCI-Public/api-preview-docs/pull/123 | +| `revision` | *string* | :heavy_check_mark: | The code revision the pipeline ran. | f454a02b5d10fcccfd7d9dd7608a76d6493a98b4 | +| `tag` | *string* | :heavy_minus_sign: | The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. | v3.1.4159 | +| `targetRepositoryUrl` | *string* | :heavy_check_mark: | URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same. | https://github.com/CircleCI-Public/api-preview-docs | \ No newline at end of file diff --git a/docs/models/operations/listpipelinespipelinelistresponsepipelinevcscommit.md b/docs/models/operations/listpipelinespipelinelistresponsepipelinevcscommit.md new file mode 100755 index 00000000..6d38e282 --- /dev/null +++ b/docs/models/operations/listpipelinespipelinelistresponsepipelinevcscommit.md @@ -0,0 +1,11 @@ +# ListPipelinesPipelineListResponsePipelineVcsCommit + +The latest commit in the pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `body` | *string* | :heavy_check_mark: | The body of the commit message. | +| `subject` | *string* | :heavy_check_mark: | The subject of the commit message. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesrequest.md b/docs/models/operations/listpipelinesrequest.md new file mode 100755 index 00000000..40c72c48 --- /dev/null +++ b/docs/models/operations/listpipelinesrequest.md @@ -0,0 +1,10 @@ +# ListPipelinesRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `mine` | *boolean* | :heavy_minus_sign: | Only include entries created by your user. | +| `orgSlug` | *string* | :heavy_minus_sign: | Org slug in the form `vcs-slug/org-name` | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listpipelinesresponse.md b/docs/models/operations/listpipelinesresponse.md new file mode 100755 index 00000000..660e7bda --- /dev/null +++ b/docs/models/operations/listpipelinesresponse.md @@ -0,0 +1,12 @@ +# ListPipelinesResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipelineListResponse` | [ListPipelinesPipelineListResponse](../../models/operations/listpipelinespipelinelistresponse.md) | :heavy_minus_sign: | A sequence of pipelines. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listPipelinesDefaultApplicationJSONObject` | [ListPipelinesDefaultApplicationJSON](../../models/operations/listpipelinesdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjson.md b/docs/models/operations/listschedulesforproject200applicationjson.md new file mode 100755 index 00000000..604be9f0 --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjson.md @@ -0,0 +1,11 @@ +# ListSchedulesForProject200ApplicationJSON + +A sequence of schedules + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListSchedulesForProject200ApplicationJSONSchedule](../../models/operations/listschedulesforproject200applicationjsonschedule.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonschedule.md b/docs/models/operations/listschedulesforproject200applicationjsonschedule.md new file mode 100755 index 00000000..a5677485 --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonschedule.md @@ -0,0 +1,18 @@ +# ListSchedulesForProject200ApplicationJSONSchedule + +A schedule response + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `actor` | [ListSchedulesForProject200ApplicationJSONScheduleUser](../../models/operations/listschedulesforproject200applicationjsonscheduleuser.md) | :heavy_check_mark: | The attribution actor who will run the scheduled pipeline. | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `description` | *string* | :heavy_check_mark: | Description of the schedule. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the schedule. | | +| `name` | *string* | :heavy_check_mark: | Name of the schedule. | | +| `parameters` | Record | :heavy_check_mark: | Pipeline parameters represented as key-value pairs. Must contain branch or tag. | | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the schedule | gh/CircleCI-Public/api-preview-docs | +| `timetable` | *any* | :heavy_check_mark: | Timetable that specifies when a schedule triggers. | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was last updated. | | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1.md new file mode 100755 index 00000000..a1d74e1d --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1.md @@ -0,0 +1,14 @@ +# ListSchedulesForProject200ApplicationJSONScheduleTimetable1 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_minus_sign: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [ListSchedulesForProject200ApplicationJSONScheduleTimetable1DaysOfWeek](../../models/operations/listschedulesforproject200applicationjsonscheduletimetable1daysofweek.md)[] | :heavy_check_mark: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [ListSchedulesForProject200ApplicationJSONScheduleTimetable1Months](../../models/operations/listschedulesforproject200applicationjsonscheduletimetable1months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1daysofweek.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1daysofweek.md new file mode 100755 index 00000000..ac252e67 --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1daysofweek.md @@ -0,0 +1,16 @@ +# ListSchedulesForProject200ApplicationJSONScheduleTimetable1DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1months.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1months.md new file mode 100755 index 00000000..85811278 --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1months.md @@ -0,0 +1,21 @@ +# ListSchedulesForProject200ApplicationJSONScheduleTimetable1Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2.md new file mode 100755 index 00000000..be97581a --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2.md @@ -0,0 +1,14 @@ +# ListSchedulesForProject200ApplicationJSONScheduleTimetable2 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_check_mark: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [ListSchedulesForProject200ApplicationJSONScheduleTimetable2DaysOfWeek](../../models/operations/listschedulesforproject200applicationjsonscheduletimetable2daysofweek.md)[] | :heavy_minus_sign: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [ListSchedulesForProject200ApplicationJSONScheduleTimetable2Months](../../models/operations/listschedulesforproject200applicationjsonscheduletimetable2months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2daysofweek.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2daysofweek.md new file mode 100755 index 00000000..9b02407a --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2daysofweek.md @@ -0,0 +1,16 @@ +# ListSchedulesForProject200ApplicationJSONScheduleTimetable2DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2months.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2months.md new file mode 100755 index 00000000..5224d27d --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2months.md @@ -0,0 +1,21 @@ +# ListSchedulesForProject200ApplicationJSONScheduleTimetable2Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforproject200applicationjsonscheduleuser.md b/docs/models/operations/listschedulesforproject200applicationjsonscheduleuser.md new file mode 100755 index 00000000..9bbc7c9a --- /dev/null +++ b/docs/models/operations/listschedulesforproject200applicationjsonscheduleuser.md @@ -0,0 +1,12 @@ +# ListSchedulesForProject200ApplicationJSONScheduleUser + +The attribution actor who will run the scheduled pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | +| `name` | *string* | :heavy_check_mark: | The name of the user. | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforprojectdefaultapplicationjson.md b/docs/models/operations/listschedulesforprojectdefaultapplicationjson.md new file mode 100755 index 00000000..4a54f904 --- /dev/null +++ b/docs/models/operations/listschedulesforprojectdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListSchedulesForProjectDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforprojectrequest.md b/docs/models/operations/listschedulesforprojectrequest.md new file mode 100755 index 00000000..7b12dd75 --- /dev/null +++ b/docs/models/operations/listschedulesforprojectrequest.md @@ -0,0 +1,9 @@ +# ListSchedulesForProjectRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/listschedulesforprojectresponse.md b/docs/models/operations/listschedulesforprojectresponse.md new file mode 100755 index 00000000..d0fb80a6 --- /dev/null +++ b/docs/models/operations/listschedulesforprojectresponse.md @@ -0,0 +1,12 @@ +# ListSchedulesForProjectResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `listSchedulesForProject200ApplicationJSONObject` | [ListSchedulesForProject200ApplicationJSON](../../models/operations/listschedulesforproject200applicationjson.md) | :heavy_minus_sign: | A sequence of schedules. | +| `listSchedulesForProjectDefaultApplicationJSONObject` | [ListSchedulesForProjectDefaultApplicationJSON](../../models/operations/listschedulesforprojectdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsdefaultapplicationjson.md b/docs/models/operations/listworkflowjobsdefaultapplicationjson.md new file mode 100755 index 00000000..accfa98d --- /dev/null +++ b/docs/models/operations/listworkflowjobsdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListWorkflowJobsDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsrequest.md b/docs/models/operations/listworkflowjobsrequest.md new file mode 100755 index 00000000..be34a7ba --- /dev/null +++ b/docs/models/operations/listworkflowjobsrequest.md @@ -0,0 +1,8 @@ +# ListWorkflowJobsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsresponse.md b/docs/models/operations/listworkflowjobsresponse.md new file mode 100755 index 00000000..08ccc168 --- /dev/null +++ b/docs/models/operations/listworkflowjobsresponse.md @@ -0,0 +1,12 @@ +# ListWorkflowJobsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `workflowJobListResponse` | [ListWorkflowJobsWorkflowJobListResponse](../../models/operations/listworkflowjobsworkflowjoblistresponse.md) | :heavy_minus_sign: | A paginated sequence of jobs. | +| `listWorkflowJobsDefaultApplicationJSONObject` | [ListWorkflowJobsDefaultApplicationJSON](../../models/operations/listworkflowjobsdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsworkflowjoblistresponse.md b/docs/models/operations/listworkflowjobsworkflowjoblistresponse.md new file mode 100755 index 00000000..6a23623e --- /dev/null +++ b/docs/models/operations/listworkflowjobsworkflowjoblistresponse.md @@ -0,0 +1,11 @@ +# ListWorkflowJobsWorkflowJobListResponse + +A paginated sequence of jobs. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListWorkflowJobsWorkflowJobListResponseJob](../../models/operations/listworkflowjobsworkflowjoblistresponsejob.md)[] | :heavy_check_mark: | N/A | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsworkflowjoblistresponsejob.md b/docs/models/operations/listworkflowjobsworkflowjoblistresponsejob.md new file mode 100755 index 00000000..ea3cfd30 --- /dev/null +++ b/docs/models/operations/listworkflowjobsworkflowjoblistresponsejob.md @@ -0,0 +1,21 @@ +# ListWorkflowJobsWorkflowJobListResponseJob + +Job + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `approvalRequestId` | *string* | :heavy_minus_sign: | The unique ID of the job. | | +| `approvedBy` | *string* | :heavy_minus_sign: | The unique ID of the user. | | +| `canceledBy` | *string* | :heavy_minus_sign: | The unique ID of the user. | | +| `dependencies` | *string*[] | :heavy_check_mark: | A sequence of the unique job IDs for the jobs that this job depends upon in the workflow. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the job. | | +| `jobNumber` | *number* | :heavy_minus_sign: | The number of the job. | | +| `name` | *string* | :heavy_check_mark: | The name of the job. | | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the job. | gh/CircleCI-Public/api-preview-docs | +| `startedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the job started. | | +| `status` | [ListWorkflowJobsWorkflowJobListResponseJobStatus](../../models/operations/listworkflowjobsworkflowjoblistresponsejobstatus.md) | :heavy_check_mark: | The current status of the job. | | +| `stoppedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The time when the job stopped. | | +| `type` | [ListWorkflowJobsWorkflowJobListResponseJobType](../../models/operations/listworkflowjobsworkflowjoblistresponsejobtype.md) | :heavy_check_mark: | The type of job. | | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsworkflowjoblistresponsejobstatus.md b/docs/models/operations/listworkflowjobsworkflowjoblistresponsejobstatus.md new file mode 100755 index 00000000..8f99a0ee --- /dev/null +++ b/docs/models/operations/listworkflowjobsworkflowjoblistresponsejobstatus.md @@ -0,0 +1,23 @@ +# ListWorkflowJobsWorkflowJobListResponseJobStatus + +The current status of the job. + + +## Values + +| Name | Value | +| -------------------- | -------------------- | +| `Success` | success | +| `Running` | running | +| `NotRun` | not_run | +| `Failed` | failed | +| `Retried` | retried | +| `Queued` | queued | +| `NotRunning` | not_running | +| `InfrastructureFail` | infrastructure_fail | +| `Timedout` | timedout | +| `OnHold` | on_hold | +| `TerminatedUnknown` | terminated-unknown | +| `Blocked` | blocked | +| `Canceled` | canceled | +| `Unauthorized` | unauthorized | \ No newline at end of file diff --git a/docs/models/operations/listworkflowjobsworkflowjoblistresponsejobtype.md b/docs/models/operations/listworkflowjobsworkflowjoblistresponsejobtype.md new file mode 100755 index 00000000..fdc50c7c --- /dev/null +++ b/docs/models/operations/listworkflowjobsworkflowjoblistresponsejobtype.md @@ -0,0 +1,11 @@ +# ListWorkflowJobsWorkflowJobListResponseJobType + +The type of job. + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `Build` | build | +| `Approval` | approval | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineiddefaultapplicationjson.md b/docs/models/operations/listworkflowsbypipelineiddefaultapplicationjson.md new file mode 100755 index 00000000..c28008eb --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineiddefaultapplicationjson.md @@ -0,0 +1,10 @@ +# ListWorkflowsByPipelineIdDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineidrequest.md b/docs/models/operations/listworkflowsbypipelineidrequest.md new file mode 100755 index 00000000..3340fe24 --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineidrequest.md @@ -0,0 +1,9 @@ +# ListWorkflowsByPipelineIdRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `pageToken` | *string* | :heavy_minus_sign: | A token to retrieve the next page of results. | +| `pipelineId` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineidresponse.md b/docs/models/operations/listworkflowsbypipelineidresponse.md new file mode 100755 index 00000000..b783f55e --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineidresponse.md @@ -0,0 +1,12 @@ +# ListWorkflowsByPipelineIdResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `workflowListResponse` | [ListWorkflowsByPipelineIdWorkflowListResponse](../../models/operations/listworkflowsbypipelineidworkflowlistresponse.md) | :heavy_minus_sign: | A paginated list of workflow objects. | +| `listWorkflowsByPipelineIdDefaultApplicationJSONObject` | [ListWorkflowsByPipelineIdDefaultApplicationJSON](../../models/operations/listworkflowsbypipelineiddefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineidworkflowlistresponse.md b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponse.md new file mode 100755 index 00000000..c5ca20c2 --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponse.md @@ -0,0 +1,11 @@ +# ListWorkflowsByPipelineIdWorkflowListResponse + +A list of workflows and associated pagination token. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `items` | [ListWorkflowsByPipelineIdWorkflowListResponseWorkflow](../../models/operations/listworkflowsbypipelineidworkflowlistresponseworkflow.md)[] | :heavy_check_mark: | A list of workflows. | +| `nextPageToken` | *string* | :heavy_check_mark: | A token to pass as a `page-token` query parameter to return the next page of results. | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflow.md b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflow.md new file mode 100755 index 00000000..6ee19d54 --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflow.md @@ -0,0 +1,21 @@ +# ListWorkflowsByPipelineIdWorkflowListResponseWorkflow + +A workflow + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `canceledBy` | *string* | :heavy_minus_sign: | N/A | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the workflow was created. | | +| `erroredBy` | *string* | :heavy_minus_sign: | N/A | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | | +| `name` | *string* | :heavy_check_mark: | The name of the workflow. | build-and-test | +| `pipelineId` | *string* | :heavy_check_mark: | The ID of the pipeline this workflow belongs to. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `pipelineNumber` | *number* | :heavy_check_mark: | The number of the pipeline this workflow belongs to. | 25 | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the pipeline this workflow belongs to. | gh/CircleCI-Public/api-preview-docs | +| `startedBy` | *string* | :heavy_check_mark: | N/A | | +| `status` | [ListWorkflowsByPipelineIdWorkflowListResponseWorkflowStatus](../../models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowstatus.md) | :heavy_check_mark: | The current status of the workflow. | | +| `stoppedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the workflow stopped. | | +| `tag` | [ListWorkflowsByPipelineIdWorkflowListResponseWorkflowTag](../../models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowtag.md) | :heavy_minus_sign: | Tag used for the workflow | setup | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowstatus.md b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowstatus.md new file mode 100755 index 00000000..e0cca80c --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowstatus.md @@ -0,0 +1,18 @@ +# ListWorkflowsByPipelineIdWorkflowListResponseWorkflowStatus + +The current status of the workflow. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Success` | success | +| `Running` | running | +| `NotRun` | not_run | +| `Failed` | failed | +| `Error` | error | +| `Failing` | failing | +| `OnHold` | on_hold | +| `Canceled` | canceled | +| `Unauthorized` | unauthorized | \ No newline at end of file diff --git a/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowtag.md b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowtag.md new file mode 100755 index 00000000..e45fbbad --- /dev/null +++ b/docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowtag.md @@ -0,0 +1,10 @@ +# ListWorkflowsByPipelineIdWorkflowListResponseWorkflowTag + +Tag used for the workflow + + +## Values + +| Name | Value | +| ------- | ------- | +| `Setup` | setup | \ No newline at end of file diff --git a/docs/models/operations/makedecision400applicationjson.md b/docs/models/operations/makedecision400applicationjson.md new file mode 100755 index 00000000..1255a5ab --- /dev/null +++ b/docs/models/operations/makedecision400applicationjson.md @@ -0,0 +1,11 @@ +# MakeDecision400ApplicationJSON + +The request is malformed + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | context: must be a valid value. | \ No newline at end of file diff --git a/docs/models/operations/makedecision401applicationjson.md b/docs/models/operations/makedecision401applicationjson.md new file mode 100755 index 00000000..0e0ec523 --- /dev/null +++ b/docs/models/operations/makedecision401applicationjson.md @@ -0,0 +1,11 @@ +# MakeDecision401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized. | \ No newline at end of file diff --git a/docs/models/operations/makedecision500applicationjson.md b/docs/models/operations/makedecision500applicationjson.md new file mode 100755 index 00000000..8a6e6fd8 --- /dev/null +++ b/docs/models/operations/makedecision500applicationjson.md @@ -0,0 +1,10 @@ +# MakeDecision500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | There was an error processing your request. | \ No newline at end of file diff --git a/docs/models/operations/makedecisionrequest.md b/docs/models/operations/makedecisionrequest.md new file mode 100755 index 00000000..29cb1911 --- /dev/null +++ b/docs/models/operations/makedecisionrequest.md @@ -0,0 +1,10 @@ +# MakeDecisionRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `requestBody` | [MakeDecisionRequestBody](../../models/operations/makedecisionrequestbody.md) | :heavy_minus_sign: | N/A | +| `context` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/makedecisionrequestbody.md b/docs/models/operations/makedecisionrequestbody.md new file mode 100755 index 00000000..e3858ef3 --- /dev/null +++ b/docs/models/operations/makedecisionrequestbody.md @@ -0,0 +1,9 @@ +# MakeDecisionRequestBody + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `input` | *string* | :heavy_check_mark: | N/A | +| `metadata` | [MakeDecisionRequestBodyMetadata](../../models/operations/makedecisionrequestbodymetadata.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/makedecisionrequestbodymetadata.md b/docs/models/operations/makedecisionrequestbodymetadata.md new file mode 100755 index 00000000..9f09e11d --- /dev/null +++ b/docs/models/operations/makedecisionrequestbodymetadata.md @@ -0,0 +1,7 @@ +# MakeDecisionRequestBodyMetadata + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/operations/makedecisionresponse.md b/docs/models/operations/makedecisionresponse.md new file mode 100755 index 00000000..56fb918f --- /dev/null +++ b/docs/models/operations/makedecisionresponse.md @@ -0,0 +1,14 @@ +# MakeDecisionResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `decision` | [shared.Decision](../../models/shared/decision.md) | :heavy_minus_sign: | Decision rendered by applying the policy against the provided data. Response will be modeled by the data and rego processed. | +| `makeDecision400ApplicationJSONObject` | [MakeDecision400ApplicationJSON](../../models/operations/makedecision400applicationjson.md) | :heavy_minus_sign: | The request is malformed
| +| `makeDecision401ApplicationJSONObject` | [MakeDecision401ApplicationJSON](../../models/operations/makedecision401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `makeDecision500ApplicationJSONObject` | [MakeDecision500ApplicationJSON](../../models/operations/makedecision500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/patchorgclaims400applicationjson.md b/docs/models/operations/patchorgclaims400applicationjson.md new file mode 100755 index 00000000..b1b000e9 --- /dev/null +++ b/docs/models/operations/patchorgclaims400applicationjson.md @@ -0,0 +1,11 @@ +# PatchOrgClaims400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/patchorgclaims403applicationjson.md b/docs/models/operations/patchorgclaims403applicationjson.md new file mode 100755 index 00000000..653ccc49 --- /dev/null +++ b/docs/models/operations/patchorgclaims403applicationjson.md @@ -0,0 +1,11 @@ +# PatchOrgClaims403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/patchorgclaims500applicationjson.md b/docs/models/operations/patchorgclaims500applicationjson.md new file mode 100755 index 00000000..e1a86b87 --- /dev/null +++ b/docs/models/operations/patchorgclaims500applicationjson.md @@ -0,0 +1,10 @@ +# PatchOrgClaims500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | internal server error | \ No newline at end of file diff --git a/docs/models/operations/patchorgclaimsrequest.md b/docs/models/operations/patchorgclaimsrequest.md new file mode 100755 index 00000000..3316ab99 --- /dev/null +++ b/docs/models/operations/patchorgclaimsrequest.md @@ -0,0 +1,9 @@ +# PatchOrgClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `patchClaimsRequest` | [shared.PatchClaimsRequest](../../models/shared/patchclaimsrequest.md) | :heavy_minus_sign: | N/A | +| `orgID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchorgclaimsresponse.md b/docs/models/operations/patchorgclaimsresponse.md new file mode 100755 index 00000000..d26c44f5 --- /dev/null +++ b/docs/models/operations/patchorgclaimsresponse.md @@ -0,0 +1,14 @@ +# PatchOrgClaimsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `claimResponse` | [shared.ClaimResponse](../../models/shared/claimresponse.md) | :heavy_minus_sign: | Claims successfully patched. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `patchOrgClaims400ApplicationJSONObject` | [PatchOrgClaims400ApplicationJSON](../../models/operations/patchorgclaims400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `patchOrgClaims403ApplicationJSONObject` | [PatchOrgClaims403ApplicationJSON](../../models/operations/patchorgclaims403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `patchOrgClaims500ApplicationJSONObject` | [PatchOrgClaims500ApplicationJSON](../../models/operations/patchorgclaims500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/patchprojectclaims400applicationjson.md b/docs/models/operations/patchprojectclaims400applicationjson.md new file mode 100755 index 00000000..31bacd6a --- /dev/null +++ b/docs/models/operations/patchprojectclaims400applicationjson.md @@ -0,0 +1,11 @@ +# PatchProjectClaims400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/patchprojectclaims403applicationjson.md b/docs/models/operations/patchprojectclaims403applicationjson.md new file mode 100755 index 00000000..7c2078be --- /dev/null +++ b/docs/models/operations/patchprojectclaims403applicationjson.md @@ -0,0 +1,11 @@ +# PatchProjectClaims403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/patchprojectclaims500applicationjson.md b/docs/models/operations/patchprojectclaims500applicationjson.md new file mode 100755 index 00000000..4c5e2382 --- /dev/null +++ b/docs/models/operations/patchprojectclaims500applicationjson.md @@ -0,0 +1,10 @@ +# PatchProjectClaims500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | internal server error | \ No newline at end of file diff --git a/docs/models/operations/patchprojectclaimsrequest.md b/docs/models/operations/patchprojectclaimsrequest.md new file mode 100755 index 00000000..66b56577 --- /dev/null +++ b/docs/models/operations/patchprojectclaimsrequest.md @@ -0,0 +1,10 @@ +# PatchProjectClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `patchClaimsRequest` | [shared.PatchClaimsRequest](../../models/shared/patchclaimsrequest.md) | :heavy_minus_sign: | N/A | +| `orgID` | *string* | :heavy_check_mark: | N/A | +| `projectID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchprojectclaimsresponse.md b/docs/models/operations/patchprojectclaimsresponse.md new file mode 100755 index 00000000..f5ab966b --- /dev/null +++ b/docs/models/operations/patchprojectclaimsresponse.md @@ -0,0 +1,14 @@ +# PatchProjectClaimsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `claimResponse` | [shared.ClaimResponse](../../models/shared/claimresponse.md) | :heavy_minus_sign: | Claims successfully patched. | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `patchProjectClaims400ApplicationJSONObject` | [PatchProjectClaims400ApplicationJSON](../../models/operations/patchprojectclaims400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `patchProjectClaims403ApplicationJSONObject` | [PatchProjectClaims403ApplicationJSON](../../models/operations/patchprojectclaims403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `patchProjectClaims500ApplicationJSONObject` | [PatchProjectClaims500ApplicationJSON](../../models/operations/patchprojectclaims500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/models/operations/rerunworkflow202applicationjson.md b/docs/models/operations/rerunworkflow202applicationjson.md new file mode 100755 index 00000000..684f9b79 --- /dev/null +++ b/docs/models/operations/rerunworkflow202applicationjson.md @@ -0,0 +1,10 @@ +# RerunWorkflow202ApplicationJSON + +A response to rerunning a workflow + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `workflowId` | *string* | :heavy_check_mark: | The ID of the newly-created workflow. | 0e53027b-521a-4c40-9042-47e72b3c63a3 | \ No newline at end of file diff --git a/docs/models/operations/rerunworkflowdefaultapplicationjson.md b/docs/models/operations/rerunworkflowdefaultapplicationjson.md new file mode 100755 index 00000000..bb1b5ae1 --- /dev/null +++ b/docs/models/operations/rerunworkflowdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# RerunWorkflowDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/rerunworkflowrequest.md b/docs/models/operations/rerunworkflowrequest.md new file mode 100755 index 00000000..2898795e --- /dev/null +++ b/docs/models/operations/rerunworkflowrequest.md @@ -0,0 +1,9 @@ +# RerunWorkflowRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `requestBody` | [RerunWorkflowRerunWorkflowParameters](../../models/operations/rerunworkflowrerunworkflowparameters.md) | :heavy_minus_sign: | N/A | +| `id` | *string* | :heavy_check_mark: | The unique ID of the workflow. | \ No newline at end of file diff --git a/docs/models/operations/rerunworkflowrerunworkflowparameters.md b/docs/models/operations/rerunworkflowrerunworkflowparameters.md new file mode 100755 index 00000000..b9bb0dbc --- /dev/null +++ b/docs/models/operations/rerunworkflowrerunworkflowparameters.md @@ -0,0 +1,13 @@ +# RerunWorkflowRerunWorkflowParameters + +The information you can supply when rerunning a workflow. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enableSsh` | *boolean* | :heavy_minus_sign: | Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter. | false | +| `fromFailed` | *boolean* | :heavy_minus_sign: | Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter. | false | +| `jobs` | *string*[] | :heavy_minus_sign: | A list of job IDs to rerun. | | +| `sparseTree` | *boolean* | :heavy_minus_sign: | Completes rerun using sparse trees logic, an optimization for workflows that have disconnected subgraphs. Requires jobs parameter and so is mutually exclusive with the from_failed parameter. | false | \ No newline at end of file diff --git a/docs/models/operations/rerunworkflowresponse.md b/docs/models/operations/rerunworkflowresponse.md new file mode 100755 index 00000000..feba0459 --- /dev/null +++ b/docs/models/operations/rerunworkflowresponse.md @@ -0,0 +1,12 @@ +# RerunWorkflowResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `rerunWorkflow202ApplicationJSONObject` | [RerunWorkflow202ApplicationJSON](../../models/operations/rerunworkflow202applicationjson.md) | :heavy_minus_sign: | A confirmation message. | +| `rerunWorkflowDefaultApplicationJSONObject` | [RerunWorkflowDefaultApplicationJSON](../../models/operations/rerunworkflowdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/setdecisionsettings400applicationjson.md b/docs/models/operations/setdecisionsettings400applicationjson.md new file mode 100755 index 00000000..9e5b2e0a --- /dev/null +++ b/docs/models/operations/setdecisionsettings400applicationjson.md @@ -0,0 +1,11 @@ +# SetDecisionSettings400ApplicationJSON + +The request is malformed (e.g, a given path parameter is invalid) + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | OwnerID: must be a valid UUID. | \ No newline at end of file diff --git a/docs/models/operations/setdecisionsettings401applicationjson.md b/docs/models/operations/setdecisionsettings401applicationjson.md new file mode 100755 index 00000000..63bd9782 --- /dev/null +++ b/docs/models/operations/setdecisionsettings401applicationjson.md @@ -0,0 +1,11 @@ +# SetDecisionSettings401ApplicationJSON + +The request is unauthorized + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | \ No newline at end of file diff --git a/docs/models/operations/setdecisionsettings403applicationjson.md b/docs/models/operations/setdecisionsettings403applicationjson.md new file mode 100755 index 00000000..bc41acc9 --- /dev/null +++ b/docs/models/operations/setdecisionsettings403applicationjson.md @@ -0,0 +1,11 @@ +# SetDecisionSettings403ApplicationJSON + +The user is forbidden from making this request + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `error` | *string* | :heavy_check_mark: | N/A | Forbidden | \ No newline at end of file diff --git a/docs/models/operations/setdecisionsettings500applicationjson.md b/docs/models/operations/setdecisionsettings500applicationjson.md new file mode 100755 index 00000000..d4c9a942 --- /dev/null +++ b/docs/models/operations/setdecisionsettings500applicationjson.md @@ -0,0 +1,10 @@ +# SetDecisionSettings500ApplicationJSON + +Something unexpected happened on the server. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `error` | *string* | :heavy_check_mark: | N/A | unexpected server error | \ No newline at end of file diff --git a/docs/models/operations/setdecisionsettingsrequest.md b/docs/models/operations/setdecisionsettingsrequest.md new file mode 100755 index 00000000..efeedece --- /dev/null +++ b/docs/models/operations/setdecisionsettingsrequest.md @@ -0,0 +1,10 @@ +# SetDecisionSettingsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `decisionSettings` | [shared.DecisionSettings](../../models/shared/decisionsettings.md) | :heavy_minus_sign: | N/A | +| `context` | *string* | :heavy_check_mark: | N/A | +| `ownerID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/setdecisionsettingsresponse.md b/docs/models/operations/setdecisionsettingsresponse.md new file mode 100755 index 00000000..96df3d50 --- /dev/null +++ b/docs/models/operations/setdecisionsettingsresponse.md @@ -0,0 +1,15 @@ +# SetDecisionSettingsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `decisionSettings` | [shared.DecisionSettings](../../models/shared/decisionsettings.md) | :heavy_minus_sign: | Decision settings successfully set. | +| `setDecisionSettings400ApplicationJSONObject` | [SetDecisionSettings400ApplicationJSON](../../models/operations/setdecisionsettings400applicationjson.md) | :heavy_minus_sign: | The request is malformed (e.g, a given path parameter is invalid)
| +| `setDecisionSettings403ApplicationJSONObject` | [SetDecisionSettings403ApplicationJSON](../../models/operations/setdecisionsettings403applicationjson.md) | :heavy_minus_sign: | The user is forbidden from making this request
| +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `setDecisionSettings401ApplicationJSONObject` | [SetDecisionSettings401ApplicationJSON](../../models/operations/setdecisionsettings401applicationjson.md) | :heavy_minus_sign: | The request is unauthorized
| +| `setDecisionSettings500ApplicationJSONObject` | [SetDecisionSettings500ApplicationJSON](../../models/operations/setdecisionsettings500applicationjson.md) | :heavy_minus_sign: | Something unexpected happened on the server. | \ No newline at end of file diff --git a/docs/models/operations/triggerpipelinedefaultapplicationjson.md b/docs/models/operations/triggerpipelinedefaultapplicationjson.md new file mode 100755 index 00000000..5837e7a1 --- /dev/null +++ b/docs/models/operations/triggerpipelinedefaultapplicationjson.md @@ -0,0 +1,10 @@ +# TriggerPipelineDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/triggerpipelinepipelinecreation.md b/docs/models/operations/triggerpipelinepipelinecreation.md new file mode 100755 index 00000000..04c3708a --- /dev/null +++ b/docs/models/operations/triggerpipelinepipelinecreation.md @@ -0,0 +1,13 @@ +# TriggerPipelinePipelineCreation + +A pipeline creation response. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the pipeline. | 5034460f-c7c4-4c43-9457-de07e2029e7b | +| `number` | *number* | :heavy_check_mark: | The number of the pipeline. | 25 | +| `state` | [TriggerPipelinePipelineCreationState](../../models/operations/triggerpipelinepipelinecreationstate.md) | :heavy_check_mark: | The current state of the pipeline. | | \ No newline at end of file diff --git a/docs/models/operations/triggerpipelinepipelinecreationstate.md b/docs/models/operations/triggerpipelinepipelinecreationstate.md new file mode 100755 index 00000000..414cf4cd --- /dev/null +++ b/docs/models/operations/triggerpipelinepipelinecreationstate.md @@ -0,0 +1,14 @@ +# TriggerPipelinePipelineCreationState + +The current state of the pipeline. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `Created` | created | +| `Errored` | errored | +| `SetupPending` | setup-pending | +| `Setup` | setup | +| `Pending` | pending | \ No newline at end of file diff --git a/docs/models/operations/triggerpipelinerequest.md b/docs/models/operations/triggerpipelinerequest.md new file mode 100755 index 00000000..8fc13f82 --- /dev/null +++ b/docs/models/operations/triggerpipelinerequest.md @@ -0,0 +1,9 @@ +# TriggerPipelineRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `requestBody` | [TriggerPipelineTriggerPipelineParameters](../../models/operations/triggerpipelinetriggerpipelineparameters.md) | :heavy_minus_sign: | N/A | +| `projectSlug` | *string* | :heavy_check_mark: | Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. | \ No newline at end of file diff --git a/docs/models/operations/triggerpipelineresponse.md b/docs/models/operations/triggerpipelineresponse.md new file mode 100755 index 00000000..a0b412db --- /dev/null +++ b/docs/models/operations/triggerpipelineresponse.md @@ -0,0 +1,12 @@ +# TriggerPipelineResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `pipelineCreation` | [TriggerPipelinePipelineCreation](../../models/operations/triggerpipelinepipelinecreation.md) | :heavy_minus_sign: | The created pipeline. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `triggerPipelineDefaultApplicationJSONObject` | [TriggerPipelineDefaultApplicationJSON](../../models/operations/triggerpipelinedefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/triggerpipelinetriggerpipelineparameters.md b/docs/models/operations/triggerpipelinetriggerpipelineparameters.md new file mode 100755 index 00000000..c488151c --- /dev/null +++ b/docs/models/operations/triggerpipelinetriggerpipelineparameters.md @@ -0,0 +1,12 @@ +# TriggerPipelineTriggerPipelineParameters + +The information you can supply when triggering a pipeline. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `branch` | *string* | :heavy_minus_sign: | The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. To trigger a pipeline for a PR by number use `pull//head` for the PR ref or `pull//merge` for the merge ref (GitHub only). | feature/design-new-api | +| `parameters` | Record | :heavy_minus_sign: | An object containing pipeline parameters and their values. | | +| `tag` | *string* | :heavy_minus_sign: | The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive. | v3.1.4159 | \ No newline at end of file diff --git a/docs/models/operations/updatescheduledefaultapplicationjson.md b/docs/models/operations/updatescheduledefaultapplicationjson.md new file mode 100755 index 00000000..77e03e13 --- /dev/null +++ b/docs/models/operations/updatescheduledefaultapplicationjson.md @@ -0,0 +1,10 @@ +# UpdateScheduleDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/updateschedulerequest.md b/docs/models/operations/updateschedulerequest.md new file mode 100755 index 00000000..161c1d4b --- /dev/null +++ b/docs/models/operations/updateschedulerequest.md @@ -0,0 +1,9 @@ +# UpdateScheduleRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `requestBody` | [UpdateScheduleUpdateScheduleParameters](../../models/operations/updatescheduleupdatescheduleparameters.md) | :heavy_minus_sign: | N/A | +| `scheduleId` | *string* | :heavy_check_mark: | The unique ID of the schedule. | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleresponse.md b/docs/models/operations/updatescheduleresponse.md new file mode 100755 index 00000000..7bef5118 --- /dev/null +++ b/docs/models/operations/updatescheduleresponse.md @@ -0,0 +1,12 @@ +# UpdateScheduleResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `schedule` | [UpdateScheduleSchedule](../../models/operations/updatescheduleschedule.md) | :heavy_minus_sign: | A schedule object. | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `updateScheduleDefaultApplicationJSONObject` | [UpdateScheduleDefaultApplicationJSON](../../models/operations/updatescheduledefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleschedule.md b/docs/models/operations/updatescheduleschedule.md new file mode 100755 index 00000000..36b0c13a --- /dev/null +++ b/docs/models/operations/updatescheduleschedule.md @@ -0,0 +1,18 @@ +# UpdateScheduleSchedule + +A schedule response + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `actor` | [UpdateScheduleScheduleUser](../../models/operations/updateschedulescheduleuser.md) | :heavy_check_mark: | The attribution actor who will run the scheduled pipeline. | | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was created. | | +| `description` | *string* | :heavy_check_mark: | Description of the schedule. | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the schedule. | | +| `name` | *string* | :heavy_check_mark: | Name of the schedule. | | +| `parameters` | Record | :heavy_check_mark: | Pipeline parameters represented as key-value pairs. Must contain branch or tag. | | +| `projectSlug` | *string* | :heavy_check_mark: | The project-slug for the schedule | gh/CircleCI-Public/api-preview-docs | +| `timetable` | *any* | :heavy_check_mark: | Timetable that specifies when a schedule triggers. | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the pipeline was last updated. | | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduletimetable1.md b/docs/models/operations/updateschedulescheduletimetable1.md new file mode 100755 index 00000000..41fac053 --- /dev/null +++ b/docs/models/operations/updateschedulescheduletimetable1.md @@ -0,0 +1,14 @@ +# UpdateScheduleScheduleTimetable1 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_minus_sign: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [UpdateScheduleScheduleTimetable1DaysOfWeek](../../models/operations/updateschedulescheduletimetable1daysofweek.md)[] | :heavy_check_mark: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [UpdateScheduleScheduleTimetable1Months](../../models/operations/updateschedulescheduletimetable1months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduletimetable1daysofweek.md b/docs/models/operations/updateschedulescheduletimetable1daysofweek.md new file mode 100755 index 00000000..0c52bd7a --- /dev/null +++ b/docs/models/operations/updateschedulescheduletimetable1daysofweek.md @@ -0,0 +1,16 @@ +# UpdateScheduleScheduleTimetable1DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduletimetable1months.md b/docs/models/operations/updateschedulescheduletimetable1months.md new file mode 100755 index 00000000..702fcf61 --- /dev/null +++ b/docs/models/operations/updateschedulescheduletimetable1months.md @@ -0,0 +1,21 @@ +# UpdateScheduleScheduleTimetable1Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduletimetable2.md b/docs/models/operations/updateschedulescheduletimetable2.md new file mode 100755 index 00000000..36733e9b --- /dev/null +++ b/docs/models/operations/updateschedulescheduletimetable2.md @@ -0,0 +1,14 @@ +# UpdateScheduleScheduleTimetable2 + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_check_mark: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [UpdateScheduleScheduleTimetable2DaysOfWeek](../../models/operations/updateschedulescheduletimetable2daysofweek.md)[] | :heavy_minus_sign: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_check_mark: | Hours in a day in which the schedule triggers. | +| `months` | [UpdateScheduleScheduleTimetable2Months](../../models/operations/updateschedulescheduletimetable2months.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_check_mark: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduletimetable2daysofweek.md b/docs/models/operations/updateschedulescheduletimetable2daysofweek.md new file mode 100755 index 00000000..bf76ad92 --- /dev/null +++ b/docs/models/operations/updateschedulescheduletimetable2daysofweek.md @@ -0,0 +1,16 @@ +# UpdateScheduleScheduleTimetable2DaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduletimetable2months.md b/docs/models/operations/updateschedulescheduletimetable2months.md new file mode 100755 index 00000000..4b7f0d5d --- /dev/null +++ b/docs/models/operations/updateschedulescheduletimetable2months.md @@ -0,0 +1,21 @@ +# UpdateScheduleScheduleTimetable2Months + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/updateschedulescheduleuser.md b/docs/models/operations/updateschedulescheduleuser.md new file mode 100755 index 00000000..75698d3a --- /dev/null +++ b/docs/models/operations/updateschedulescheduleuser.md @@ -0,0 +1,12 @@ +# UpdateScheduleScheduleUser + +The attribution actor who will run the scheduled pipeline. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique ID of the user. | +| `login` | *string* | :heavy_check_mark: | The login information for the user on the VCS. | +| `name` | *string* | :heavy_check_mark: | The name of the user. | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleupdatescheduleparameters.md b/docs/models/operations/updatescheduleupdatescheduleparameters.md new file mode 100755 index 00000000..1d3c8f06 --- /dev/null +++ b/docs/models/operations/updatescheduleupdatescheduleparameters.md @@ -0,0 +1,14 @@ +# UpdateScheduleUpdateScheduleParameters + +The parameters for an update schedule request + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributionActor` | [UpdateScheduleUpdateScheduleParametersAttributionActor](../../models/operations/updatescheduleupdatescheduleparametersattributionactor.md) | :heavy_minus_sign: | The attribution-actor of the scheduled pipeline. | current | +| `description` | *string* | :heavy_minus_sign: | Description of the schedule. | | +| `name` | *string* | :heavy_minus_sign: | Name of the schedule. | | +| `parameters` | Record | :heavy_minus_sign: | Pipeline parameters represented as key-value pairs. Must contain branch or tag. | | +| `timetable` | [UpdateScheduleUpdateScheduleParametersTimetable](../../models/operations/updatescheduleupdatescheduleparameterstimetable.md) | :heavy_minus_sign: | Timetable that specifies when a schedule triggers. | | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleupdatescheduleparametersattributionactor.md b/docs/models/operations/updatescheduleupdatescheduleparametersattributionactor.md new file mode 100755 index 00000000..30e068da --- /dev/null +++ b/docs/models/operations/updatescheduleupdatescheduleparametersattributionactor.md @@ -0,0 +1,11 @@ +# UpdateScheduleUpdateScheduleParametersAttributionActor + +The attribution-actor of the scheduled pipeline. + + +## Values + +| Name | Value | +| --------- | --------- | +| `Current` | current | +| `System` | system | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleupdatescheduleparameterstimetable.md b/docs/models/operations/updatescheduleupdatescheduleparameterstimetable.md new file mode 100755 index 00000000..ae6d61bf --- /dev/null +++ b/docs/models/operations/updatescheduleupdatescheduleparameterstimetable.md @@ -0,0 +1,14 @@ +# UpdateScheduleUpdateScheduleParametersTimetable + +Timetable that specifies when a schedule triggers. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daysOfMonth` | *number*[] | :heavy_minus_sign: | Days in a month in which the schedule triggers. This is mutually exclusive with days in a week. | +| `daysOfWeek` | [UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek](../../models/operations/updatescheduleupdatescheduleparameterstimetabledaysofweek.md)[] | :heavy_minus_sign: | Days in a week in which the schedule triggers. | +| `hoursOfDay` | *number*[] | :heavy_minus_sign: | Hours in a day in which the schedule triggers. | +| `months` | [UpdateScheduleUpdateScheduleParametersTimetableMonths](../../models/operations/updatescheduleupdatescheduleparameterstimetablemonths.md)[] | :heavy_minus_sign: | Months in which the schedule triggers. | +| `perHour` | *number* | :heavy_minus_sign: | Number of times a schedule triggers per hour, value must be between 1 and 60 | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleupdatescheduleparameterstimetabledaysofweek.md b/docs/models/operations/updatescheduleupdatescheduleparameterstimetabledaysofweek.md new file mode 100755 index 00000000..769c2961 --- /dev/null +++ b/docs/models/operations/updatescheduleupdatescheduleparameterstimetabledaysofweek.md @@ -0,0 +1,16 @@ +# UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek + +Day in a week, in three letters format + + +## Values + +| Name | Value | +| ----- | ----- | +| `Tue` | TUE | +| `Sat` | SAT | +| `Sun` | SUN | +| `Mon` | MON | +| `Thu` | THU | +| `Wed` | WED | +| `Fri` | FRI | \ No newline at end of file diff --git a/docs/models/operations/updatescheduleupdatescheduleparameterstimetablemonths.md b/docs/models/operations/updatescheduleupdatescheduleparameterstimetablemonths.md new file mode 100755 index 00000000..a2629357 --- /dev/null +++ b/docs/models/operations/updatescheduleupdatescheduleparameterstimetablemonths.md @@ -0,0 +1,21 @@ +# UpdateScheduleUpdateScheduleParametersTimetableMonths + +Month, in three letters format. + + +## Values + +| Name | Value | +| ----- | ----- | +| `Mar` | MAR | +| `Nov` | NOV | +| `Dec` | DEC | +| `Jun` | JUN | +| `May` | MAY | +| `Oct` | OCT | +| `Feb` | FEB | +| `Apr` | APR | +| `Sep` | SEP | +| `Aug` | AUG | +| `Jan` | JAN | +| `Jul` | JUL | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookdefaultapplicationjson.md b/docs/models/operations/updatewebhookdefaultapplicationjson.md new file mode 100755 index 00000000..ce5bafe0 --- /dev/null +++ b/docs/models/operations/updatewebhookdefaultapplicationjson.md @@ -0,0 +1,10 @@ +# UpdateWebhookDefaultApplicationJSON + +Error response. + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `message` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookrequest.md b/docs/models/operations/updatewebhookrequest.md new file mode 100755 index 00000000..2e2104c9 --- /dev/null +++ b/docs/models/operations/updatewebhookrequest.md @@ -0,0 +1,9 @@ +# UpdateWebhookRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `requestBody` | [UpdateWebhookRequestBody](../../models/operations/updatewebhookrequestbody.md) | :heavy_minus_sign: | N/A | +| `webhookId` | *string* | :heavy_check_mark: | ID of the webhook (UUID) | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookrequestbody.md b/docs/models/operations/updatewebhookrequestbody.md new file mode 100755 index 00000000..3c90dd51 --- /dev/null +++ b/docs/models/operations/updatewebhookrequestbody.md @@ -0,0 +1,14 @@ +# UpdateWebhookRequestBody + +The parameters for an update webhook request + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `events` | [UpdateWebhookRequestBodyEvents](../../models/operations/updatewebhookrequestbodyevents.md)[] | :heavy_minus_sign: | Events that will trigger the webhook | +| `name` | *string* | :heavy_minus_sign: | Name of the webhook | +| `signingSecret` | *string* | :heavy_minus_sign: | Secret used to build an HMAC hash of the payload and passed as a header in the webhook request | +| `url` | *string* | :heavy_minus_sign: | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) | +| `verifyTls` | *boolean* | :heavy_minus_sign: | Whether to enforce TLS certificate verification when delivering the webhook | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookrequestbodyevents.md b/docs/models/operations/updatewebhookrequestbodyevents.md new file mode 100755 index 00000000..44774204 --- /dev/null +++ b/docs/models/operations/updatewebhookrequestbodyevents.md @@ -0,0 +1,9 @@ +# UpdateWebhookRequestBodyEvents + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `WorkflowCompleted` | workflow-completed | +| `JobCompleted` | job-completed | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookresponse.md b/docs/models/operations/updatewebhookresponse.md new file mode 100755 index 00000000..4b50a07e --- /dev/null +++ b/docs/models/operations/updatewebhookresponse.md @@ -0,0 +1,12 @@ +# UpdateWebhookResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `webhook` | [UpdateWebhookWebhook](../../models/operations/updatewebhookwebhook.md) | :heavy_minus_sign: | A webhook | +| `updateWebhookDefaultApplicationJSONObject` | [UpdateWebhookDefaultApplicationJSON](../../models/operations/updatewebhookdefaultapplicationjson.md) | :heavy_minus_sign: | Error response. | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookwebhook.md b/docs/models/operations/updatewebhookwebhook.md new file mode 100755 index 00000000..decc0037 --- /dev/null +++ b/docs/models/operations/updatewebhookwebhook.md @@ -0,0 +1,18 @@ +# UpdateWebhookWebhook + +A webhook + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was created. | 2015-09-21T17:29:21.042Z | +| `events` | [UpdateWebhookWebhookEvents](../../models/operations/updatewebhookwebhookevents.md)[] | :heavy_check_mark: | Events that will trigger the webhook | | +| `id` | *string* | :heavy_check_mark: | The unique ID of the webhook | | +| `name` | *string* | :heavy_check_mark: | Name of the webhook | | +| `scope` | [UpdateWebhookWebhookScope](../../models/operations/updatewebhookwebhookscope.md) | :heavy_check_mark: | The scope in which the relevant events that will trigger webhooks | | +| `signingSecret` | *string* | :heavy_check_mark: | Masked value of the secret used to build an HMAC hash of the payload and passed as a header in the webhook request | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time the webhook was last updated. | 2015-09-21T17:29:21.042Z | +| `url` | *string* | :heavy_check_mark: | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) | | +| `verifyTls` | *boolean* | :heavy_check_mark: | Whether to enforce TLS certificate verification when delivering the webhook | | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookwebhookevents.md b/docs/models/operations/updatewebhookwebhookevents.md new file mode 100755 index 00000000..991c56c3 --- /dev/null +++ b/docs/models/operations/updatewebhookwebhookevents.md @@ -0,0 +1,9 @@ +# UpdateWebhookWebhookEvents + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `WorkflowCompleted` | workflow-completed | +| `JobCompleted` | job-completed | \ No newline at end of file diff --git a/docs/models/operations/updatewebhookwebhookscope.md b/docs/models/operations/updatewebhookwebhookscope.md new file mode 100755 index 00000000..3f1c400e --- /dev/null +++ b/docs/models/operations/updatewebhookwebhookscope.md @@ -0,0 +1,11 @@ +# UpdateWebhookWebhookScope + +The scope in which the relevant events that will trigger webhooks + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `id` | *string* | :heavy_check_mark: | ID of the scope being used (at the moment, only project ID is supported) | +| `type` | *string* | :heavy_check_mark: | Type of the scope being used | \ No newline at end of file diff --git a/docs/models/shared/bundlediff.md b/docs/models/shared/bundlediff.md new file mode 100755 index 00000000..0f8ae701 --- /dev/null +++ b/docs/models/shared/bundlediff.md @@ -0,0 +1,10 @@ +# BundleDiff + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `created` | *string*[] | :heavy_minus_sign: | N/A | +| `deleted` | *string*[] | :heavy_minus_sign: | N/A | +| `modified` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/bundlepayload.md b/docs/models/shared/bundlepayload.md new file mode 100755 index 00000000..b618a7a4 --- /dev/null +++ b/docs/models/shared/bundlepayload.md @@ -0,0 +1,8 @@ +# BundlePayload + + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `policies` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/claimresponse.md b/docs/models/shared/claimresponse.md new file mode 100755 index 00000000..6756eb55 --- /dev/null +++ b/docs/models/shared/claimresponse.md @@ -0,0 +1,13 @@ +# ClaimResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `audience` | *string*[] | :heavy_minus_sign: | N/A | +| `audienceUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | +| `orgId` | *string* | :heavy_check_mark: | N/A | +| `projectId` | *string* | :heavy_minus_sign: | N/A | +| `ttl` | *string* | :heavy_minus_sign: | N/A | +| `ttlUpdatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/decision.md b/docs/models/shared/decision.md new file mode 100755 index 00000000..7db24e2f --- /dev/null +++ b/docs/models/shared/decision.md @@ -0,0 +1,12 @@ +# Decision + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | +| `enabledRules` | *string*[] | :heavy_minus_sign: | N/A | +| `hardFailures` | [Violation](../../models/shared/violation.md)[] | :heavy_minus_sign: | N/A | +| `reason` | *string* | :heavy_minus_sign: | N/A | +| `softFailures` | [Violation](../../models/shared/violation.md)[] | :heavy_minus_sign: | N/A | +| `status` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/decisionlog.md b/docs/models/shared/decisionlog.md new file mode 100755 index 00000000..cc414b00 --- /dev/null +++ b/docs/models/shared/decisionlog.md @@ -0,0 +1,13 @@ +# DecisionLog + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | +| `decision` | [Decision](../../models/shared/decision.md) | :heavy_minus_sign: | N/A | +| `id` | *string* | :heavy_minus_sign: | N/A | +| `metadata` | [DecisionLogMetadata](../../models/shared/decisionlogmetadata.md) | :heavy_minus_sign: | N/A | +| `policies` | Record | :heavy_minus_sign: | policy-name-to-hash-map | +| `timeTakenMs` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/decisionlogmetadata.md b/docs/models/shared/decisionlogmetadata.md new file mode 100755 index 00000000..990c76a6 --- /dev/null +++ b/docs/models/shared/decisionlogmetadata.md @@ -0,0 +1,11 @@ +# DecisionLogMetadata + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `buildNumber` | *number* | :heavy_minus_sign: | N/A | +| `projectId` | *string* | :heavy_minus_sign: | N/A | +| `sshRerun` | *boolean* | :heavy_minus_sign: | N/A | +| `vcs` | [DecisionLogMetadataVcs](../../models/shared/decisionlogmetadatavcs.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/decisionlogmetadatavcs.md b/docs/models/shared/decisionlogmetadatavcs.md new file mode 100755 index 00000000..193d2cf6 --- /dev/null +++ b/docs/models/shared/decisionlogmetadatavcs.md @@ -0,0 +1,11 @@ +# DecisionLogMetadataVcs + + +## Fields + +| Field | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `branch` | *string* | :heavy_minus_sign: | N/A | +| `originRepositoryUrl` | *string* | :heavy_minus_sign: | N/A | +| `releaseTag` | *string* | :heavy_minus_sign: | N/A | +| `targetRepositoryUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/decisionsettings.md b/docs/models/shared/decisionsettings.md new file mode 100755 index 00000000..386c6fe8 --- /dev/null +++ b/docs/models/shared/decisionsettings.md @@ -0,0 +1,8 @@ +# DecisionSettings + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/patchclaimsrequest.md b/docs/models/shared/patchclaimsrequest.md new file mode 100755 index 00000000..7969588c --- /dev/null +++ b/docs/models/shared/patchclaimsrequest.md @@ -0,0 +1,9 @@ +# PatchClaimsRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `audience` | *string*[] | :heavy_minus_sign: | N/A | +| `ttl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/policy.md b/docs/models/shared/policy.md new file mode 100755 index 00000000..23c5fb98 --- /dev/null +++ b/docs/models/shared/policy.md @@ -0,0 +1,11 @@ +# Policy + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `content` | *string* | :heavy_minus_sign: | N/A | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | +| `createdBy` | *string* | :heavy_minus_sign: | N/A | +| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/schemebasicauth.md b/docs/models/shared/schemebasicauth.md new file mode 100755 index 00000000..16f33cf9 --- /dev/null +++ b/docs/models/shared/schemebasicauth.md @@ -0,0 +1,9 @@ +# SchemeBasicAuth + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `password` | *string* | :heavy_check_mark: | N/A | | +| `username` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/security.md b/docs/models/shared/security.md new file mode 100755 index 00000000..b1460a61 --- /dev/null +++ b/docs/models/shared/security.md @@ -0,0 +1,10 @@ +# Security + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `apiKeyHeader` | *string* | :heavy_minus_sign: | N/A | | +| `apiKeyQuery` | *string* | :heavy_minus_sign: | N/A | | +| `basicAuth` | [SchemeBasicAuth](../../models/shared/schemebasicauth.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/violation.md b/docs/models/shared/violation.md new file mode 100755 index 00000000..3074136d --- /dev/null +++ b/docs/models/shared/violation.md @@ -0,0 +1,9 @@ +# Violation + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `reason` | *string* | :heavy_check_mark: | N/A | +| `rule` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/oidctokenmanagement/README.md b/docs/oidctokenmanagement/README.md deleted file mode 100755 index 454f4de6..00000000 --- a/docs/oidctokenmanagement/README.md +++ /dev/null @@ -1,187 +0,0 @@ -# oidcTokenManagement - -## Overview - -Endpoints related to manage oidc identity tokens - -### Available Operations - -* [deleteOrgClaims](#deleteorgclaims) - Delete org-level claims -* [deleteProjectClaims](#deleteprojectclaims) - Delete project-level claims -* [getOrgClaims](#getorgclaims) - Get org-level claims -* [getProjectClaims](#getprojectclaims) - Get project-level claims -* [patchOrgClaims](#patchorgclaims) - Patch org-level claims -* [patchProjectClaims](#patchprojectclaims) - Patch project-level claims - -## deleteOrgClaims - -Deletes org-level custom claims of OIDC identity tokens - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.oidcTokenManagement.deleteOrgClaims({ - claims: "praesentium", - orgID: "921cddc6-9260-41fb-976b-0d5f0d30c5fb", -}).then((res: DeleteOrgClaimsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteProjectClaims - -Deletes project-level custom claims of OIDC identity tokens - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.oidcTokenManagement.deleteProjectClaims({ - claims: "nobis", - orgID: "25870532-02c7-43d5-be9b-90c28909b3fe", - projectID: "49a8d9cb-f486-4333-a3f9-b77f3a410067", -}).then((res: DeleteProjectClaimsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getOrgClaims - -Fetches org-level custom claims of OIDC identity tokens - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.oidcTokenManagement.getOrgClaims({ - orgID: "4ebf6928-0d1b-4a77-a89e-bf737ae4203c", -}).then((res: GetOrgClaimsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectClaims - -Fetches project-level custom claims of OIDC identity tokens - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.oidcTokenManagement.getProjectClaims({ - orgID: "e5e6a95d-8a0d-4446-8e2a-f7a73cf3be45", - projectID: "3f870b32-6b5a-4734-a9cd-b1a8422bb679", -}).then((res: GetProjectClaimsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## patchOrgClaims - -Creates/Updates org-level custom claims of OIDC identity tokens - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { PatchOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.oidcTokenManagement.patchOrgClaims({ - patchClaimsRequest: { - audience: [ - "qui", - "neque", - "fugit", - "magni", - ], - ttl: "odio", - }, - orgID: "15bf0cbb-1e31-4b8b-90f3-443a1108e0ad", -}).then((res: PatchOrgClaimsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## patchProjectClaims - -Creates/Updates project-level custom claims of OIDC identity tokens - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { PatchProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.oidcTokenManagement.patchProjectClaims({ - patchClaimsRequest: { - audience: [ - "doloribus", - "ut", - "facilis", - "cupiditate", - ], - ttl: "qui", - }, - orgID: "1879fce9-53f7-43ef-bfbc-7abd74dd39c0", - projectID: "f5d2cff7-c70a-4456-a6d4-36813f16d9f5", -}).then((res: PatchProjectClaimsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/pipeline/README.md b/docs/pipeline/README.md deleted file mode 100755 index f9e65c10..00000000 --- a/docs/pipeline/README.md +++ /dev/null @@ -1,289 +0,0 @@ -# pipeline - -### Available Operations - -* [continuePipeline](#continuepipeline) - Continue a pipeline -* [getPipelineById](#getpipelinebyid) - Get a pipeline by ID -* [getPipelineByNumber](#getpipelinebynumber) - Get a pipeline by pipeline number -* [getPipelineConfigById](#getpipelineconfigbyid) - Get a pipeline's configuration -* [listMyPipelines](#listmypipelines) - Get your pipelines -* [listPipelines](#listpipelines) - Get a list of pipelines -* [listPipelinesForProject](#listpipelinesforproject) - Get all pipelines -* [listWorkflowsByPipelineId](#listworkflowsbypipelineid) - Get a pipeline's workflows -* [triggerPipeline](#triggerpipeline) - Trigger a new pipeline - -## continuePipeline - -Continue a pipeline from the setup phase. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { ContinuePipelineResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.continuePipeline({ - configuration: "sapiente", - continuationKey: "quisquam", - parameters: { - "ea": "impedit", - "corporis": "veniam", - "aliquid": "inventore", - "magnam": "ea", - }, -}).then((res: ContinuePipelineResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getPipelineById - -Returns a pipeline by the pipeline ID. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - GetPipelineByIdPipelineErrorsType, - GetPipelineByIdPipelineState, - GetPipelineByIdPipelineTriggerType, - GetPipelineByIdResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.getPipelineById({ - pipelineId: "c3e250fb-008c-442e-941a-ac366c8dd6b1", -}).then((res: GetPipelineByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getPipelineByNumber - -Returns a pipeline by the pipeline number. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - GetPipelineByNumberPipelineErrorsType, - GetPipelineByNumberPipelineState, - GetPipelineByNumberPipelineTriggerType, - GetPipelineByNumberResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.getPipelineByNumber({ - pipelineNumber: "tempora", - projectSlug: "numquam", -}).then((res: GetPipelineByNumberResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getPipelineConfigById - -Returns a pipeline's configuration by ID. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetPipelineConfigByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.getPipelineConfigById({ - pipelineId: "29074747-78a7-4bd4-a6d2-8c10ab3cdca4", -}).then((res: GetPipelineConfigByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listMyPipelines - -Returns a sequence of all pipelines for this project triggered by the user. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - ListMyPipelinesPipelineListResponsePipelineErrorsType, - ListMyPipelinesPipelineListResponsePipelineState, - ListMyPipelinesPipelineListResponsePipelineTriggerType, - ListMyPipelinesResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.listMyPipelines({ - pageToken: "eos", - projectSlug: "voluptas", -}).then((res: ListMyPipelinesResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listPipelines - -Returns all pipelines for the most recently built projects (max 250) you follow in an organization. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - ListPipelinesPipelineListResponsePipelineErrorsType, - ListPipelinesPipelineListResponsePipelineState, - ListPipelinesPipelineListResponsePipelineTriggerType, - ListPipelinesResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.listPipelines({ - mine: false, - orgSlug: "ab", - pageToken: "cupiditate", -}).then((res: ListPipelinesResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listPipelinesForProject - -Returns all pipelines for this project. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - ListPipelinesForProjectPipelineListResponsePipelineErrorsType, - ListPipelinesForProjectPipelineListResponsePipelineState, - ListPipelinesForProjectPipelineListResponsePipelineTriggerType, - ListPipelinesForProjectResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.listPipelinesForProject({ - branch: "consequatur", - pageToken: "tempora", - projectSlug: "debitis", -}).then((res: ListPipelinesForProjectResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listWorkflowsByPipelineId - -Returns a paginated list of workflows by pipeline ID. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - ListWorkflowsByPipelineIdResponse, - ListWorkflowsByPipelineIdWorkflowListResponseWorkflowStatus, - ListWorkflowsByPipelineIdWorkflowListResponseWorkflowTag, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.listWorkflowsByPipelineId({ - pageToken: "ipsam", - pipelineId: "23c7e0bc-7178-4e47-96f2-a70c688282aa", -}).then((res: ListWorkflowsByPipelineIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## triggerPipeline - -Triggers a new pipeline on the project. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { TriggerPipelinePipelineCreationState, TriggerPipelineResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.pipeline.triggerPipeline({ - requestBody: { - branch: "feature/design-new-api", - parameters: { - "atque": "explicabo", - "minima": "nisi", - }, - tag: "v3.1.4159", - }, - projectSlug: "fugit", -}).then((res: TriggerPipelineResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/policymanagement/README.md b/docs/policymanagement/README.md deleted file mode 100755 index 5cc5050b..00000000 --- a/docs/policymanagement/README.md +++ /dev/null @@ -1,279 +0,0 @@ -# policyManagement - -## Overview - -Endpoints related to managing policies and making policy decisions - -### Available Operations - -* [createPolicyBundle](#createpolicybundle) - Creates policy bundle for the context -* [getDecisionLog](#getdecisionlog) - Retrieves the owner's decision audit log by given decisionID -* [getDecisionLogPolicyBundle](#getdecisionlogpolicybundle) - Retrieves Policy Bundle for a given decision log ID -* [getDecisionLogs](#getdecisionlogs) - Retrieves the owner's decision audit logs. -* [getDecisionSettings](#getdecisionsettings) - Get the decision settings -* [getPolicyBundle](#getpolicybundle) - Retrieves Policy Bundle -* [getPolicyDocument](#getpolicydocument) - Retrieves a policy document -* [makeDecision](#makedecision) - Makes a decision -* [setDecisionSettings](#setdecisionsettings) - Set the decision settings - -## createPolicyBundle - -This endpoint replaces the current policy bundle with the provided policy bundle - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { CreatePolicyBundleResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.createPolicyBundle({ - bundlePayload: { - policies: { - "consequuntur": "ratione", - "explicabo": "saepe", - "occaecati": "atque", - "et": "esse", - }, - }, - context: "eveniet", - dry: false, - ownerID: "accusamus", -}).then((res: CreatePolicyBundleResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getDecisionLog - -This endpoint will retrieve a decision for a given decision log ID - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetDecisionLogResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.getDecisionLog({ - context: "veritatis", - decisionID: "esse", - ownerID: "quod", -}).then((res: GetDecisionLogResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getDecisionLogPolicyBundle - -This endpoint will retrieve a policy bundle for a given decision log ID - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetDecisionLogPolicyBundleResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.getDecisionLogPolicyBundle({ - context: "nam", - decisionID: "vero", - ownerID: "aliquid", -}).then((res: GetDecisionLogPolicyBundleResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getDecisionLogs - -This endpoint will return a list of decision audit logs that were made using this owner's policies. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetDecisionLogsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.getDecisionLogs({ - after: new Date("2022-02-05T00:34:15.868Z"), - before: new Date("2022-04-24T03:22:50.654Z"), - branch: "molestiae", - context: "rerum", - offset: 580197, - ownerID: "minima", - projectId: "distinctio", - status: "eligendi", -}).then((res: GetDecisionLogsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getDecisionSettings - -This endpoint retrieves the current decision settings (eg enable/disable policy evaluation) - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetDecisionSettingsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.getDecisionSettings({ - context: "sit", - ownerID: "culpa", -}).then((res: GetDecisionSettingsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getPolicyBundle - -This endpoint will retrieve a policy bundle - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetPolicyBundleResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.getPolicyBundle({ - context: "tempore", - ownerID: "adipisci", -}).then((res: GetPolicyBundleResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getPolicyDocument - -This endpoint will retrieve a policy document. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetPolicyDocumentResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.getPolicyDocument({ - context: "cumque", - ownerID: "consequuntur", - policyName: "consequatur", -}).then((res: GetPolicyDocumentResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## makeDecision - -This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { MakeDecisionResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.makeDecision({ - requestBody: { - input: "minus", - metadata: { - "sapiente": "consectetur", - "esse": "blanditiis", - }, - }, - context: "provident", - ownerID: "a", -}).then((res: MakeDecisionResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## setDecisionSettings - -This endpoint allows modifying decision settings (eg enable/disable policy evaluation) - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { SetDecisionSettingsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.policyManagement.setDecisionSettings({ - decisionSettings: { - enabled: false, - }, - context: "nulla", - ownerID: "quas", -}).then((res: SetDecisionSettingsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/project/README.md b/docs/project/README.md deleted file mode 100755 index f1604cfd..00000000 --- a/docs/project/README.md +++ /dev/null @@ -1,256 +0,0 @@ -# project - -### Available Operations - -* [createCheckoutKey](#createcheckoutkey) - Create a new checkout key -* [createEnvVar](#createenvvar) - Create an environment variable -* [deleteCheckoutKey](#deletecheckoutkey) - Delete a checkout key -* [deleteEnvVar](#deleteenvvar) - Delete an environment variable -* [getCheckoutKey](#getcheckoutkey) - Get a checkout key -* [getEnvVar](#getenvvar) - Get a masked environment variable -* [getProjectBySlug](#getprojectbyslug) - Get a project -* [listCheckoutKeys](#listcheckoutkeys) - Get all checkout keys -* [listEnvVars](#listenvvars) - List all environment variables - -## createCheckoutKey - -Creates a new checkout key. This API request is only usable with a user API token. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - CreateCheckoutKeyCheckoutKeyCheckoutKeyType, - CreateCheckoutKeyCheckoutKeyInputCheckoutKeyInputType, - CreateCheckoutKeyResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.createCheckoutKey({ - requestBody: { - type: CreateCheckoutKeyCheckoutKeyInputCheckoutKeyInputType.DeployKey, - }, - projectSlug: "esse", -}).then((res: CreateCheckoutKeyResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## createEnvVar - -Creates a new environment variable. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { CreateEnvVarResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.createEnvVar({ - requestBody: { - name: "foo", - value: "xxxx1234", - }, - projectSlug: "quasi", -}).then((res: CreateEnvVarResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteCheckoutKey - -Deletes the checkout key. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteCheckoutKeyResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.deleteCheckoutKey({ - fingerprint: "a", - projectSlug: "error", -}).then((res: DeleteCheckoutKeyResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteEnvVar - -Deletes the environment variable named :name. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteEnvVarResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.deleteEnvVar({ - name: "Jody Schuster", - projectSlug: "asperiores", -}).then((res: DeleteEnvVarResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getCheckoutKey - -Returns an individual checkout key. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetCheckoutKeyCheckoutKeyCheckoutKeyType, GetCheckoutKeyResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.getCheckoutKey({ - fingerprint: "facere", - projectSlug: "veritatis", -}).then((res: GetCheckoutKeyResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getEnvVar - -Returns the masked value of environment variable :name. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetEnvVarResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.getEnvVar({ - name: "Ann Murphy", - projectSlug: "tenetur", -}).then((res: GetEnvVarResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getProjectBySlug - -Retrieves a project by project slug. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetProjectBySlugProjectVcsInfoProvider, GetProjectBySlugResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.getProjectBySlug({ - projectSlug: "quae", -}).then((res: GetProjectBySlugResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listCheckoutKeys - -Returns a sequence of checkout keys for `:project`. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - ListCheckoutKeysCheckoutKeyListResponseCheckoutKeyCheckoutKeyType, - ListCheckoutKeysResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.listCheckoutKeys({ - projectSlug: "earum", -}).then((res: ListCheckoutKeysResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listEnvVars - -Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { ListEnvVarsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.project.listEnvVars({ - projectSlug: "vel", -}).then((res: ListEnvVarsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/schedule/README.md b/docs/schedule/README.md deleted file mode 100755 index c810e8b0..00000000 --- a/docs/schedule/README.md +++ /dev/null @@ -1,205 +0,0 @@ -# schedule - -### Available Operations - -* [createSchedule](#createschedule) - Create a schedule -* [deleteScheduleById](#deleteschedulebyid) - Delete a schedule -* [getScheduleById](#getschedulebyid) - Get a schedule -* [listSchedulesForProject](#listschedulesforproject) - Get all schedules -* [updateSchedule](#updateschedule) - Update a schedule - -## createSchedule - -Creates a schedule and returns the created schedule. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - CreateScheduleCreateScheduleParametersAttributionActor, - CreateScheduleCreateScheduleParametersTimetable1DaysOfWeek, - CreateScheduleCreateScheduleParametersTimetable1Months, - CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek, - CreateScheduleCreateScheduleParametersTimetable2Months, - CreateScheduleResponse, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.schedule.createSchedule({ - requestBody: { - attributionActor: CreateScheduleCreateScheduleParametersAttributionActor.Current, - description: "in", - name: "Jeannette Stanton II", - parameters: { - "dicta": "ullam", - "reprehenderit": "ullam", - "nisi": "aut", - "voluptatum": "qui", - }, - timetable: { - daysOfMonth: [ - 536275, - 929292, - ], - daysOfWeek: [ - CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek.Tue, - CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek.Thu, - CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek.Fri, - ], - hoursOfDay: [ - 869489, - ], - months: [ - CreateScheduleCreateScheduleParametersTimetable2Months.Oct, - ], - perHour: 55965, - }, - }, - projectSlug: "minima", -}).then((res: CreateScheduleResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteScheduleById - -Deletes the schedule by id. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteScheduleByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.schedule.deleteScheduleById({ - scheduleId: "1339d080-86a1-4840-b94c-26071f93f5f0", -}).then((res: DeleteScheduleByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getScheduleById - -Get a schedule by id. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetScheduleByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.schedule.getScheduleById({ - scheduleId: "642dac7a-f515-4cc4-93aa-63aae8d67864", -}).then((res: GetScheduleByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listSchedulesForProject - -Returns all schedules for this project. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { ListSchedulesForProjectResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.schedule.listSchedulesForProject({ - pageToken: "possimus", - projectSlug: "facilis", -}).then((res: ListSchedulesForProjectResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## updateSchedule - -Updates a schedule and returns the updated schedule. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - UpdateScheduleResponse, - UpdateScheduleUpdateScheduleParametersAttributionActor, - UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek, - UpdateScheduleUpdateScheduleParametersTimetableMonths, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.schedule.updateSchedule({ - requestBody: { - attributionActor: UpdateScheduleUpdateScheduleParametersAttributionActor.Current, - description: "cum", - name: "Pearl Hessel", - parameters: { - "recusandae": "aliquid", - "aperiam": "cum", - }, - timetable: { - daysOfMonth: [ - 449083, - ], - daysOfWeek: [ - UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek.Fri, - UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek.Wed, - ], - hoursOfDay: [ - 985492, - 381760, - ], - months: [ - UpdateScheduleUpdateScheduleParametersTimetableMonths.Sep, - UpdateScheduleUpdateScheduleParametersTimetableMonths.Jan, - UpdateScheduleUpdateScheduleParametersTimetableMonths.Jan, - UpdateScheduleUpdateScheduleParametersTimetableMonths.Jun, - ], - perHour: 121059, - }, - }, - scheduleId: "f33317fe-35b6-40eb-9ea4-26555ba3c287", -}).then((res: UpdateScheduleResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/sdks/circleci/README.md b/docs/sdks/circleci/README.md new file mode 100755 index 00000000..41d16440 --- /dev/null +++ b/docs/sdks/circleci/README.md @@ -0,0 +1,9 @@ +# Circleci SDK + + +## Overview + +CircleCI API: This describes the resources that make up the CircleCI API v2. + +### Available Operations + diff --git a/docs/sdks/context/README.md b/docs/sdks/context/README.md new file mode 100755 index 00000000..732210ff --- /dev/null +++ b/docs/sdks/context/README.md @@ -0,0 +1,295 @@ +# Context +(*context*) + +### Available Operations + +* [addEnvironmentVariableToContext](#addenvironmentvariabletocontext) - Add or update an environment variable +* [createContext](#createcontext) - Create a new context +* [deleteContext](#deletecontext) - Delete a context +* [deleteEnvironmentVariableFromContext](#deleteenvironmentvariablefromcontext) - Remove an environment variable +* [getContext](#getcontext) - Get a context +* [listContexts](#listcontexts) - List contexts +* [listEnvironmentVariablesFromContext](#listenvironmentvariablesfromcontext) - List environment variables + +## addEnvironmentVariableToContext + +Create or update an environment variable within a context. Returns information about the environment variable, not including its value. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { AddEnvironmentVariableToContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.addEnvironmentVariableToContext({ + requestBody: { + value: "some-secret-value", + }, + contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96", + envVarName: "Pants reproachfully", +}).then((res: AddEnvironmentVariableToContextResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `request` | [operations.AddEnvironmentVariableToContextRequest](../../models/operations/addenvironmentvariabletocontextrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.AddEnvironmentVariableToContextResponse](../../models/operations/addenvironmentvariabletocontextresponse.md)>** + + +## createContext + +Create a new context + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { + CreateContextRequestBodyOwner1Type, + CreateContextRequestBodyOwner2Type, + CreateContextResponse, +} from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.createContext({ + name: "unsteady optical Administrator", + owner: { + id: "ff37ae73-d51a-4d1d-86e3-3428d8359669", + type: CreateContextRequestBodyOwner1Type.Organization, + }, +}).then((res: CreateContextResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.CreateContextRequestBody](../../models/operations/createcontextrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CreateContextResponse](../../models/operations/createcontextresponse.md)>** + + +## deleteContext + +Delete a context + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.deleteContext({ + contextId: "7e402047-2522-48a7-bbf0-da8a8f076c4a", +}).then((res: DeleteContextResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.DeleteContextRequest](../../models/operations/deletecontextrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteContextResponse](../../models/operations/deletecontextresponse.md)>** + + +## deleteEnvironmentVariableFromContext + +Delete an environment variable from a context. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteEnvironmentVariableFromContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.deleteEnvironmentVariableFromContext({ + contextId: "08279212-4ea7-49d9-b11a-c208b7a59267", + envVarName: "driver", +}).then((res: DeleteEnvironmentVariableFromContextResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `request` | [operations.DeleteEnvironmentVariableFromContextRequest](../../models/operations/deleteenvironmentvariablefromcontextrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteEnvironmentVariableFromContextResponse](../../models/operations/deleteenvironmentvariablefromcontextresponse.md)>** + + +## getContext + +Returns basic information about a context. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.getContext({ + contextId: "186cb1f2-7e39-4255-944f-1d226fb6d890", +}).then((res: GetContextResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `request` | [operations.GetContextRequest](../../models/operations/getcontextrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetContextResponse](../../models/operations/getcontextresponse.md)>** + + +## listContexts + +List all contexts for an owner. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListContextsOwnerType, ListContextsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.listContexts({ + ownerId: "51287e4e-8191-4eec-b08d-4eefb5da22d0", + ownerSlug: "Central", + ownerType: ListContextsOwnerType.Organization, + pageToken: "Fontana", +}).then((res: ListContextsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.ListContextsRequest](../../models/operations/listcontextsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListContextsResponse](../../models/operations/listcontextsresponse.md)>** + + +## listEnvironmentVariablesFromContext + +List information about environment variables in a context, not including their values. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListEnvironmentVariablesFromContextResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.context.listEnvironmentVariablesFromContext({ + contextId: "bd93f37e-8737-476a-be63-944592b835e7", + pageToken: "deliver male Convertible", +}).then((res: ListEnvironmentVariablesFromContextResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.ListEnvironmentVariablesFromContextRequest](../../models/operations/listenvironmentvariablesfromcontextrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListEnvironmentVariablesFromContextResponse](../../models/operations/listenvironmentvariablesfromcontextresponse.md)>** + diff --git a/docs/sdks/insights/README.md b/docs/sdks/insights/README.md new file mode 100755 index 00000000..13dfc1ed --- /dev/null +++ b/docs/sdks/insights/README.md @@ -0,0 +1,435 @@ +# Insights +(*insights*) + +### Available Operations + +* [getAllInsightsBranches](#getallinsightsbranches) - Get all branches for a project +* [getFlakyTests](#getflakytests) - Get flaky tests for a project +* [getJobTimeseries](#getjobtimeseries) - Job timeseries data +* [getOrgSummaryData](#getorgsummarydata) - Get summary metrics with trends for the entire org, and for each project. +* [getProjectWorkflowJobMetrics](#getprojectworkflowjobmetrics) - Get summary metrics for a project workflow's jobs. +* [getProjectWorkflowMetrics](#getprojectworkflowmetrics) - Get summary metrics for a project's workflows +* [getProjectWorkflowRuns](#getprojectworkflowruns) - Get recent runs of a workflow +* [getProjectWorkflowTestMetrics](#getprojectworkflowtestmetrics) - Get test metrics for a project's workflows +* [getProjectWorkflowsPageData](#getprojectworkflowspagedata) - Get summary metrics and trends for a project across it's workflows and branches +* [getWorkflowSummary](#getworkflowsummary) - Get metrics and trends for workflows + +## getAllInsightsBranches + +Get a list of all branches for a specified project. The list will only contain branches currently available within Insights. The maximum number of branches returned by this endpoint is 5,000. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetAllInsightsBranchesResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getAllInsightsBranches({ + projectSlug: "optimize fast", + workflowName: "Handmade", +}).then((res: GetAllInsightsBranchesResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetAllInsightsBranchesRequest](../../models/operations/getallinsightsbranchesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetAllInsightsBranchesResponse](../../models/operations/getallinsightsbranchesresponse.md)>** + + +## getFlakyTests + +Get a list of flaky tests for a given project. Flaky tests are branch agnostic. + A flaky test is a test that passed and failed in the same commit. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetFlakyTestsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getFlakyTests({ + projectSlug: "Non Diesel workforce", +}).then((res: GetFlakyTestsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.GetFlakyTestsRequest](../../models/operations/getflakytestsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetFlakyTestsResponse](../../models/operations/getflakytestsresponse.md)>** + + +## getJobTimeseries + +Get timeseries data for all jobs within a workflow. Hourly granularity data is only retained for 48 hours while daily granularity data is retained for 90 days. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetJobTimeseriesGranularity, GetJobTimeseriesResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getJobTimeseries({ + branch: "male", + endDate: new Date("2023-08-08T22:52:48.977Z"), + granularity: GetJobTimeseriesGranularity.Daily, + projectSlug: "HTTP", + startDate: new Date("2022-12-12T00:20:19.001Z"), + workflowName: "Northwest until extend", +}).then((res: GetJobTimeseriesResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `request` | [operations.GetJobTimeseriesRequest](../../models/operations/getjobtimeseriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetJobTimeseriesResponse](../../models/operations/getjobtimeseriesresponse.md)>** + + +## getOrgSummaryData + +Gets aggregated summary metrics with trends for the entire org. + Also gets aggregated metrics and trends for each project belonging to the org. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetOrgSummaryDataReportingWindow, GetOrgSummaryDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getOrgSummaryData({ + orgSlug: "Buckinghamshire", + projectNames: {}, + reportingWindow: GetOrgSummaryDataReportingWindow.Last90Days, +}).then((res: GetOrgSummaryDataResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.GetOrgSummaryDataRequest](../../models/operations/getorgsummarydatarequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetOrgSummaryDataResponse](../../models/operations/getorgsummarydataresponse.md)>** + + +## getProjectWorkflowJobMetrics + +Get summary metrics for a project workflow's jobs. Job runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { + GetProjectWorkflowJobMetricsReportingWindow, + GetProjectWorkflowJobMetricsResponse, +} from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getProjectWorkflowJobMetrics({ + allBranches: false, + branch: "female", + pageToken: "violet Parks", + projectSlug: "navigating", + reportingWindow: GetProjectWorkflowJobMetricsReportingWindow.Last60Days, + workflowName: "vaguely overlooked", +}).then((res: GetProjectWorkflowJobMetricsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetProjectWorkflowJobMetricsRequest](../../models/operations/getprojectworkflowjobmetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectWorkflowJobMetricsResponse](../../models/operations/getprojectworkflowjobmetricsresponse.md)>** + + +## getProjectWorkflowMetrics + +Get summary metrics for a project's workflows. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetProjectWorkflowMetricsReportingWindow, GetProjectWorkflowMetricsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getProjectWorkflowMetrics({ + allBranches: false, + branch: "Convertible mindshare deliverables", + pageToken: "so", + projectSlug: "Fresh", + reportingWindow: GetProjectWorkflowMetricsReportingWindow.Last7Days, +}).then((res: GetProjectWorkflowMetricsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetProjectWorkflowMetricsRequest](../../models/operations/getprojectworkflowmetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectWorkflowMetricsResponse](../../models/operations/getprojectworkflowmetricsresponse.md)>** + + +## getProjectWorkflowRuns + +Get recent runs of a workflow. Runs going back at most 90 days are returned. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetProjectWorkflowRunsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getProjectWorkflowRuns({ + allBranches: false, + branch: "Shoes", + endDate: new Date("2022-08-03T04:14:45.339Z"), + pageToken: "IP", + projectSlug: "channels till", + startDate: new Date("2022-03-17T08:38:16.828Z"), + workflowName: "systems Sports pariatur", +}).then((res: GetProjectWorkflowRunsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetProjectWorkflowRunsRequest](../../models/operations/getprojectworkflowrunsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectWorkflowRunsResponse](../../models/operations/getprojectworkflowrunsresponse.md)>** + + +## getProjectWorkflowTestMetrics + +Get test metrics for a project's workflows. Currently tests metrics are calculated based on 10 most recent workflow runs. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetProjectWorkflowTestMetricsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getProjectWorkflowTestMetrics({ + allBranches: false, + branch: "gold Chair Diesel", + projectSlug: "South maximize program", + workflowName: "Kids", +}).then((res: GetProjectWorkflowTestMetricsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.GetProjectWorkflowTestMetricsRequest](../../models/operations/getprojectworkflowtestmetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectWorkflowTestMetricsResponse](../../models/operations/getprojectworkflowtestmetricsresponse.md)>** + + +## getProjectWorkflowsPageData + +Get summary metrics and trends for a project at workflow and branch level. + Workflow runs going back at most 90 days are included in the aggregation window. + Trends are only supported upto last 30 days. + Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetProjectWorkflowsPageDataReportingWindow, GetProjectWorkflowsPageDataResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getProjectWorkflowsPageData({ + branches: {}, + projectSlug: "strategic Mouse cheap", + reportingWindow: GetProjectWorkflowsPageDataReportingWindow.Last90Days, + workflowNames: {}, +}).then((res: GetProjectWorkflowsPageDataResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetProjectWorkflowsPageDataRequest](../../models/operations/getprojectworkflowspagedatarequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectWorkflowsPageDataResponse](../../models/operations/getprojectworkflowspagedataresponse.md)>** + + +## getWorkflowSummary + +Get the metrics and trends for a particular workflow on a single branch or all branches + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetWorkflowSummaryResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.insights.getWorkflowSummary({ + allBranches: false, + branch: "Northwest atop", + projectSlug: "azure Southeast", + workflowName: "HTTP Northeast microchip", +}).then((res: GetWorkflowSummaryResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request` | [operations.GetWorkflowSummaryRequest](../../models/operations/getworkflowsummaryrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetWorkflowSummaryResponse](../../models/operations/getworkflowsummaryresponse.md)>** + diff --git a/docs/sdks/job/README.md b/docs/sdks/job/README.md new file mode 100755 index 00000000..0f143993 --- /dev/null +++ b/docs/sdks/job/README.md @@ -0,0 +1,165 @@ +# Job +(*job*) + +### Available Operations + +* [cancelJob](#canceljob) - Cancel job +* [getJobArtifacts](#getjobartifacts) - Get a job's artifacts +* [getJobDetails](#getjobdetails) - Get job details +* [getTests](#gettests) - Get test metadata + +## cancelJob + +Cancel job with a given job number. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { CancelJobResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.job.cancelJob({ + jobNumber: "Electric", + projectSlug: "West", +}).then((res: CancelJobResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `request` | [operations.CancelJobRequest](../../models/operations/canceljobrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CancelJobResponse](../../models/operations/canceljobresponse.md)>** + + +## getJobArtifacts + +Returns a job's artifacts. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetJobArtifactsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.job.getJobArtifacts({ + jobNumber: "generating", + projectSlug: "Markets", +}).then((res: GetJobArtifactsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.GetJobArtifactsRequest](../../models/operations/getjobartifactsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetJobArtifactsResponse](../../models/operations/getjobartifactsresponse.md)>** + + +## getJobDetails + +Returns job details. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetJobDetailsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.job.getJobDetails({ + jobNumber: "North", + projectSlug: "aggregate", +}).then((res: GetJobDetailsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.GetJobDetailsRequest](../../models/operations/getjobdetailsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetJobDetailsResponse](../../models/operations/getjobdetailsresponse.md)>** + + +## getTests + +Get test metadata for a build. In the rare case where there is more than 250MB of test data on the job, no results will be returned. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetTestsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.job.getTests({ + jobNumber: "eyeballs", + projectSlug: "Leone Account ASCII", +}).then((res: GetTestsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `request` | [operations.GetTestsRequest](../../models/operations/gettestsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetTestsResponse](../../models/operations/gettestsresponse.md)>** + diff --git a/docs/sdks/oidctokenmanagement/README.md b/docs/sdks/oidctokenmanagement/README.md new file mode 100755 index 00000000..81202175 --- /dev/null +++ b/docs/sdks/oidctokenmanagement/README.md @@ -0,0 +1,260 @@ +# OIDCTokenManagement +(*oidcTokenManagement*) + +## Overview + +Endpoints related to manage oidc identity tokens + +### Available Operations + +* [deleteOrgClaims](#deleteorgclaims) - Delete org-level claims +* [deleteProjectClaims](#deleteprojectclaims) - Delete project-level claims +* [getOrgClaims](#getorgclaims) - Get org-level claims +* [getProjectClaims](#getprojectclaims) - Get project-level claims +* [patchOrgClaims](#patchorgclaims) - Patch org-level claims +* [patchProjectClaims](#patchprojectclaims) - Patch project-level claims + +## deleteOrgClaims + +Deletes org-level custom claims of OIDC identity tokens + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.oidcTokenManagement.deleteOrgClaims({ + claims: "Loan Mini", + orgID: "21f3544d-2ca5-43d8-b02d-62f07cecddec", +}).then((res: DeleteOrgClaimsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.DeleteOrgClaimsRequest](../../models/operations/deleteorgclaimsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteOrgClaimsResponse](../../models/operations/deleteorgclaimsresponse.md)>** + + +## deleteProjectClaims + +Deletes project-level custom claims of OIDC identity tokens + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.oidcTokenManagement.deleteProjectClaims({ + claims: "different Bedfordshire", + orgID: "66e45c66-7d61-42f4-9793-f4014a8568d1", + projectID: "acf09ef1-b125-42a9-b672-e4182b2819bd", +}).then((res: DeleteProjectClaimsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `request` | [operations.DeleteProjectClaimsRequest](../../models/operations/deleteprojectclaimsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteProjectClaimsResponse](../../models/operations/deleteprojectclaimsresponse.md)>** + + +## getOrgClaims + +Fetches org-level custom claims of OIDC identity tokens + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.oidcTokenManagement.getOrgClaims({ + orgID: "faa87345-442f-4070-a007-ecf098342349", +}).then((res: GetOrgClaimsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.GetOrgClaimsRequest](../../models/operations/getorgclaimsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetOrgClaimsResponse](../../models/operations/getorgclaimsresponse.md)>** + + +## getProjectClaims + +Fetches project-level custom claims of OIDC identity tokens + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.oidcTokenManagement.getProjectClaims({ + orgID: "01345488-5416-440e-9811-7333cda41eee", + projectID: "17124405-51b9-4707-91e2-d3024606dad9", +}).then((res: GetProjectClaimsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `request` | [operations.GetProjectClaimsRequest](../../models/operations/getprojectclaimsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectClaimsResponse](../../models/operations/getprojectclaimsresponse.md)>** + + +## patchOrgClaims + +Creates/Updates org-level custom claims of OIDC identity tokens + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { PatchOrgClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.oidcTokenManagement.patchOrgClaims({ + patchClaimsRequest: { + audience: [ + "Cadmium", + ], + ttl: "North Iowa Steel", + }, + orgID: "8db81de9-39b2-4ebc-ba7e-f13a592ac772", +}).then((res: PatchOrgClaimsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.PatchOrgClaimsRequest](../../models/operations/patchorgclaimsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.PatchOrgClaimsResponse](../../models/operations/patchorgclaimsresponse.md)>** + + +## patchProjectClaims + +Creates/Updates project-level custom claims of OIDC identity tokens + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { PatchProjectClaimsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.oidcTokenManagement.patchProjectClaims({ + patchClaimsRequest: { + audience: [ + "Hybrid", + ], + ttl: "Moses South terrapin", + }, + orgID: "16f2ace9-e528-43bd-9197-32a9151836aa", + projectID: "863235ad-82ba-4634-8011-32a6f00f82fc", +}).then((res: PatchProjectClaimsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request` | [operations.PatchProjectClaimsRequest](../../models/operations/patchprojectclaimsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.PatchProjectClaimsResponse](../../models/operations/patchprojectclaimsresponse.md)>** + diff --git a/docs/sdks/pipeline/README.md b/docs/sdks/pipeline/README.md new file mode 100755 index 00000000..ec2d14c7 --- /dev/null +++ b/docs/sdks/pipeline/README.md @@ -0,0 +1,374 @@ +# Pipeline +(*pipeline*) + +### Available Operations + +* [continuePipeline](#continuepipeline) - Continue a pipeline +* [getPipelineById](#getpipelinebyid) - Get a pipeline by ID +* [getPipelineByNumber](#getpipelinebynumber) - Get a pipeline by pipeline number +* [getPipelineConfigById](#getpipelineconfigbyid) - Get a pipeline's configuration +* [listMyPipelines](#listmypipelines) - Get your pipelines +* [listPipelines](#listpipelines) - Get a list of pipelines +* [listPipelinesForProject](#listpipelinesforproject) - Get all pipelines +* [listWorkflowsByPipelineId](#listworkflowsbypipelineid) - Get a pipeline's workflows +* [triggerPipeline](#triggerpipeline) - Trigger a new pipeline + +## continuePipeline + +Continue a pipeline from the setup phase. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ContinuePipelineResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.continuePipeline({ + configuration: "pink Corporate Hayes", + continuationKey: "Upgradable Orchestrator", + parameters: { + "magnam": "Southwest", + }, +}).then((res: ContinuePipelineResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `request` | [operations.ContinuePipelineRequestBody](../../models/operations/continuepipelinerequestbody.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ContinuePipelineResponse](../../models/operations/continuepipelineresponse.md)>** + + +## getPipelineById + +Returns a pipeline by the pipeline ID. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetPipelineByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.getPipelineById({ + pipelineId: "dadb6d74-3d9d-42e4-8e5f-3f6f93bf148f", +}).then((res: GetPipelineByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.GetPipelineByIdRequest](../../models/operations/getpipelinebyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetPipelineByIdResponse](../../models/operations/getpipelinebyidresponse.md)>** + + +## getPipelineByNumber + +Returns a pipeline by the pipeline number. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetPipelineByNumberResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.getPipelineByNumber({ + pipelineNumber: "parsing", + projectSlug: "Table", +}).then((res: GetPipelineByNumberResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `request` | [operations.GetPipelineByNumberRequest](../../models/operations/getpipelinebynumberrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetPipelineByNumberResponse](../../models/operations/getpipelinebynumberresponse.md)>** + + +## getPipelineConfigById + +Returns a pipeline's configuration by ID. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetPipelineConfigByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.getPipelineConfigById({ + pipelineId: "98433987-e179-4ff4-b797-b27527d81606", +}).then((res: GetPipelineConfigByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetPipelineConfigByIdRequest](../../models/operations/getpipelineconfigbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetPipelineConfigByIdResponse](../../models/operations/getpipelineconfigbyidresponse.md)>** + + +## listMyPipelines + +Returns a sequence of all pipelines for this project triggered by the user. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListMyPipelinesResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.listMyPipelines({ + pageToken: "excess", + projectSlug: "Bacon", +}).then((res: ListMyPipelinesResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.ListMyPipelinesRequest](../../models/operations/listmypipelinesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListMyPipelinesResponse](../../models/operations/listmypipelinesresponse.md)>** + + +## listPipelines + +Returns all pipelines for the most recently built projects (max 250) you follow in an organization. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListPipelinesResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.listPipelines({ + mine: false, + orgSlug: "wireless transmitter", + pageToken: "Buckinghamshire Chicopee joule", +}).then((res: ListPipelinesResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.ListPipelinesRequest](../../models/operations/listpipelinesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListPipelinesResponse](../../models/operations/listpipelinesresponse.md)>** + + +## listPipelinesForProject + +Returns all pipelines for this project. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListPipelinesForProjectResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.listPipelinesForProject({ + branch: "Soap blue Cyclocross", + pageToken: "Bronze Stone", + projectSlug: "South Franc", +}).then((res: ListPipelinesForProjectResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `request` | [operations.ListPipelinesForProjectRequest](../../models/operations/listpipelinesforprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListPipelinesForProjectResponse](../../models/operations/listpipelinesforprojectresponse.md)>** + + +## listWorkflowsByPipelineId + +Returns a paginated list of workflows by pipeline ID. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListWorkflowsByPipelineIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.listWorkflowsByPipelineId({ + pageToken: "Texas amuse Technician", + pipelineId: "dcb87b7e-0fb0-4aa2-a8dd-26b59d8568fc", +}).then((res: ListWorkflowsByPipelineIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `request` | [operations.ListWorkflowsByPipelineIdRequest](../../models/operations/listworkflowsbypipelineidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListWorkflowsByPipelineIdResponse](../../models/operations/listworkflowsbypipelineidresponse.md)>** + + +## triggerPipeline + +Triggers a new pipeline on the project. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { TriggerPipelineResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.pipeline.triggerPipeline({ + requestBody: { + branch: "feature/design-new-api", + parameters: { + "minus": "La", + }, + tag: "v3.1.4159", + }, + projectSlug: "unde Ukraine Operative", +}).then((res: TriggerPipelineResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.TriggerPipelineRequest](../../models/operations/triggerpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.TriggerPipelineResponse](../../models/operations/triggerpipelineresponse.md)>** + diff --git a/docs/sdks/policymanagement/README.md b/docs/sdks/policymanagement/README.md new file mode 100755 index 00000000..ab457603 --- /dev/null +++ b/docs/sdks/policymanagement/README.md @@ -0,0 +1,392 @@ +# PolicyManagement +(*policyManagement*) + +## Overview + +Endpoints related to managing policies and making policy decisions + +### Available Operations + +* [createPolicyBundle](#createpolicybundle) - Creates policy bundle for the context +* [getDecisionLog](#getdecisionlog) - Retrieves the owner's decision audit log by given decisionID +* [getDecisionLogPolicyBundle](#getdecisionlogpolicybundle) - Retrieves Policy Bundle for a given decision log ID +* [getDecisionLogs](#getdecisionlogs) - Retrieves the owner's decision audit logs. +* [getDecisionSettings](#getdecisionsettings) - Get the decision settings +* [getPolicyBundle](#getpolicybundle) - Retrieves Policy Bundle +* [getPolicyDocument](#getpolicydocument) - Retrieves a policy document +* [makeDecision](#makedecision) - Makes a decision +* [setDecisionSettings](#setdecisionsettings) - Set the decision settings + +## createPolicyBundle + +This endpoint replaces the current policy bundle with the provided policy bundle + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { CreatePolicyBundleResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.createPolicyBundle({ + bundlePayload: { + policies: { + "voluptates": "Cruiser", + }, + }, + context: "out Stevie Reggae", + dry: false, + ownerID: "Diesel", +}).then((res: CreatePolicyBundleResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request` | [operations.CreatePolicyBundleRequest](../../models/operations/createpolicybundlerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CreatePolicyBundleResponse](../../models/operations/createpolicybundleresponse.md)>** + + +## getDecisionLog + +This endpoint will retrieve a decision for a given decision log ID + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetDecisionLogResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.getDecisionLog({ + context: "Web Account Wagon", + decisionID: "Berkshire Soft quisquam", + ownerID: "Branding", +}).then((res: GetDecisionLogResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.GetDecisionLogRequest](../../models/operations/getdecisionlogrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetDecisionLogResponse](../../models/operations/getdecisionlogresponse.md)>** + + +## getDecisionLogPolicyBundle + +This endpoint will retrieve a policy bundle for a given decision log ID + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetDecisionLogPolicyBundleResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.getDecisionLogPolicyBundle({ + context: "but Bhutanese vertical", + decisionID: "South Organic", + ownerID: "North Northeast Glenview", +}).then((res: GetDecisionLogPolicyBundleResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.GetDecisionLogPolicyBundleRequest](../../models/operations/getdecisionlogpolicybundlerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetDecisionLogPolicyBundleResponse](../../models/operations/getdecisionlogpolicybundleresponse.md)>** + + +## getDecisionLogs + +This endpoint will return a list of decision audit logs that were made using this owner's policies. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetDecisionLogsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.getDecisionLogs({ + after: new Date("2021-08-18T01:39:23.459Z"), + before: new Date("2022-06-06T09:41:55.748Z"), + branch: "maximize Georgia Woman", + buildNumber: "East Salad eardrum", + context: "systems payment overriding", + offset: 922666, + ownerID: "Practical Ways", + projectId: "female Northeast", + status: "capacitor Account City", +}).then((res: GetDecisionLogsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.GetDecisionLogsRequest](../../models/operations/getdecisionlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetDecisionLogsResponse](../../models/operations/getdecisionlogsresponse.md)>** + + +## getDecisionSettings + +This endpoint retrieves the current decision settings (eg enable/disable policy evaluation) + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetDecisionSettingsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.getDecisionSettings({ + context: "West application", + ownerID: "pitching Account", +}).then((res: GetDecisionSettingsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `request` | [operations.GetDecisionSettingsRequest](../../models/operations/getdecisionsettingsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetDecisionSettingsResponse](../../models/operations/getdecisionsettingsresponse.md)>** + + +## getPolicyBundle + +This endpoint will retrieve a policy bundle + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetPolicyBundleResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.getPolicyBundle({ + context: "South", + ownerID: "Kia Mountain Inverse", +}).then((res: GetPolicyBundleResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.GetPolicyBundleRequest](../../models/operations/getpolicybundlerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetPolicyBundleResponse](../../models/operations/getpolicybundleresponse.md)>** + + +## getPolicyDocument + +This endpoint will retrieve a policy document. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetPolicyDocumentResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.getPolicyDocument({ + context: "Dinar PNG", + ownerID: "Idaho mmm", + policyName: "Officer Wooden Facilitator", +}).then((res: GetPolicyDocumentResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.GetPolicyDocumentRequest](../../models/operations/getpolicydocumentrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetPolicyDocumentResponse](../../models/operations/getpolicydocumentresponse.md)>** + + +## makeDecision + +This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { MakeDecisionResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.makeDecision({ + requestBody: { + input: "Southwest enthusiastically", + metadata: {}, + }, + context: "killer", + ownerID: "East volt array", +}).then((res: MakeDecisionResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.MakeDecisionRequest](../../models/operations/makedecisionrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.MakeDecisionResponse](../../models/operations/makedecisionresponse.md)>** + + +## setDecisionSettings + +This endpoint allows modifying decision settings (eg enable/disable policy evaluation) + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { SetDecisionSettingsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.policyManagement.setDecisionSettings({ + decisionSettings: { + enabled: false, + }, + context: "tan Managed", + ownerID: "Agender", +}).then((res: SetDecisionSettingsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `request` | [operations.SetDecisionSettingsRequest](../../models/operations/setdecisionsettingsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.SetDecisionSettingsResponse](../../models/operations/setdecisionsettingsresponse.md)>** + diff --git a/docs/sdks/project/README.md b/docs/sdks/project/README.md new file mode 100755 index 00000000..c86ef31e --- /dev/null +++ b/docs/sdks/project/README.md @@ -0,0 +1,367 @@ +# Project +(*project*) + +### Available Operations + +* [createCheckoutKey](#createcheckoutkey) - Create a new checkout key +* [createEnvVar](#createenvvar) - Create an environment variable +* [deleteCheckoutKey](#deletecheckoutkey) - Delete a checkout key +* [deleteEnvVar](#deleteenvvar) - Delete an environment variable +* [getCheckoutKey](#getcheckoutkey) - Get a checkout key +* [getEnvVar](#getenvvar) - Get a masked environment variable +* [getProjectBySlug](#getprojectbyslug) - Get a project +* [listCheckoutKeys](#listcheckoutkeys) - Get all checkout keys +* [listEnvVars](#listenvvars) - List all environment variables + +## createCheckoutKey + +Creates a new checkout key. This API request is only usable with a user API token. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { CreateCheckoutKeyCheckoutKeyInputCheckoutKeyInputType, CreateCheckoutKeyResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.createCheckoutKey({ + requestBody: { + type: CreateCheckoutKeyCheckoutKeyInputCheckoutKeyInputType.DeployKey, + }, + projectSlug: "payment grow", +}).then((res: CreateCheckoutKeyResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.CreateCheckoutKeyRequest](../../models/operations/createcheckoutkeyrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CreateCheckoutKeyResponse](../../models/operations/createcheckoutkeyresponse.md)>** + + +## createEnvVar + +Creates a new environment variable. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { CreateEnvVarResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.createEnvVar({ + requestBody: { + name: "foo", + value: "xxxx1234", + }, + projectSlug: "Alaska", +}).then((res: CreateEnvVarResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.CreateEnvVarRequest](../../models/operations/createenvvarrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CreateEnvVarResponse](../../models/operations/createenvvarresponse.md)>** + + +## deleteCheckoutKey + +Deletes the checkout key. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteCheckoutKeyResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.deleteCheckoutKey({ + fingerprint: "Wooden since", + projectSlug: "Configuration", +}).then((res: DeleteCheckoutKeyResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.DeleteCheckoutKeyRequest](../../models/operations/deletecheckoutkeyrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteCheckoutKeyResponse](../../models/operations/deletecheckoutkeyresponse.md)>** + + +## deleteEnvVar + +Deletes the environment variable named :name. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteEnvVarResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.deleteEnvVar({ + name: "Terbium Soap Volkswagen", + projectSlug: "Convertible Omnigender Fish", +}).then((res: DeleteEnvVarResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.DeleteEnvVarRequest](../../models/operations/deleteenvvarrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteEnvVarResponse](../../models/operations/deleteenvvarresponse.md)>** + + +## getCheckoutKey + +Returns an individual checkout key. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetCheckoutKeyResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.getCheckoutKey({ + fingerprint: "Guernsey", + projectSlug: "extend compressing", +}).then((res: GetCheckoutKeyResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.GetCheckoutKeyRequest](../../models/operations/getcheckoutkeyrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetCheckoutKeyResponse](../../models/operations/getcheckoutkeyresponse.md)>** + + +## getEnvVar + +Returns the masked value of environment variable :name. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetEnvVarResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.getEnvVar({ + name: "pascal", + projectSlug: "Metrics Engineer", +}).then((res: GetEnvVarResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `request` | [operations.GetEnvVarRequest](../../models/operations/getenvvarrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetEnvVarResponse](../../models/operations/getenvvarresponse.md)>** + + +## getProjectBySlug + +Retrieves a project by project slug. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetProjectBySlugResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.getProjectBySlug({ + projectSlug: "reboot", +}).then((res: GetProjectBySlugResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `request` | [operations.GetProjectBySlugRequest](../../models/operations/getprojectbyslugrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetProjectBySlugResponse](../../models/operations/getprojectbyslugresponse.md)>** + + +## listCheckoutKeys + +Returns a sequence of checkout keys for `:project`. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListCheckoutKeysResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.listCheckoutKeys({ + projectSlug: "Pataca", +}).then((res: ListCheckoutKeysResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `request` | [operations.ListCheckoutKeysRequest](../../models/operations/listcheckoutkeysrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListCheckoutKeysResponse](../../models/operations/listcheckoutkeysresponse.md)>** + + +## listEnvVars + +Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListEnvVarsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.project.listEnvVars({ + projectSlug: "Southeast Books Austin", +}).then((res: ListEnvVarsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `request` | [operations.ListEnvVarsRequest](../../models/operations/listenvvarsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListEnvVarsResponse](../../models/operations/listenvvarsresponse.md)>** + diff --git a/docs/sdks/schedule/README.md b/docs/sdks/schedule/README.md new file mode 100755 index 00000000..ceae7a3d --- /dev/null +++ b/docs/sdks/schedule/README.md @@ -0,0 +1,259 @@ +# Schedule +(*schedule*) + +### Available Operations + +* [createSchedule](#createschedule) - Create a schedule +* [deleteScheduleById](#deleteschedulebyid) - Delete a schedule +* [getScheduleById](#getschedulebyid) - Get a schedule +* [listSchedulesForProject](#listschedulesforproject) - Get all schedules +* [updateSchedule](#updateschedule) - Update a schedule + +## createSchedule + +Creates a schedule and returns the created schedule. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { + CreateScheduleCreateScheduleParametersAttributionActor, + CreateScheduleCreateScheduleParametersTimetable1DaysOfWeek, + CreateScheduleCreateScheduleParametersTimetable1Months, + CreateScheduleCreateScheduleParametersTimetable2DaysOfWeek, + CreateScheduleCreateScheduleParametersTimetable2Months, + CreateScheduleResponse, +} from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.schedule.createSchedule({ + requestBody: { + attributionActor: CreateScheduleCreateScheduleParametersAttributionActor.Current, + description: "Reactive actuating knowledge user", + name: "fuchsia SMTP Agent", + parameters: { + "ipsam": "animi", + }, + timetable: { + daysOfMonth: [ + 608569, + ], + daysOfWeek: [ + CreateScheduleCreateScheduleParametersTimetable1DaysOfWeek.Thu, + ], + hoursOfDay: [ + 20568, + ], + months: [ + CreateScheduleCreateScheduleParametersTimetable1Months.May, + ], + perHour: 950659, + }, + }, + projectSlug: "National copying", +}).then((res: CreateScheduleResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.CreateScheduleRequest](../../models/operations/createschedulerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CreateScheduleResponse](../../models/operations/createscheduleresponse.md)>** + + +## deleteScheduleById + +Deletes the schedule by id. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteScheduleByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.schedule.deleteScheduleById({ + scheduleId: "d61435f8-c8fd-4d1b-8e96-b194177e1b46", +}).then((res: DeleteScheduleByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request` | [operations.DeleteScheduleByIdRequest](../../models/operations/deleteschedulebyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteScheduleByIdResponse](../../models/operations/deleteschedulebyidresponse.md)>** + + +## getScheduleById + +Get a schedule by id. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetScheduleByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.schedule.getScheduleById({ + scheduleId: "89f339bb-2346-462d-b60a-cb48dec1fc3b", +}).then((res: GetScheduleByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.GetScheduleByIdRequest](../../models/operations/getschedulebyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetScheduleByIdResponse](../../models/operations/getschedulebyidresponse.md)>** + + +## listSchedulesForProject + +Returns all schedules for this project. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListSchedulesForProjectResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.schedule.listSchedulesForProject({ + pageToken: "Missouri southeast transparent", + projectSlug: "array", +}).then((res: ListSchedulesForProjectResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `request` | [operations.ListSchedulesForProjectRequest](../../models/operations/listschedulesforprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListSchedulesForProjectResponse](../../models/operations/listschedulesforprojectresponse.md)>** + + +## updateSchedule + +Updates a schedule and returns the updated schedule. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { + UpdateScheduleResponse, + UpdateScheduleUpdateScheduleParametersAttributionActor, + UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek, + UpdateScheduleUpdateScheduleParametersTimetableMonths, +} from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.schedule.updateSchedule({ + requestBody: { + attributionActor: UpdateScheduleUpdateScheduleParametersAttributionActor.Current, + description: "Managed secondary knowledge base", + name: "Northwest instead Alto", + parameters: { + "ducimus": "kindly", + }, + timetable: { + daysOfMonth: [ + 296760, + ], + daysOfWeek: [ + UpdateScheduleUpdateScheduleParametersTimetableDaysOfWeek.Tue, + ], + hoursOfDay: [ + 582612, + ], + months: [ + UpdateScheduleUpdateScheduleParametersTimetableMonths.Jun, + ], + perHour: 842366, + }, + }, + scheduleId: "3e9ab9ea-99c1-4416-a521-017015725a23", +}).then((res: UpdateScheduleResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.UpdateScheduleRequest](../../models/operations/updateschedulerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.UpdateScheduleResponse](../../models/operations/updatescheduleresponse.md)>** + diff --git a/docs/sdks/user/README.md b/docs/sdks/user/README.md new file mode 100755 index 00000000..a53eee1a --- /dev/null +++ b/docs/sdks/user/README.md @@ -0,0 +1,122 @@ +# User +(*user*) + +### Available Operations + +* [getCollaborations](#getcollaborations) - Collaborations +* [getCurrentUser](#getcurrentuser) - User Information +* [getUser](#getuser) - User Information + +## getCollaborations + +Provides the set of organizations of which a user is a member or a collaborator. + +The set of organizations that a user can collaborate on is composed of: + +* Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) +* The parent organization of repository that the user can collaborate on, but is not necessarily a member of +* The organization of the current user's account + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetCollaborationsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.user.getCollaborations().then((res: GetCollaborationsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetCollaborationsResponse](../../models/operations/getcollaborationsresponse.md)>** + + +## getCurrentUser + +Provides information about the user that is currently signed in. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetCurrentUserResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.user.getCurrentUser().then((res: GetCurrentUserResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetCurrentUserResponse](../../models/operations/getcurrentuserresponse.md)>** + + +## getUser + +Provides information about the user with the given ID. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetUserResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.user.getUser({ + id: "bf29e4e9-96b2-49f6-8980-3bb87b43bd7e", +}).then((res: GetUserResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `request` | [operations.GetUserRequest](../../models/operations/getuserrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetUserResponse](../../models/operations/getuserresponse.md)>** + diff --git a/docs/sdks/webhook/README.md b/docs/sdks/webhook/README.md new file mode 100755 index 00000000..6ba3a3c4 --- /dev/null +++ b/docs/sdks/webhook/README.md @@ -0,0 +1,224 @@ +# Webhook +(*webhook*) + +### Available Operations + +* [createWebhook](#createwebhook) - Create a webhook +* [deleteWebhook](#deletewebhook) - Delete a webhook +* [getWebhookById](#getwebhookbyid) - Get a webhook +* [getWebhooks](#getwebhooks) - List webhooks +* [updateWebhook](#updatewebhook) - Update a webhook + +## createWebhook + +Create a webhook + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { + CreateWebhookRequestBodyEvents, + CreateWebhookRequestBodyScopeType, + CreateWebhookResponse, +} from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.webhook.createWebhook({ + events: [ + CreateWebhookRequestBodyEvents.JobCompleted, + ], + name: "like garage Fresh", + scope: { + id: "3b7d2240-08ac-44c5-9d30-daac81ad9fab", + type: CreateWebhookRequestBodyScopeType.Project, + }, + signingSecret: "navigate outside", + url: "http://old-adapter.info", + verifyTls: false, +}).then((res: CreateWebhookResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.CreateWebhookRequestBody](../../models/operations/createwebhookrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CreateWebhookResponse](../../models/operations/createwebhookresponse.md)>** + + +## deleteWebhook + +Delete a webhook + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { DeleteWebhookResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.webhook.deleteWebhook({ + webhookId: "90ed7052-6bb0-4b60-93ab-e4433ee4e2bb", +}).then((res: DeleteWebhookResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.DeleteWebhookRequest](../../models/operations/deletewebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.DeleteWebhookResponse](../../models/operations/deletewebhookresponse.md)>** + + +## getWebhookById + +Get a webhook by id. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetWebhookByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.webhook.getWebhookById({ + webhookId: "48f47148-587e-42d6-8c80-5b1461e57de9", +}).then((res: GetWebhookByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.GetWebhookByIdRequest](../../models/operations/getwebhookbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetWebhookByIdResponse](../../models/operations/getwebhookbyidresponse.md)>** + + +## getWebhooks + +Get a list of webhook that match the given scope-type and scope-id + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetWebhooksResponse, GetWebhooksScopeType } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.webhook.getWebhooks({ + scopeId: "14ccf55a-42ac-416c-bacd-a992e8b59ec0", + scopeType: GetWebhooksScopeType.Project, +}).then((res: GetWebhooksResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `request` | [operations.GetWebhooksRequest](../../models/operations/getwebhooksrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetWebhooksResponse](../../models/operations/getwebhooksresponse.md)>** + + +## updateWebhook + +Update a webhook + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { UpdateWebhookRequestBodyEvents, UpdateWebhookResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.webhook.updateWebhook({ + requestBody: { + events: [ + UpdateWebhookRequestBodyEvents.JobCompleted, + ], + name: "Cruiser platforms", + signingSecret: "synthesize", + url: "http://pricey-sorghum.biz", + verifyTls: false, + }, + webhookId: "36100ab1-98d2-4970-b889-dc7808cca31d", +}).then((res: UpdateWebhookResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.UpdateWebhookRequest](../../models/operations/updatewebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.UpdateWebhookResponse](../../models/operations/updatewebhookresponse.md)>** + diff --git a/docs/sdks/workflow/README.md b/docs/sdks/workflow/README.md new file mode 100755 index 00000000..8376a919 --- /dev/null +++ b/docs/sdks/workflow/README.md @@ -0,0 +1,209 @@ +# Workflow +(*workflow*) + +### Available Operations + +* [approvePendingApprovalJobById](#approvependingapprovaljobbyid) - Approve a job +* [cancelWorkflow](#cancelworkflow) - Cancel a workflow +* [getWorkflowById](#getworkflowbyid) - Get a workflow +* [listWorkflowJobs](#listworkflowjobs) - Get a workflow's jobs +* [rerunWorkflow](#rerunworkflow) - Rerun a workflow + +## approvePendingApprovalJobById + +Approves a pending approval job in a workflow. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ApprovePendingApprovalJobByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.workflow.approvePendingApprovalJobById({ + approvalRequestId: "afd4e8a2-73f4-4706-8fed-d209a62dd146", + id: "e96a2274-8cfb-42ea-a2f3-af572e6d17e2", +}).then((res: ApprovePendingApprovalJobByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.ApprovePendingApprovalJobByIdRequest](../../models/operations/approvependingapprovaljobbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ApprovePendingApprovalJobByIdResponse](../../models/operations/approvependingapprovaljobbyidresponse.md)>** + + +## cancelWorkflow + +Cancels a running workflow. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { CancelWorkflowResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.workflow.cancelWorkflow({ + id: "bd1cc4a6-2f45-4453-98c5-6f84c2afb654", +}).then((res: CancelWorkflowResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.CancelWorkflowRequest](../../models/operations/cancelworkflowrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.CancelWorkflowResponse](../../models/operations/cancelworkflowresponse.md)>** + + +## getWorkflowById + +Returns summary fields of a workflow by ID. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { GetWorkflowByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.workflow.getWorkflowById({ + id: "9471ae6d-5ba0-4e9c-bb5d-c99815c6257a", +}).then((res: GetWorkflowByIdResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.GetWorkflowByIdRequest](../../models/operations/getworkflowbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.GetWorkflowByIdResponse](../../models/operations/getworkflowbyidresponse.md)>** + + +## listWorkflowJobs + +Returns a sequence of jobs for a workflow. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { ListWorkflowJobsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.workflow.listWorkflowJobs({ + id: "d4ad492c-ef34-47c2-a4b5-e4d0fd15ab40", +}).then((res: ListWorkflowJobsResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `request` | [operations.ListWorkflowJobsRequest](../../models/operations/listworkflowjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.ListWorkflowJobsResponse](../../models/operations/listworkflowjobsresponse.md)>** + + +## rerunWorkflow + +Reruns a workflow. + +### Example Usage + +```typescript +import { Circleci } from "circleci-v2-sdk"; +import { RerunWorkflowResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; + +const sdk = new Circleci({ + security: { + apiKeyHeader: "", + }, +}); + +sdk.workflow.rerunWorkflow({ + requestBody: { + enableSsh: false, + fromFailed: false, + jobs: [ + "0038409e-102a-4ccf-8dd8-307fb89c2413", + ], + sparseTree: false, + }, + id: "3655b08f-16ad-40ff-95a5-30abd7443f6e", +}).then((res: RerunWorkflowResponse) => { + if (res.statusCode == 200) { + // handle response + } +}); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.RerunWorkflowRequest](../../models/operations/rerunworkflowrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | + + +### Response + +**Promise<[operations.RerunWorkflowResponse](../../models/operations/rerunworkflowresponse.md)>** + diff --git a/docs/user/README.md b/docs/user/README.md deleted file mode 100755 index 45223ef8..00000000 --- a/docs/user/README.md +++ /dev/null @@ -1,84 +0,0 @@ -# user - -### Available Operations - -* [getCollaborations](#getcollaborations) - Collaborations -* [getCurrentUser](#getcurrentuser) - User Information -* [getUser](#getuser) - User Information - -## getCollaborations - -Provides the set of organizations of which a user is a member or a collaborator. - -The set of organizations that a user can collaborate on is composed of: - -* Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) -* The parent organization of repository that the user can collaborate on, but is not necessarily a member of -* The organization of the current user's account - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetCollaborationsResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.user.getCollaborations().then((res: GetCollaborationsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getCurrentUser - -Provides information about the user that is currently signed in. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetCurrentUserResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.user.getCurrentUser().then((res: GetCurrentUserResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getUser - -Provides information about the user with the given ID. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetUserResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.user.getUser({ - id: "44ed53b8-8f3a-48d8-b5c0-b2f2fb7b194a", -}).then((res: GetUserResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/webhook/README.md b/docs/webhook/README.md deleted file mode 100755 index 5402f5d1..00000000 --- a/docs/webhook/README.md +++ /dev/null @@ -1,169 +0,0 @@ -# webhook - -### Available Operations - -* [createWebhook](#createwebhook) - Create a webhook -* [deleteWebhook](#deletewebhook) - Delete a webhook -* [getWebhookById](#getwebhookbyid) - Get a webhook -* [getWebhooks](#getwebhooks) - List webhooks -* [updateWebhook](#updatewebhook) - Update a webhook - -## createWebhook - -Create a webhook - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - CreateWebhookRequestBodyEvents, - CreateWebhookRequestBodyScopeType, - CreateWebhookResponse, - CreateWebhookWebhookEvents, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.webhook.createWebhook({ - events: [ - CreateWebhookRequestBodyEvents.WorkflowCompleted, - ], - name: "Melody Cole", - scope: { - id: "16fe1f08-f429-44e3-a98f-447f603e8b44", - type: CreateWebhookRequestBodyScopeType.Project, - }, - signingSecret: "ipsam", - url: "debitis", - verifyTls: false, -}).then((res: CreateWebhookResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## deleteWebhook - -Delete a webhook - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { DeleteWebhookResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.webhook.deleteWebhook({ - webhookId: "80ca55ef-d20e-4457-a185-8b6a89fbe3a5", -}).then((res: DeleteWebhookResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getWebhookById - -Get a webhook by id. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { GetWebhookByIdResponse, GetWebhookByIdWebhookEvents } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.webhook.getWebhookById({ - webhookId: "aa8e4824-d0ab-4407-9088-e51862065e90", -}).then((res: GetWebhookByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getWebhooks - -Get a list of webhook that match the given scope-type and scope-id - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - GetWebhooks200ApplicationJSONWebhookEvents, - GetWebhooksResponse, - GetWebhooksScopeType, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.webhook.getWebhooks({ - scopeId: "4f3b1194-b8ab-4f60-ba79-f9dfe0ab7da8", - scopeType: GetWebhooksScopeType.Project, -}).then((res: GetWebhooksResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## updateWebhook - -Update a webhook - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - UpdateWebhookRequestBodyEvents, - UpdateWebhookResponse, - UpdateWebhookWebhookEvents, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.webhook.updateWebhook({ - requestBody: { - events: [ - UpdateWebhookRequestBodyEvents.WorkflowCompleted, - UpdateWebhookRequestBodyEvents.WorkflowCompleted, - UpdateWebhookRequestBodyEvents.JobCompleted, - ], - name: "Ryan Littel", - signingSecret: "totam", - url: "suscipit", - verifyTls: false, - }, - webhookId: "bc173d68-9eee-4952-af8d-986e881ead4f", -}).then((res: UpdateWebhookResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/docs/workflow/README.md b/docs/workflow/README.md deleted file mode 100755 index b72c3b03..00000000 --- a/docs/workflow/README.md +++ /dev/null @@ -1,153 +0,0 @@ -# workflow - -### Available Operations - -* [approvePendingApprovalJobById](#approvependingapprovaljobbyid) - Approve a job -* [cancelWorkflow](#cancelworkflow) - Cancel a workflow -* [getWorkflowById](#getworkflowbyid) - Get a workflow -* [listWorkflowJobs](#listworkflowjobs) - Get a workflow's jobs -* [rerunWorkflow](#rerunworkflow) - Rerun a workflow - -## approvePendingApprovalJobById - -Approves a pending approval job in a workflow. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { ApprovePendingApprovalJobByIdResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.workflow.approvePendingApprovalJobById({ - approvalRequestId: "0e101256-3f94-4e29-a973-e922a57a15be", - id: "3e060807-e2b6-4e3a-b884-5f0597a60ff2", -}).then((res: ApprovePendingApprovalJobByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## cancelWorkflow - -Cancels a running workflow. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { CancelWorkflowResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.workflow.cancelWorkflow({ - id: "a54a31e9-4764-4a3e-865e-7956f9251a5a", -}).then((res: CancelWorkflowResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## getWorkflowById - -Returns summary fields of a workflow by ID. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - GetWorkflowByIdResponse, - GetWorkflowByIdWorkflowStatus, - GetWorkflowByIdWorkflowTag, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.workflow.getWorkflowById({ - id: "9da660ff-57bf-4aad-8f9e-fc1b4512c103", -}).then((res: GetWorkflowByIdResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## listWorkflowJobs - -Returns a sequence of jobs for a workflow. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { - ListWorkflowJobsResponse, - ListWorkflowJobsWorkflowJobListResponseJobStatus, - ListWorkflowJobsWorkflowJobListResponseJobType, -} from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.workflow.listWorkflowJobs({ - id: "2648dc2f-6151-499e-bfd0-e9fe6c632ca3", -}).then((res: ListWorkflowJobsResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` - -## rerunWorkflow - -Reruns a workflow. - -### Example Usage - -```typescript -import { Circleci } from "circleci-v2-sdk"; -import { RerunWorkflowResponse } from "circleci-v2-sdk/dist/sdk/models/operations"; - -const sdk = new Circleci({ - security: { - apiKeyHeader: "YOUR_API_KEY_HERE", - }, -}); - -sdk.workflow.rerunWorkflow({ - requestBody: { - enableSsh: false, - fromFailed: false, - jobs: [ - "ed011799-6312-4fde-8477-1778ff61d017", - "476360a1-5db6-4a66-8659-a1adeaab5851", - "d6c645b0-8b61-4891-baa0-fe1ade008e6f", - ], - sparseTree: false, - }, - id: "8c5f350d-8cdb-45a3-8181-43010421813d", -}).then((res: RerunWorkflowResponse) => { - if (res.statusCode == 200) { - // handle response - } -}); -``` diff --git a/files.gen b/files.gen index 69498812..c32d7619 100755 --- a/files.gen +++ b/files.gen @@ -11,7 +11,6 @@ src/sdk/webhook.ts src/sdk/workflow.ts src/sdk/sdk.ts .eslintrc.yml -.gitignore jest.config.js package-lock.json package.json @@ -26,6 +25,7 @@ src/internal/utils/retries.ts src/internal/utils/security.ts src/internal/utils/utils.ts src/sdk/index.ts +src/sdk/models/errors/sdkerror.ts src/sdk/types/index.ts src/sdk/types/rfcdate.ts tsconfig.json @@ -113,16 +113,528 @@ src/sdk/models/shared/decisionsettings.ts src/sdk/models/shared/policy.ts src/sdk/models/shared/security.ts src/sdk/models/shared/index.ts -docs/circleci/README.md -docs/context/README.md -docs/insights/README.md -docs/job/README.md -docs/oidctokenmanagement/README.md -docs/pipeline/README.md -docs/policymanagement/README.md -docs/project/README.md -docs/schedule/README.md -docs/user/README.md -docs/webhook/README.md -docs/workflow/README.md -USAGE.md \ No newline at end of file +src/sdk/models/errors/index.ts +USAGE.md +docs/models/operations/addenvironmentvariabletocontextrequestbody.md +docs/models/operations/addenvironmentvariabletocontextrequest.md +docs/models/operations/addenvironmentvariabletocontextdefaultapplicationjson.md +docs/models/operations/addenvironmentvariabletocontext200applicationjsonmessageresponse.md +docs/models/operations/addenvironmentvariabletocontext200applicationjson1.md +docs/models/operations/addenvironmentvariabletocontextresponse.md +docs/models/operations/createcontextrequestbodyowner2type.md +docs/models/operations/createcontextrequestbodyowner2.md +docs/models/operations/createcontextrequestbodyowner1type.md +docs/models/operations/createcontextrequestbodyowner1.md +docs/models/operations/createcontextrequestbody.md +docs/models/operations/createcontextdefaultapplicationjson.md +docs/models/operations/createcontextcontext.md +docs/models/operations/createcontextresponse.md +docs/models/operations/deletecontextrequest.md +docs/models/operations/deletecontextdefaultapplicationjson.md +docs/models/operations/deletecontextmessageresponse.md +docs/models/operations/deletecontextresponse.md +docs/models/operations/deleteenvironmentvariablefromcontextrequest.md +docs/models/operations/deleteenvironmentvariablefromcontextdefaultapplicationjson.md +docs/models/operations/deleteenvironmentvariablefromcontextmessageresponse.md +docs/models/operations/deleteenvironmentvariablefromcontextresponse.md +docs/models/operations/getcontextrequest.md +docs/models/operations/getcontextdefaultapplicationjson.md +docs/models/operations/getcontextcontext.md +docs/models/operations/getcontextresponse.md +docs/models/operations/listcontextsownertype.md +docs/models/operations/listcontextsrequest.md +docs/models/operations/listcontextsdefaultapplicationjson.md +docs/models/operations/listcontexts200applicationjsoncontext.md +docs/models/operations/listcontexts200applicationjson.md +docs/models/operations/listcontextsresponse.md +docs/models/operations/listenvironmentvariablesfromcontextrequest.md +docs/models/operations/listenvironmentvariablesfromcontextdefaultapplicationjson.md +docs/models/operations/listenvironmentvariablesfromcontext200applicationjsonitems.md +docs/models/operations/listenvironmentvariablesfromcontext200applicationjson.md +docs/models/operations/listenvironmentvariablesfromcontextresponse.md +docs/models/operations/getallinsightsbranchesrequest.md +docs/models/operations/getallinsightsbranchesdefaultapplicationjson.md +docs/models/operations/getallinsightsbranchesresponse.md +docs/models/operations/getflakytestsrequest.md +docs/models/operations/getflakytestsdefaultapplicationjson.md +docs/models/operations/getflakytests200applicationjsonflakytests.md +docs/models/operations/getflakytests200applicationjson.md +docs/models/operations/getflakytestsresponse.md +docs/models/operations/getjobtimeseriesgranularity.md +docs/models/operations/getjobtimeseriesrequest.md +docs/models/operations/getjobtimeseriesdefaultapplicationjson.md +docs/models/operations/getjobtimeseries200applicationjsonitemsmetricsdurationmetrics.md +docs/models/operations/getjobtimeseries200applicationjsonitemsmetrics.md +docs/models/operations/getjobtimeseries200applicationjsonitems.md +docs/models/operations/getjobtimeseries200applicationjson.md +docs/models/operations/getjobtimeseriesresponse.md +docs/models/operations/getorgsummarydataprojectnames.md +docs/models/operations/getorgsummarydatareportingwindow.md +docs/models/operations/getorgsummarydatarequest.md +docs/models/operations/getorgsummarydatadefaultapplicationjson.md +docs/models/operations/getorgsummarydata200applicationjsonorgdatametrics.md +docs/models/operations/getorgsummarydata200applicationjsonorgdatatrends.md +docs/models/operations/getorgsummarydata200applicationjsonorgdata.md +docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatametrics.md +docs/models/operations/getorgsummarydata200applicationjsonorgprojectdatatrends.md +docs/models/operations/getorgsummarydata200applicationjsonorgprojectdata.md +docs/models/operations/getorgsummarydata200applicationjson.md +docs/models/operations/getorgsummarydataresponse.md +docs/models/operations/getprojectworkflowjobmetricsreportingwindow.md +docs/models/operations/getprojectworkflowjobmetricsrequest.md +docs/models/operations/getprojectworkflowjobmetricsdefaultapplicationjson.md +docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetricsdurationmetrics.md +docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitemsmetrics.md +docs/models/operations/getprojectworkflowjobmetrics200applicationjsonitems.md +docs/models/operations/getprojectworkflowjobmetrics200applicationjson.md +docs/models/operations/getprojectworkflowjobmetricsresponse.md +docs/models/operations/getprojectworkflowmetricsreportingwindow.md +docs/models/operations/getprojectworkflowmetricsrequest.md +docs/models/operations/getprojectworkflowmetricsdefaultapplicationjson.md +docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetricsdurationmetrics.md +docs/models/operations/getprojectworkflowmetrics200applicationjsonitemsmetrics.md +docs/models/operations/getprojectworkflowmetrics200applicationjsonitems.md +docs/models/operations/getprojectworkflowmetrics200applicationjson.md +docs/models/operations/getprojectworkflowmetricsresponse.md +docs/models/operations/getprojectworkflowrunsrequest.md +docs/models/operations/getprojectworkflowrunsdefaultapplicationjson.md +docs/models/operations/getprojectworkflowruns200applicationjsonitemsstatus.md +docs/models/operations/getprojectworkflowruns200applicationjsonitems.md +docs/models/operations/getprojectworkflowruns200applicationjson.md +docs/models/operations/getprojectworkflowrunsresponse.md +docs/models/operations/getprojectworkflowtestmetricsrequest.md +docs/models/operations/getprojectworkflowtestmetricsdefaultapplicationjson.md +docs/models/operations/getprojectworkflowtestmetrics200applicationjsonmostfailedtests.md +docs/models/operations/getprojectworkflowtestmetrics200applicationjsonslowesttests.md +docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestrunstestcounts.md +docs/models/operations/getprojectworkflowtestmetrics200applicationjsontestruns.md +docs/models/operations/getprojectworkflowtestmetrics200applicationjson.md +docs/models/operations/getprojectworkflowtestmetricsresponse.md +docs/models/operations/getprojectworkflowspagedatabranches.md +docs/models/operations/getprojectworkflowspagedatareportingwindow.md +docs/models/operations/getprojectworkflowspagedataworkflownames.md +docs/models/operations/getprojectworkflowspagedatarequest.md +docs/models/operations/getprojectworkflowspagedatadefaultapplicationjson.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatametrics.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdatatrends.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectdata.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatametrics.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdatatrends.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowbranchdata.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatametrics.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdatatrends.md +docs/models/operations/getprojectworkflowspagedata200applicationjsonprojectworkflowdata.md +docs/models/operations/getprojectworkflowspagedata200applicationjson.md +docs/models/operations/getprojectworkflowspagedataresponse.md +docs/models/operations/getworkflowsummaryrequest.md +docs/models/operations/getworkflowsummarydefaultapplicationjson.md +docs/models/operations/getworkflowsummary200applicationjsonmetricsdurationmetrics.md +docs/models/operations/getworkflowsummary200applicationjsonmetrics.md +docs/models/operations/getworkflowsummary200applicationjsontrends.md +docs/models/operations/getworkflowsummary200applicationjson.md +docs/models/operations/getworkflowsummaryresponse.md +docs/models/operations/canceljobrequest.md +docs/models/operations/canceljobdefaultapplicationjson.md +docs/models/operations/canceljobmessageresponse.md +docs/models/operations/canceljobresponse.md +docs/models/operations/getjobartifactsrequest.md +docs/models/operations/getjobartifactsdefaultapplicationjson.md +docs/models/operations/getjobartifactsartifactlistresponseartifact.md +docs/models/operations/getjobartifactsartifactlistresponse.md +docs/models/operations/getjobartifactsresponse.md +docs/models/operations/getjobdetailsrequest.md +docs/models/operations/getjobdetailsdefaultapplicationjson.md +docs/models/operations/getjobdetailsjobdetailscontexts.md +docs/models/operations/getjobdetailsjobdetailsexecutor.md +docs/models/operations/getjobdetailsjobdetailslatestworkflow.md +docs/models/operations/getjobdetailsjobdetailsmessages.md +docs/models/operations/getjobdetailsjobdetailsorganization.md +docs/models/operations/getjobdetailsjobdetailsparallelruns.md +docs/models/operations/getjobdetailsjobdetailspipeline.md +docs/models/operations/getjobdetailsjobdetailsproject.md +docs/models/operations/getjobdetailsjobdetailsstatus.md +docs/models/operations/getjobdetailsjobdetails.md +docs/models/operations/getjobdetailsresponse.md +docs/models/operations/gettestsrequest.md +docs/models/operations/gettestsdefaultapplicationjson.md +docs/models/operations/getteststestsresponseitems.md +docs/models/operations/getteststestsresponse.md +docs/models/operations/gettestsresponse.md +docs/models/operations/deleteorgclaimsrequest.md +docs/models/operations/deleteorgclaims500applicationjson.md +docs/models/operations/deleteorgclaims403applicationjson.md +docs/models/operations/deleteorgclaims400applicationjson.md +docs/models/operations/deleteorgclaimsresponse.md +docs/models/operations/deleteprojectclaimsrequest.md +docs/models/operations/deleteprojectclaims500applicationjson.md +docs/models/operations/deleteprojectclaims403applicationjson.md +docs/models/operations/deleteprojectclaims400applicationjson.md +docs/models/operations/deleteprojectclaimsresponse.md +docs/models/operations/getorgclaimsrequest.md +docs/models/operations/getorgclaims500applicationjson.md +docs/models/operations/getorgclaims403applicationjson.md +docs/models/operations/getorgclaims400applicationjson.md +docs/models/operations/getorgclaimsresponse.md +docs/models/operations/getprojectclaimsrequest.md +docs/models/operations/getprojectclaims500applicationjson.md +docs/models/operations/getprojectclaims403applicationjson.md +docs/models/operations/getprojectclaims400applicationjson.md +docs/models/operations/getprojectclaimsresponse.md +docs/models/operations/patchorgclaimsrequest.md +docs/models/operations/patchorgclaims500applicationjson.md +docs/models/operations/patchorgclaims403applicationjson.md +docs/models/operations/patchorgclaims400applicationjson.md +docs/models/operations/patchorgclaimsresponse.md +docs/models/operations/patchprojectclaimsrequest.md +docs/models/operations/patchprojectclaims500applicationjson.md +docs/models/operations/patchprojectclaims403applicationjson.md +docs/models/operations/patchprojectclaims400applicationjson.md +docs/models/operations/patchprojectclaimsresponse.md +docs/models/operations/continuepipelinerequestbody.md +docs/models/operations/continuepipelinedefaultapplicationjson.md +docs/models/operations/continuepipelinemessageresponse.md +docs/models/operations/continuepipelineresponse.md +docs/models/operations/getpipelinebyidrequest.md +docs/models/operations/getpipelinebyiddefaultapplicationjson.md +docs/models/operations/getpipelinebyidpipelineerrorstype.md +docs/models/operations/getpipelinebyidpipelineerrors.md +docs/models/operations/getpipelinebyidpipelinestate.md +docs/models/operations/getpipelinebyidpipelinetriggeractor.md +docs/models/operations/getpipelinebyidpipelinetriggertype.md +docs/models/operations/getpipelinebyidpipelinetrigger.md +docs/models/operations/getpipelinebyidpipelinevcscommit.md +docs/models/operations/getpipelinebyidpipelinevcs.md +docs/models/operations/getpipelinebyidpipeline.md +docs/models/operations/getpipelinebyidresponse.md +docs/models/operations/getpipelinebynumberrequest.md +docs/models/operations/getpipelinebynumberdefaultapplicationjson.md +docs/models/operations/getpipelinebynumberpipelineerrorstype.md +docs/models/operations/getpipelinebynumberpipelineerrors.md +docs/models/operations/getpipelinebynumberpipelinestate.md +docs/models/operations/getpipelinebynumberpipelinetriggeractor.md +docs/models/operations/getpipelinebynumberpipelinetriggertype.md +docs/models/operations/getpipelinebynumberpipelinetrigger.md +docs/models/operations/getpipelinebynumberpipelinevcscommit.md +docs/models/operations/getpipelinebynumberpipelinevcs.md +docs/models/operations/getpipelinebynumberpipeline.md +docs/models/operations/getpipelinebynumberresponse.md +docs/models/operations/getpipelineconfigbyidrequest.md +docs/models/operations/getpipelineconfigbyiddefaultapplicationjson.md +docs/models/operations/getpipelineconfigbyidpipelineconfig.md +docs/models/operations/getpipelineconfigbyidresponse.md +docs/models/operations/listmypipelinesrequest.md +docs/models/operations/listmypipelinesdefaultapplicationjson.md +docs/models/operations/listmypipelinespipelinelistresponsepipelineerrorstype.md +docs/models/operations/listmypipelinespipelinelistresponsepipelineerrors.md +docs/models/operations/listmypipelinespipelinelistresponsepipelinestate.md +docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggeractor.md +docs/models/operations/listmypipelinespipelinelistresponsepipelinetriggertype.md +docs/models/operations/listmypipelinespipelinelistresponsepipelinetrigger.md +docs/models/operations/listmypipelinespipelinelistresponsepipelinevcscommit.md +docs/models/operations/listmypipelinespipelinelistresponsepipelinevcs.md +docs/models/operations/listmypipelinespipelinelistresponsepipeline.md +docs/models/operations/listmypipelinespipelinelistresponse.md +docs/models/operations/listmypipelinesresponse.md +docs/models/operations/listpipelinesrequest.md +docs/models/operations/listpipelinesdefaultapplicationjson.md +docs/models/operations/listpipelinespipelinelistresponsepipelineerrorstype.md +docs/models/operations/listpipelinespipelinelistresponsepipelineerrors.md +docs/models/operations/listpipelinespipelinelistresponsepipelinestate.md +docs/models/operations/listpipelinespipelinelistresponsepipelinetriggeractor.md +docs/models/operations/listpipelinespipelinelistresponsepipelinetriggertype.md +docs/models/operations/listpipelinespipelinelistresponsepipelinetrigger.md +docs/models/operations/listpipelinespipelinelistresponsepipelinevcscommit.md +docs/models/operations/listpipelinespipelinelistresponsepipelinevcs.md +docs/models/operations/listpipelinespipelinelistresponsepipeline.md +docs/models/operations/listpipelinespipelinelistresponse.md +docs/models/operations/listpipelinesresponse.md +docs/models/operations/listpipelinesforprojectrequest.md +docs/models/operations/listpipelinesforprojectdefaultapplicationjson.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrorstype.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelineerrors.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinestate.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggeractor.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetriggertype.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinetrigger.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcscommit.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipelinevcs.md +docs/models/operations/listpipelinesforprojectpipelinelistresponsepipeline.md +docs/models/operations/listpipelinesforprojectpipelinelistresponse.md +docs/models/operations/listpipelinesforprojectresponse.md +docs/models/operations/listworkflowsbypipelineidrequest.md +docs/models/operations/listworkflowsbypipelineiddefaultapplicationjson.md +docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowstatus.md +docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflowtag.md +docs/models/operations/listworkflowsbypipelineidworkflowlistresponseworkflow.md +docs/models/operations/listworkflowsbypipelineidworkflowlistresponse.md +docs/models/operations/listworkflowsbypipelineidresponse.md +docs/models/operations/triggerpipelinetriggerpipelineparameters.md +docs/models/operations/triggerpipelinerequest.md +docs/models/operations/triggerpipelinedefaultapplicationjson.md +docs/models/operations/triggerpipelinepipelinecreationstate.md +docs/models/operations/triggerpipelinepipelinecreation.md +docs/models/operations/triggerpipelineresponse.md +docs/models/operations/createpolicybundlerequest.md +docs/models/operations/createpolicybundle500applicationjson.md +docs/models/operations/createpolicybundle413applicationjson.md +docs/models/operations/createpolicybundle403applicationjson.md +docs/models/operations/createpolicybundle401applicationjson.md +docs/models/operations/createpolicybundle400applicationjson.md +docs/models/operations/createpolicybundleresponse.md +docs/models/operations/getdecisionlogrequest.md +docs/models/operations/getdecisionlog500applicationjson.md +docs/models/operations/getdecisionlog404applicationjson.md +docs/models/operations/getdecisionlog403applicationjson.md +docs/models/operations/getdecisionlog401applicationjson.md +docs/models/operations/getdecisionlog400applicationjson.md +docs/models/operations/getdecisionlogresponse.md +docs/models/operations/getdecisionlogpolicybundlerequest.md +docs/models/operations/getdecisionlogpolicybundle500applicationjson.md +docs/models/operations/getdecisionlogpolicybundle404applicationjson.md +docs/models/operations/getdecisionlogpolicybundle403applicationjson.md +docs/models/operations/getdecisionlogpolicybundle401applicationjson.md +docs/models/operations/getdecisionlogpolicybundle400applicationjson.md +docs/models/operations/getdecisionlogpolicybundleresponse.md +docs/models/operations/getdecisionlogsrequest.md +docs/models/operations/getdecisionlogs500applicationjson.md +docs/models/operations/getdecisionlogs403applicationjson.md +docs/models/operations/getdecisionlogs401applicationjson.md +docs/models/operations/getdecisionlogs400applicationjson.md +docs/models/operations/getdecisionlogsresponse.md +docs/models/operations/getdecisionsettingsrequest.md +docs/models/operations/getdecisionsettings500applicationjson.md +docs/models/operations/getdecisionsettings403applicationjson.md +docs/models/operations/getdecisionsettings401applicationjson.md +docs/models/operations/getdecisionsettings400applicationjson.md +docs/models/operations/getdecisionsettingsresponse.md +docs/models/operations/getpolicybundlerequest.md +docs/models/operations/getpolicybundle500applicationjson.md +docs/models/operations/getpolicybundle403applicationjson.md +docs/models/operations/getpolicybundle401applicationjson.md +docs/models/operations/getpolicybundle400applicationjson.md +docs/models/operations/getpolicybundleresponse.md +docs/models/operations/getpolicydocumentrequest.md +docs/models/operations/getpolicydocument500applicationjson.md +docs/models/operations/getpolicydocument404applicationjson.md +docs/models/operations/getpolicydocument403applicationjson.md +docs/models/operations/getpolicydocument401applicationjson.md +docs/models/operations/getpolicydocument400applicationjson.md +docs/models/operations/getpolicydocumentresponse.md +docs/models/operations/makedecisionrequestbodymetadata.md +docs/models/operations/makedecisionrequestbody.md +docs/models/operations/makedecisionrequest.md +docs/models/operations/makedecision500applicationjson.md +docs/models/operations/makedecision401applicationjson.md +docs/models/operations/makedecision400applicationjson.md +docs/models/operations/makedecisionresponse.md +docs/models/operations/setdecisionsettingsrequest.md +docs/models/operations/setdecisionsettings500applicationjson.md +docs/models/operations/setdecisionsettings403applicationjson.md +docs/models/operations/setdecisionsettings401applicationjson.md +docs/models/operations/setdecisionsettings400applicationjson.md +docs/models/operations/setdecisionsettingsresponse.md +docs/models/operations/createcheckoutkeycheckoutkeyinputcheckoutkeyinputtype.md +docs/models/operations/createcheckoutkeycheckoutkeyinput.md +docs/models/operations/createcheckoutkeyrequest.md +docs/models/operations/createcheckoutkeydefaultapplicationjson.md +docs/models/operations/createcheckoutkeycheckoutkeycheckoutkeytype.md +docs/models/operations/createcheckoutkeycheckoutkey.md +docs/models/operations/createcheckoutkeyresponse.md +docs/models/operations/createenvvarenvironmentvariable.md +docs/models/operations/createenvvarrequest.md +docs/models/operations/createenvvardefaultapplicationjson.md +docs/models/operations/createenvvarenvironmentvariable1.md +docs/models/operations/createenvvarresponse.md +docs/models/operations/deletecheckoutkeyrequest.md +docs/models/operations/deletecheckoutkeydefaultapplicationjson.md +docs/models/operations/deletecheckoutkeymessageresponse.md +docs/models/operations/deletecheckoutkeyresponse.md +docs/models/operations/deleteenvvarrequest.md +docs/models/operations/deleteenvvardefaultapplicationjson.md +docs/models/operations/deleteenvvarmessageresponse.md +docs/models/operations/deleteenvvarresponse.md +docs/models/operations/getcheckoutkeyrequest.md +docs/models/operations/getcheckoutkeydefaultapplicationjson.md +docs/models/operations/getcheckoutkeycheckoutkeycheckoutkeytype.md +docs/models/operations/getcheckoutkeycheckoutkey.md +docs/models/operations/getcheckoutkeyresponse.md +docs/models/operations/getenvvarrequest.md +docs/models/operations/getenvvardefaultapplicationjson.md +docs/models/operations/getenvvarenvironmentvariable.md +docs/models/operations/getenvvarresponse.md +docs/models/operations/getprojectbyslugrequest.md +docs/models/operations/getprojectbyslugdefaultapplicationjson.md +docs/models/operations/getprojectbyslugprojectvcsinfoprovider.md +docs/models/operations/getprojectbyslugprojectvcsinfo.md +docs/models/operations/getprojectbyslugproject.md +docs/models/operations/getprojectbyslugresponse.md +docs/models/operations/listcheckoutkeysrequest.md +docs/models/operations/listcheckoutkeysdefaultapplicationjson.md +docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkeycheckoutkeytype.md +docs/models/operations/listcheckoutkeyscheckoutkeylistresponsecheckoutkey.md +docs/models/operations/listcheckoutkeyscheckoutkeylistresponse.md +docs/models/operations/listcheckoutkeysresponse.md +docs/models/operations/listenvvarsrequest.md +docs/models/operations/listenvvarsdefaultapplicationjson.md +docs/models/operations/listenvvarsenvironmentvariablelistresponseenvironmentvariable.md +docs/models/operations/listenvvarsenvironmentvariablelistresponse.md +docs/models/operations/listenvvarsresponse.md +docs/models/operations/createschedulecreatescheduleparametersattributionactor.md +docs/models/operations/createschedulecreatescheduleparameterstimetable2daysofweek.md +docs/models/operations/createschedulecreatescheduleparameterstimetable2months.md +docs/models/operations/createschedulecreatescheduleparameterstimetable2.md +docs/models/operations/createschedulecreatescheduleparameterstimetable1daysofweek.md +docs/models/operations/createschedulecreatescheduleparameterstimetable1months.md +docs/models/operations/createschedulecreatescheduleparameterstimetable1.md +docs/models/operations/createschedulecreatescheduleparameters.md +docs/models/operations/createschedulerequest.md +docs/models/operations/createscheduledefaultapplicationjson.md +docs/models/operations/createschedulescheduleuser.md +docs/models/operations/createschedulescheduletimetable2daysofweek.md +docs/models/operations/createschedulescheduletimetable2months.md +docs/models/operations/createschedulescheduletimetable2.md +docs/models/operations/createschedulescheduletimetable1daysofweek.md +docs/models/operations/createschedulescheduletimetable1months.md +docs/models/operations/createschedulescheduletimetable1.md +docs/models/operations/createscheduleschedule.md +docs/models/operations/createscheduleresponse.md +docs/models/operations/deleteschedulebyidrequest.md +docs/models/operations/deleteschedulebyiddefaultapplicationjson.md +docs/models/operations/deleteschedulebyidmessageresponse.md +docs/models/operations/deleteschedulebyidresponse.md +docs/models/operations/getschedulebyidrequest.md +docs/models/operations/getschedulebyiddefaultapplicationjson.md +docs/models/operations/getschedulebyidscheduleuser.md +docs/models/operations/getschedulebyidscheduletimetable2daysofweek.md +docs/models/operations/getschedulebyidscheduletimetable2months.md +docs/models/operations/getschedulebyidscheduletimetable2.md +docs/models/operations/getschedulebyidscheduletimetable1daysofweek.md +docs/models/operations/getschedulebyidscheduletimetable1months.md +docs/models/operations/getschedulebyidscheduletimetable1.md +docs/models/operations/getschedulebyidschedule.md +docs/models/operations/getschedulebyidresponse.md +docs/models/operations/listschedulesforprojectrequest.md +docs/models/operations/listschedulesforprojectdefaultapplicationjson.md +docs/models/operations/listschedulesforproject200applicationjsonscheduleuser.md +docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2daysofweek.md +docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2months.md +docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable2.md +docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1daysofweek.md +docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1months.md +docs/models/operations/listschedulesforproject200applicationjsonscheduletimetable1.md +docs/models/operations/listschedulesforproject200applicationjsonschedule.md +docs/models/operations/listschedulesforproject200applicationjson.md +docs/models/operations/listschedulesforprojectresponse.md +docs/models/operations/updatescheduleupdatescheduleparametersattributionactor.md +docs/models/operations/updatescheduleupdatescheduleparameterstimetabledaysofweek.md +docs/models/operations/updatescheduleupdatescheduleparameterstimetablemonths.md +docs/models/operations/updatescheduleupdatescheduleparameterstimetable.md +docs/models/operations/updatescheduleupdatescheduleparameters.md +docs/models/operations/updateschedulerequest.md +docs/models/operations/updatescheduledefaultapplicationjson.md +docs/models/operations/updateschedulescheduleuser.md +docs/models/operations/updateschedulescheduletimetable2daysofweek.md +docs/models/operations/updateschedulescheduletimetable2months.md +docs/models/operations/updateschedulescheduletimetable2.md +docs/models/operations/updateschedulescheduletimetable1daysofweek.md +docs/models/operations/updateschedulescheduletimetable1months.md +docs/models/operations/updateschedulescheduletimetable1.md +docs/models/operations/updatescheduleschedule.md +docs/models/operations/updatescheduleresponse.md +docs/models/operations/getcollaborationsdefaultapplicationjson.md +docs/models/operations/getcollaborationscollaboration.md +docs/models/operations/getcollaborationsresponse.md +docs/models/operations/getcurrentuserdefaultapplicationjson.md +docs/models/operations/getcurrentuseruser.md +docs/models/operations/getcurrentuserresponse.md +docs/models/operations/getuserrequest.md +docs/models/operations/getuserdefaultapplicationjson.md +docs/models/operations/getuseruser.md +docs/models/operations/getuserresponse.md +docs/models/operations/createwebhookrequestbodyevents.md +docs/models/operations/createwebhookrequestbodyscopetype.md +docs/models/operations/createwebhookrequestbodyscope.md +docs/models/operations/createwebhookrequestbody.md +docs/models/operations/createwebhookdefaultapplicationjson.md +docs/models/operations/createwebhookwebhookevents.md +docs/models/operations/createwebhookwebhookscope.md +docs/models/operations/createwebhookwebhook.md +docs/models/operations/createwebhookresponse.md +docs/models/operations/deletewebhookrequest.md +docs/models/operations/deletewebhookdefaultapplicationjson.md +docs/models/operations/deletewebhookmessageresponse.md +docs/models/operations/deletewebhookresponse.md +docs/models/operations/getwebhookbyidrequest.md +docs/models/operations/getwebhookbyiddefaultapplicationjson.md +docs/models/operations/getwebhookbyidwebhookevents.md +docs/models/operations/getwebhookbyidwebhookscope.md +docs/models/operations/getwebhookbyidwebhook.md +docs/models/operations/getwebhookbyidresponse.md +docs/models/operations/getwebhooksscopetype.md +docs/models/operations/getwebhooksrequest.md +docs/models/operations/getwebhooksdefaultapplicationjson.md +docs/models/operations/getwebhooks200applicationjsonwebhookevents.md +docs/models/operations/getwebhooks200applicationjsonwebhookscope.md +docs/models/operations/getwebhooks200applicationjsonwebhook.md +docs/models/operations/getwebhooks200applicationjson.md +docs/models/operations/getwebhooksresponse.md +docs/models/operations/updatewebhookrequestbodyevents.md +docs/models/operations/updatewebhookrequestbody.md +docs/models/operations/updatewebhookrequest.md +docs/models/operations/updatewebhookdefaultapplicationjson.md +docs/models/operations/updatewebhookwebhookevents.md +docs/models/operations/updatewebhookwebhookscope.md +docs/models/operations/updatewebhookwebhook.md +docs/models/operations/updatewebhookresponse.md +docs/models/operations/approvependingapprovaljobbyidrequest.md +docs/models/operations/approvependingapprovaljobbyiddefaultapplicationjson.md +docs/models/operations/approvependingapprovaljobbyidmessageresponse.md +docs/models/operations/approvependingapprovaljobbyidresponse.md +docs/models/operations/cancelworkflowrequest.md +docs/models/operations/cancelworkflowdefaultapplicationjson.md +docs/models/operations/cancelworkflowmessageresponse.md +docs/models/operations/cancelworkflowresponse.md +docs/models/operations/getworkflowbyidrequest.md +docs/models/operations/getworkflowbyiddefaultapplicationjson.md +docs/models/operations/getworkflowbyidworkflowstatus.md +docs/models/operations/getworkflowbyidworkflowtag.md +docs/models/operations/getworkflowbyidworkflow.md +docs/models/operations/getworkflowbyidresponse.md +docs/models/operations/listworkflowjobsrequest.md +docs/models/operations/listworkflowjobsdefaultapplicationjson.md +docs/models/operations/listworkflowjobsworkflowjoblistresponsejobstatus.md +docs/models/operations/listworkflowjobsworkflowjoblistresponsejobtype.md +docs/models/operations/listworkflowjobsworkflowjoblistresponsejob.md +docs/models/operations/listworkflowjobsworkflowjoblistresponse.md +docs/models/operations/listworkflowjobsresponse.md +docs/models/operations/rerunworkflowrerunworkflowparameters.md +docs/models/operations/rerunworkflowrequest.md +docs/models/operations/rerunworkflowdefaultapplicationjson.md +docs/models/operations/rerunworkflow202applicationjson.md +docs/models/operations/rerunworkflowresponse.md +docs/models/shared/claimresponse.md +docs/models/shared/patchclaimsrequest.md +docs/models/shared/bundlediff.md +docs/models/shared/bundlepayload.md +docs/models/shared/decisionlogmetadatavcs.md +docs/models/shared/decisionlogmetadata.md +docs/models/shared/decisionlog.md +docs/models/shared/decision.md +docs/models/shared/violation.md +docs/models/shared/decisionsettings.md +docs/models/shared/policy.md +docs/models/shared/schemebasicauth.md +docs/models/shared/security.md +docs/sdks/circleci/README.md +docs/sdks/context/README.md +docs/sdks/insights/README.md +docs/sdks/job/README.md +docs/sdks/oidctokenmanagement/README.md +docs/sdks/pipeline/README.md +docs/sdks/policymanagement/README.md +docs/sdks/project/README.md +docs/sdks/schedule/README.md +docs/sdks/user/README.md +docs/sdks/webhook/README.md +docs/sdks/workflow/README.md +.gitattributes \ No newline at end of file diff --git a/gen.yaml b/gen.yaml index b35c93fb..ce8bef6d 100644 --- a/gen.yaml +++ b/gen.yaml @@ -1,17 +1,22 @@ configVersion: 1.0.0 management: - docChecksum: c62ebf557be5759db31c00386e69266c + docChecksum: 4681f20e78493d115c707b2ecaec17a6 docVersion: v2 - speakeasyVersion: 1.40.2 - generationVersion: 2.34.2 + speakeasyVersion: 1.94.0 + generationVersion: 2.147.0 generation: baseServerUrl: https://circleci.com/api/v2/ sdkClassName: circleci sdkFlattening: false singleTagPerOp: false telemetryEnabled: false +features: + typescript: + core: 2.90.3 + globalSecurity: 2.81.1 + globalServerURLs: 2.82.0 typescript: - version: 3.30.1 + version: 3.59.2 author: Speakeasy API maxMethodParams: 0 packageName: circleci-v2-sdk diff --git a/package-lock.json b/package-lock.json index 7275d733..486a5443 100755 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "circleci-v2-sdk", - "version": "3.30.1", + "version": "3.59.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "circleci-v2-sdk", - "version": "3.30.1", + "version": "3.59.2", "dependencies": { "axios": "^1.1.3", "class-transformer": "^0.5.1", diff --git a/package.json b/package.json index b0293502..58a259bc 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "circleci-v2-sdk", - "version": "3.30.1", + "version": "3.59.2", "author": "Speakeasy API", "scripts": { "prepare": "tsc --build" @@ -23,6 +23,7 @@ "main": "dist/index.js", "files": [ "dist", + "docs", "README.md" ], "repository": { diff --git a/src/internal/utils/queryparams.ts b/src/internal/utils/queryparams.ts index cd39120d..90f56536 100755 --- a/src/internal/utils/queryparams.ts +++ b/src/internal/utils/queryparams.ts @@ -2,16 +2,24 @@ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. */ -import {ParamDecorator, parseParamDecorator, populateFromGlobals, shouldQueryParamSerialize, valToString} from "./utils"; +import { + ParamDecorator, + parseParamDecorator, + populateFromGlobals, + shouldQueryParamSerialize, + valToString +} from "./utils"; import {requestMetadataKey} from "./requestbody"; export const qpMetadataKey = "queryParam"; const queryStringPrefix = "?"; +const filterAndJoin = (strings: string[]):string => strings.filter(s => !!s).join("&") + export function serializeQueryParams(queryParams: any, globals?: any): string { const queryStringParts: string[] = []; - if (!queryParams) return queryStringParts.join("&"); + if (!queryParams) return filterAndJoin(queryStringParts); const fieldNames: string[] = "__props__" in queryParams @@ -84,7 +92,7 @@ export function serializeQueryParams(queryParams: any, globals?: any): string { } } }); - return queryStringPrefix + queryStringParts.join("&"); + return queryStringPrefix + filterAndJoin(queryStringParts); } // TODO: Add support for disabling percent encoding for reserved characters @@ -94,7 +102,7 @@ function jsonSerializer(params: Record): string { Object.entries(Object.assign({}, params)).forEach(([key, value]) => { query.push(`${key}=${encodeURIComponent(JSON.stringify(value))}`); }); - return query.join("&"); + return filterAndJoin(query); } // TODO: Add support for disabling percent encoding for reserved characters @@ -133,7 +141,7 @@ function noExplodeSerializer(params: Record, delimiter = ","): stri query.push(`${key}=${encodeURIComponent(values)}`); } }); - return query.join("&"); + return filterAndJoin(query); } // TODO: Add support for disabling percent encoding for reserved characters @@ -146,9 +154,9 @@ function formSerializerExplode(params: Record): string { query.push(`${key}=${encodeURIComponent(value)}`); else if (Array.isArray(value)) { query.push( - value + value .map((aValue) => `${key}=${encodeURIComponent(valToString(aValue))}`) - .join("&") + .join("&") ); } else query.push( @@ -176,7 +184,7 @@ function formSerializerExplode(params: Record): string { .join("&") ); }); - return query.join("&"); + return filterAndJoin(query); } // TODO: Add support for disabling percent encoding for reserved characters @@ -232,5 +240,5 @@ function deepObjectSerializer(params: Record): string { .join("&") ); }); - return query.join("&"); + return filterAndJoin(query); } diff --git a/src/internal/utils/requestbody.ts b/src/internal/utils/requestbody.ts index 40f601b7..f7a1f55f 100755 --- a/src/internal/utils/requestbody.ts +++ b/src/internal/utils/requestbody.ts @@ -6,6 +6,7 @@ import {isBooleanRecord, isNumberRecord, isStringRecord, SerializationMethodToCo import FormData from "form-data"; import {RFCDate} from "../../sdk/types"; +import {classToPlain} from "class-transformer"; export const requestMetadataKey = "request"; const mpFormMetadataKey = "multipart_form"; @@ -14,7 +15,7 @@ export function serializeRequestBody( request: any, requestFieldName: string, serializationMethod: string -): [object, any] { +): [Record, any] { if ( request !== Object(request) || !request.hasOwnProperty(requestFieldName) @@ -45,8 +46,8 @@ export function serializeRequestBody( const serializeContentType = ( contentType: string, reqBody: any -): [object, any] => { - let [requestHeaders, requestBody]: [object, any] = [{}, {}]; +): [Record, any] => { + let [requestHeaders, requestBody]: [Record, any] = [{}, {}]; switch (contentType) { case "multipart/form-data": @@ -66,6 +67,11 @@ const serializeContentType = ( break; case "application/json": + [requestHeaders, requestBody] = [ + {"Content-Type": `${contentType}`}, + classToPlain(reqBody, {exposeUnsetFields: false}), + ]; + break; case "text/json": [requestHeaders, requestBody] = [ {"Content-Type": `${contentType}`}, @@ -309,7 +315,7 @@ function encodeMultipartFormDataFile(formData: FormData, file: any): FormData { if (mpFormDecoratorName === "" || fileName === "" || content == null) { throw new Error("invalid multipart/form-data file"); } - formData.append("file", Buffer.from(content), fileName); + formData.append(mpFormDecoratorName, Buffer.from(content), fileName); return formData; } diff --git a/src/internal/utils/retries.ts b/src/internal/utils/retries.ts index 6c77b95e..8fea21de 100755 --- a/src/internal/utils/retries.ts +++ b/src/internal/utils/retries.ts @@ -24,12 +24,17 @@ export class BackoffStrategy { } export class RetryConfig { - strategy: string; + strategy: "backoff" | "none"; backoff?: BackoffStrategy; retryConnectionErrors: boolean; - constructor(strategy: string, retryConnectionErrors = true) { + constructor( + strategy: "backoff" | "none", + backoff?: BackoffStrategy, + retryConnectionErrors = true + ) { this.strategy = strategy; + this.backoff = backoff; this.retryConnectionErrors = retryConnectionErrors; } } @@ -50,6 +55,8 @@ class PermanentError extends Error { constructor(inner: unknown) { super("Permanent error"); this.inner = inner; + + Object.setPrototypeOf(this, PermanentError.prototype); } } @@ -59,6 +66,8 @@ class TemporaryError extends Error { constructor(res: AxiosResponse) { super("Temporary error"); this.res = res; + + Object.setPrototypeOf(this, TemporaryError.prototype); } } diff --git a/src/internal/utils/security.ts b/src/internal/utils/security.ts index d8939d6e..8f183b41 100755 --- a/src/internal/utils/security.ts +++ b/src/internal/utils/security.ts @@ -2,15 +2,17 @@ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. */ -import { AxiosInstance } from "axios"; - const securityMetadataKey = "security"; -export function createSecurityClient( - client: AxiosInstance, +export type SecurityProperties = { + params: Record, + headers: Record, +} + +export function parseSecurityProperties( security: any -): AxiosInstance { - return parseSecurityClass(client, security); +): SecurityProperties { + return parseSecurityClass(security); } function parseSecurityDecorator(securityAnn: string): SecurityDecorator { @@ -51,10 +53,13 @@ function parseSecurityDecorator(securityAnn: string): SecurityDecorator { } function parseSecurityClass( - client: AxiosInstance, security: any -): AxiosInstance { +): SecurityProperties { const fieldNames: string[] = Object.getOwnPropertyNames(security); + const properties: SecurityProperties = { + params: {}, + headers: {}, + } fieldNames.forEach((fname) => { const securityAnn: string = Reflect.getMetadata( securityMetadataKey, @@ -69,23 +74,23 @@ function parseSecurityClass( const value = security[fname]; if (securityDecorator.Option) { - return parseSecurityOption(client, value); + return parseSecurityOption(properties, value); } else if (securityDecorator.Scheme) { if (securityDecorator.SubType === "basic" && value !== Object(value)) { - return parseSecurityScheme(client, securityDecorator, security); + return parseSecurityScheme(properties, securityDecorator, security); } else { - client = parseSecurityScheme(client, securityDecorator, value); + return parseSecurityScheme(properties, securityDecorator, value); } } }); - return client; + return properties; } function parseSecurityOption( - client: AxiosInstance, + properties: SecurityProperties, optionType: any -): AxiosInstance { +): void { const fieldNames: string[] = Object.getOwnPropertyNames(optionType); fieldNames.forEach((fname) => { const securityAnn: string = Reflect.getMetadata( @@ -97,23 +102,21 @@ function parseSecurityOption( const securityDecorator: SecurityDecorator = parseSecurityDecorator(securityAnn); if (securityDecorator == null || !securityDecorator.Scheme) return; - return parseSecurityScheme(client, securityDecorator, optionType[fname]); + return parseSecurityScheme(properties, securityDecorator, optionType[fname]); }); - - return client; } function parseSecurityScheme( - client: AxiosInstance, + properties: SecurityProperties, schemeDecorator: SecurityDecorator, scheme: any -): AxiosInstance { +): void { if (scheme === Object(scheme)) { if ( schemeDecorator.Type === "http" && schemeDecorator.SubType === "basic" ) { - return parseBasicAuthScheme(client, scheme); + return parseBasicAuthScheme(properties, scheme); } const fieldNames: string[] = Object.getOwnPropertyNames(scheme); @@ -128,46 +131,44 @@ function parseSecurityScheme( parseSecurityDecorator(securityAnn); if (securityDecorator == null || securityDecorator.Name === "") return; - client = parseSecuritySchemeValue( - client, + return parseSecuritySchemeValue( + properties, schemeDecorator, securityDecorator, scheme[fname] ); }); } else { - client = parseSecuritySchemeValue( - client, + return parseSecuritySchemeValue( + properties, schemeDecorator, schemeDecorator, scheme ); } - - return client; } function parseSecuritySchemeValue( - client: AxiosInstance, + properties: SecurityProperties, schemeDecorator: SecurityDecorator, securityDecorator: SecurityDecorator, value: any -): AxiosInstance { +): void { switch (schemeDecorator.Type) { case "apiKey": switch (schemeDecorator.SubType) { case "header": - client.defaults.headers.common[securityDecorator.Name] = value; + properties.headers[securityDecorator.Name] = value; break; case "query": - client.defaults.params[securityDecorator.Name] = value; + properties.params[securityDecorator.Name] = value; break; case "cookie": { const securityDecoratorName: string = securityDecorator.Name; const val: string = value; - client.defaults.headers.common[ + properties.headers[ "Cookie" - ] = `${securityDecoratorName}=${val}`; + ] = `${securityDecoratorName}=${val}`; break; } default: @@ -175,17 +176,17 @@ function parseSecuritySchemeValue( } break; case "openIdConnect": - client.defaults.headers.common[securityDecorator.Name] = value; + properties.headers[securityDecorator.Name] = value; break; case "oauth2": - client.defaults.headers.common[securityDecorator.Name] = value; + properties.headers[securityDecorator.Name] = value; break; case "http": switch (schemeDecorator.SubType) { case "basic": break; case "bearer": - client.defaults.headers.common[securityDecorator.Name] = value.toLowerCase().startsWith("bearer ") ? value : `Bearer ${value}`; + properties.headers[securityDecorator.Name] = value.toLowerCase().startsWith("bearer ") ? value : `Bearer ${value}`; break; default: throw new Error("not supported"); @@ -194,14 +195,12 @@ function parseSecuritySchemeValue( default: throw new Error("not supported"); } - - return client; } function parseBasicAuthScheme( - client: AxiosInstance, + properties: SecurityProperties, scheme: any -): AxiosInstance { +): void { let username, password = ""; @@ -227,11 +226,7 @@ function parseBasicAuthScheme( } }); - client.defaults.headers.common["Authorization"] = `Basic ${Buffer.from( - `${username}:${password}` - ).toString("base64")}`; - - return client; + properties.headers["Authorization"] = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`; } class SecurityDecorator { diff --git a/src/internal/utils/utils.ts b/src/internal/utils/utils.ts index 4388e253..03daf883 100755 --- a/src/internal/utils/utils.ts +++ b/src/internal/utils/utils.ts @@ -81,7 +81,7 @@ export class SpeakeasyBase { for (const prop of props) { if (payload && payload.hasOwnProperty(prop.key)) { const value = payload[prop.key]; - if (isSpeakeasyBase(prop.type)) { + if (isSpeakeasyBase(prop.type) && value != null) { (this as any)[prop.key] = new prop.type(value); } else if ( prop.type.name == "Array" && @@ -176,10 +176,12 @@ export function templateUrl( params: Record ): string { let res: string = stringWithParams; - Object.entries(params).forEach(([key, value]) => { - const match: string = "{" + key + "}"; - res = res.replaceAll(match, value); - }); + if(params) { + Object.entries(params).forEach(([key, value]) => { + const match: string = "{" + key + "}"; + res = res.replaceAll(match, value); + }); + } return res; } diff --git a/src/sdk/context.ts b/src/sdk/context.ts index cae97dc4..bdfdd51d 100755 --- a/src/sdk/context.ts +++ b/src/sdk/context.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Context { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,14 +30,17 @@ export class Context { req = new operations.AddEnvironmentVariableToContextRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/context/{context-id}/environment-variable/{env-var-name}", req ); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -60,20 +49,30 @@ export class Context { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "put", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -90,19 +89,35 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.addEnvironmentVariableToContext200ApplicationJSONAnyOf = httpRes?.data; + res.addEnvironmentVariableToContext200ApplicationJSONOneOf = + JSON.parse(decodedRes); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.addEnvironmentVariableToContextDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.AddEnvironmentVariableToContextDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -121,10 +136,13 @@ export class Context { req = new operations.CreateContextRequestBody(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/context"; - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "request", "json"); @@ -133,20 +151,30 @@ export class Context { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -162,21 +190,36 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.context = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateContextContext ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.createContextDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateContextDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -195,22 +238,31 @@ export class Context { req = new operations.DeleteContextRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/context/{context-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -225,21 +277,36 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteContextMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.deleteContextDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteContextDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -261,26 +328,35 @@ export class Context { req = new operations.DeleteEnvironmentVariableFromContextRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/context/{context-id}/environment-variable/{env-var-name}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -296,22 +372,37 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteEnvironmentVariableFromContextMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.deleteEnvironmentVariableFromContextDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteEnvironmentVariableFromContextDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -333,22 +424,31 @@ export class Context { req = new operations.GetContextRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/context/{context-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -363,18 +463,36 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.context = utils.objectToClass(httpRes?.data, operations.GetContextContext); + res.context = utils.objectToClass( + JSON.parse(decodedRes), + operations.GetContextContext + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getContextDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetContextDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -396,23 +514,32 @@ export class Context { req = new operations.ListContextsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/context"; - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -427,21 +554,36 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.listContexts200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListContexts200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listContextsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListContextsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -463,27 +605,36 @@ export class Context { req = new operations.ListEnvironmentVariablesFromContextRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/context/{context-id}/environment-variable", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -499,23 +650,38 @@ export class Context { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.listEnvironmentVariablesFromContext200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListEnvironmentVariablesFromContext200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listEnvironmentVariablesFromContextDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListEnvironmentVariablesFromContextDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/insights.ts b/src/sdk/insights.ts index 773cbf59..d96c30f0 100755 --- a/src/sdk/insights.ts +++ b/src/sdk/insights.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Insights { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,23 +30,32 @@ export class Insights { req = new operations.GetAllInsightsBranchesRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/insights/{project-slug}/branches", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -76,18 +71,33 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.getAllInsightsBranches200ApplicationJSONAny = httpRes?.data; + res.getAllInsightsBranches200ApplicationJSONAny = JSON.parse(decodedRes); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getAllInsightsBranchesDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetAllInsightsBranchesDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -110,22 +120,31 @@ export class Insights { req = new operations.GetFlakyTestsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/insights/{project-slug}/flaky-tests", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -140,21 +159,36 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getFlakyTests200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetFlakyTests200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getFlakyTestsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetFlakyTestsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -166,7 +200,7 @@ export class Insights { * Job timeseries data * * @remarks - * Get timeseries data for all jobs within a workflow. + * Get timeseries data for all jobs within a workflow. Hourly granularity data is only retained for 48 hours while daily granularity data is retained for 90 days. */ async getJobTimeseries( req: operations.GetJobTimeseriesRequest, @@ -176,27 +210,36 @@ export class Insights { req = new operations.GetJobTimeseriesRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/insights/time-series/{project-slug}/workflows/{workflow-name}/jobs", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -211,21 +254,36 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getJobTimeseries200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetJobTimeseries200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getJobTimeseriesDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetJobTimeseriesDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -248,23 +306,32 @@ export class Insights { req = new operations.GetOrgSummaryDataRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/insights/{org-slug}/summary", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -279,21 +346,36 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getOrgSummaryData200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetOrgSummaryData200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getOrgSummaryDataDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetOrgSummaryDataDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -315,27 +397,36 @@ export class Insights { req = new operations.GetProjectWorkflowJobMetricsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/insights/{project-slug}/workflows/{workflow-name}/jobs", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -351,22 +442,37 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowJobMetrics200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowJobMetrics200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowJobMetricsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowJobMetricsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -388,23 +494,32 @@ export class Insights { req = new operations.GetProjectWorkflowMetricsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/insights/{project-slug}/workflows", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -420,21 +535,36 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowMetrics200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowMetrics200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowMetricsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowMetricsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -456,27 +586,36 @@ export class Insights { req = new operations.GetProjectWorkflowRunsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/insights/{project-slug}/workflows/{workflow-name}", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -492,21 +631,36 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowRuns200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowRuns200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowRunsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowRunsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -528,27 +682,36 @@ export class Insights { req = new operations.GetProjectWorkflowTestMetricsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/insights/{project-slug}/workflows/{workflow-name}/test-metrics", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -564,22 +727,37 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowTestMetrics200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowTestMetrics200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowTestMetricsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowTestMetricsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -604,27 +782,36 @@ export class Insights { req = new operations.GetProjectWorkflowsPageDataRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/insights/pages/{project-slug}/summary", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -640,22 +827,37 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowsPageData200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowsPageData200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectWorkflowsPageDataDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectWorkflowsPageDataDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -677,27 +879,36 @@ export class Insights { req = new operations.GetWorkflowSummaryRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/insights/{project-slug}/workflows/{workflow-name}/summary", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -713,21 +924,36 @@ export class Insights { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getWorkflowSummary200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWorkflowSummary200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getWorkflowSummaryDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWorkflowSummaryDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/job.ts b/src/sdk/job.ts index ad3706b3..6b404128 100755 --- a/src/sdk/job.ts +++ b/src/sdk/job.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Job { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,26 +30,35 @@ export class Job { req = new operations.CancelJobRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/job/{job-number}/cancel", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -78,21 +73,36 @@ export class Job { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CancelJobMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.cancelJobDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CancelJobDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -114,26 +124,35 @@ export class Job { req = new operations.GetJobArtifactsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/{job-number}/artifacts", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -148,21 +167,36 @@ export class Job { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.artifactListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetJobArtifactsArtifactListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getJobArtifactsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetJobArtifactsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -184,26 +218,35 @@ export class Job { req = new operations.GetJobDetailsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/job/{job-number}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -218,21 +261,36 @@ export class Job { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.jobDetails = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetJobDetailsJobDetails ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getJobDetailsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetJobDetailsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -254,26 +312,35 @@ export class Job { req = new operations.GetTestsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/{job-number}/tests", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -288,21 +355,36 @@ export class Job { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.testsResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetTestsTestsResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getTestsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetTestsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/models/errors/index.ts b/src/sdk/models/errors/index.ts new file mode 100755 index 00000000..4779e6a4 --- /dev/null +++ b/src/sdk/models/errors/index.ts @@ -0,0 +1,5 @@ +/* + * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + */ + +export * from "./sdkerror"; diff --git a/src/sdk/models/errors/sdkerror.ts b/src/sdk/models/errors/sdkerror.ts new file mode 100755 index 00000000..0d698728 --- /dev/null +++ b/src/sdk/models/errors/sdkerror.ts @@ -0,0 +1,31 @@ +/* + * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. + */ + +import { AxiosResponse } from "axios"; + +export class SDKError extends Error { + statusCode: number; + body: string; + rawResponse: AxiosResponse; + + constructor( + message: string, + statusCode: number, + body: string, + rawResponse: AxiosResponse + ) { + let bodyString = ""; + if (body?.length > 0) { + bodyString = `\n${body}`; + } + + super(`${message}: Status ${statusCode}${bodyString}`); + this.statusCode = statusCode; + this.body = body; + this.rawResponse = rawResponse; + + this.name = "SDKError"; + Object.setPrototypeOf(this, SDKError.prototype); + } +} diff --git a/src/sdk/models/operations/addenvironmentvariabletocontext.ts b/src/sdk/models/operations/addenvironmentvariabletocontext.ts index 89fe9e7e..8a6b0348 100755 --- a/src/sdk/models/operations/addenvironmentvariabletocontext.ts +++ b/src/sdk/models/operations/addenvironmentvariabletocontext.ts @@ -86,12 +86,21 @@ export class AddEnvironmentVariableToContext200ApplicationJson1 extends Speakeas } export class AddEnvironmentVariableToContextResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; @@ -99,7 +108,7 @@ export class AddEnvironmentVariableToContextResponse extends SpeakeasyBase { * The new environment variable */ @SpeakeasyMetadata() - addEnvironmentVariableToContext200ApplicationJSONAnyOf?: any; + addEnvironmentVariableToContext200ApplicationJSONOneOf?: any; /** * Error response. diff --git a/src/sdk/models/operations/approvependingapprovaljobbyid.ts b/src/sdk/models/operations/approvependingapprovaljobbyid.ts index 062bd69c..ec23e3d5 100755 --- a/src/sdk/models/operations/approvependingapprovaljobbyid.ts +++ b/src/sdk/models/operations/approvependingapprovaljobbyid.ts @@ -42,6 +42,9 @@ export class ApprovePendingApprovalJobByIdMessageResponse extends SpeakeasyBase } export class ApprovePendingApprovalJobByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -51,9 +54,15 @@ export class ApprovePendingApprovalJobByIdResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: ApprovePendingApprovalJobByIdMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/canceljob.ts b/src/sdk/models/operations/canceljob.ts index 45afb3dc..6e1811d7 100755 --- a/src/sdk/models/operations/canceljob.ts +++ b/src/sdk/models/operations/canceljob.ts @@ -42,15 +42,24 @@ export class CancelJobMessageResponse extends SpeakeasyBase { } export class CancelJobResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @SpeakeasyMetadata() messageResponse?: CancelJobMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/cancelworkflow.ts b/src/sdk/models/operations/cancelworkflow.ts index aa492583..bb09be11 100755 --- a/src/sdk/models/operations/cancelworkflow.ts +++ b/src/sdk/models/operations/cancelworkflow.ts @@ -36,6 +36,9 @@ export class CancelWorkflowMessageResponse extends SpeakeasyBase { } export class CancelWorkflowResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -45,9 +48,15 @@ export class CancelWorkflowResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: CancelWorkflowMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/continuepipeline.ts b/src/sdk/models/operations/continuepipeline.ts index f716d4a2..b935dd1b 100755 --- a/src/sdk/models/operations/continuepipeline.ts +++ b/src/sdk/models/operations/continuepipeline.ts @@ -51,6 +51,9 @@ export class ContinuePipelineMessageResponse extends SpeakeasyBase { } export class ContinuePipelineResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -60,9 +63,15 @@ export class ContinuePipelineResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: ContinuePipelineMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/createcheckoutkey.ts b/src/sdk/models/operations/createcheckoutkey.ts index 71228506..707fa3ab 100755 --- a/src/sdk/models/operations/createcheckoutkey.ts +++ b/src/sdk/models/operations/createcheckoutkey.ts @@ -99,12 +99,21 @@ export class CreateCheckoutKeyResponse extends SpeakeasyBase { @SpeakeasyMetadata() checkoutKey?: CreateCheckoutKeyCheckoutKey; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/createcontext.ts b/src/sdk/models/operations/createcontext.ts index 425ce57c..ac8f3c16 100755 --- a/src/sdk/models/operations/createcontext.ts +++ b/src/sdk/models/operations/createcontext.ts @@ -103,6 +103,9 @@ export class CreateContextContext extends SpeakeasyBase { } export class CreateContextResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -112,9 +115,15 @@ export class CreateContextResponse extends SpeakeasyBase { @SpeakeasyMetadata() context?: CreateContextContext; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/createenvvar.ts b/src/sdk/models/operations/createenvvar.ts index bb4c4232..2010f12d 100755 --- a/src/sdk/models/operations/createenvvar.ts +++ b/src/sdk/models/operations/createenvvar.ts @@ -72,6 +72,9 @@ export class CreateEnvVarEnvironmentVariable1 extends SpeakeasyBase { } export class CreateEnvVarResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -81,9 +84,15 @@ export class CreateEnvVarResponse extends SpeakeasyBase { @SpeakeasyMetadata() environmentVariable?: CreateEnvVarEnvironmentVariable1; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/createpolicybundle.ts b/src/sdk/models/operations/createpolicybundle.ts index 40d3cda5..8fff9931 100755 --- a/src/sdk/models/operations/createpolicybundle.ts +++ b/src/sdk/models/operations/createpolicybundle.ts @@ -85,6 +85,9 @@ export class CreatePolicyBundleResponse extends SpeakeasyBase { @SpeakeasyMetadata() bundleDiff?: shared.BundleDiff; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -130,9 +133,15 @@ export class CreatePolicyBundleResponse extends SpeakeasyBase { @SpeakeasyMetadata() createPolicyBundle500ApplicationJSONObject?: CreatePolicyBundle500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/createschedule.ts b/src/sdk/models/operations/createschedule.ts index 73168243..17b004b9 100755 --- a/src/sdk/models/operations/createschedule.ts +++ b/src/sdk/models/operations/createschedule.ts @@ -456,6 +456,9 @@ export class CreateScheduleSchedule extends SpeakeasyBase { } export class CreateScheduleResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -465,9 +468,15 @@ export class CreateScheduleResponse extends SpeakeasyBase { @SpeakeasyMetadata() schedule?: CreateScheduleSchedule; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/createwebhook.ts b/src/sdk/models/operations/createwebhook.ts index 43da9d2b..a156aaf9 100755 --- a/src/sdk/models/operations/createwebhook.ts +++ b/src/sdk/models/operations/createwebhook.ts @@ -190,12 +190,21 @@ export class CreateWebhookWebhook extends SpeakeasyBase { } export class CreateWebhookResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/deletecheckoutkey.ts b/src/sdk/models/operations/deletecheckoutkey.ts index 19ac283d..087dbf8e 100755 --- a/src/sdk/models/operations/deletecheckoutkey.ts +++ b/src/sdk/models/operations/deletecheckoutkey.ts @@ -42,6 +42,9 @@ export class DeleteCheckoutKeyMessageResponse extends SpeakeasyBase { } export class DeleteCheckoutKeyResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -51,9 +54,15 @@ export class DeleteCheckoutKeyResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: DeleteCheckoutKeyMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/deletecontext.ts b/src/sdk/models/operations/deletecontext.ts index 08a62b14..7b066a05 100755 --- a/src/sdk/models/operations/deletecontext.ts +++ b/src/sdk/models/operations/deletecontext.ts @@ -36,6 +36,9 @@ export class DeleteContextMessageResponse extends SpeakeasyBase { } export class DeleteContextResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -45,9 +48,15 @@ export class DeleteContextResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: DeleteContextMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/deleteenvironmentvariablefromcontext.ts b/src/sdk/models/operations/deleteenvironmentvariablefromcontext.ts index e25d8646..90e59d8f 100755 --- a/src/sdk/models/operations/deleteenvironmentvariablefromcontext.ts +++ b/src/sdk/models/operations/deleteenvironmentvariablefromcontext.ts @@ -42,6 +42,9 @@ export class DeleteEnvironmentVariableFromContextMessageResponse extends Speakea } export class DeleteEnvironmentVariableFromContextResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -51,9 +54,15 @@ export class DeleteEnvironmentVariableFromContextResponse extends SpeakeasyBase @SpeakeasyMetadata() messageResponse?: DeleteEnvironmentVariableFromContextMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/deleteenvvar.ts b/src/sdk/models/operations/deleteenvvar.ts index 567fd6cd..bd94c6f0 100755 --- a/src/sdk/models/operations/deleteenvvar.ts +++ b/src/sdk/models/operations/deleteenvvar.ts @@ -42,6 +42,9 @@ export class DeleteEnvVarMessageResponse extends SpeakeasyBase { } export class DeleteEnvVarResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -51,9 +54,15 @@ export class DeleteEnvVarResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: DeleteEnvVarMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/deleteorgclaims.ts b/src/sdk/models/operations/deleteorgclaims.ts index 8b69290d..8ddb9dab 100755 --- a/src/sdk/models/operations/deleteorgclaims.ts +++ b/src/sdk/models/operations/deleteorgclaims.ts @@ -58,6 +58,9 @@ export class DeleteOrgClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() claimResponse?: shared.ClaimResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -85,9 +88,15 @@ export class DeleteOrgClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() deleteOrgClaims500ApplicationJSONObject?: DeleteOrgClaims500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/deleteprojectclaims.ts b/src/sdk/models/operations/deleteprojectclaims.ts index 32c9aa43..50597960 100755 --- a/src/sdk/models/operations/deleteprojectclaims.ts +++ b/src/sdk/models/operations/deleteprojectclaims.ts @@ -61,6 +61,9 @@ export class DeleteProjectClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() claimResponse?: shared.ClaimResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -88,9 +91,15 @@ export class DeleteProjectClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() deleteProjectClaims500ApplicationJSONObject?: DeleteProjectClaims500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/deleteschedulebyid.ts b/src/sdk/models/operations/deleteschedulebyid.ts index 1b44275c..645950f3 100755 --- a/src/sdk/models/operations/deleteschedulebyid.ts +++ b/src/sdk/models/operations/deleteschedulebyid.ts @@ -36,6 +36,9 @@ export class DeleteScheduleByIdMessageResponse extends SpeakeasyBase { } export class DeleteScheduleByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -45,9 +48,15 @@ export class DeleteScheduleByIdResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: DeleteScheduleByIdMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/deletewebhook.ts b/src/sdk/models/operations/deletewebhook.ts index 1e665b7a..b2192b75 100755 --- a/src/sdk/models/operations/deletewebhook.ts +++ b/src/sdk/models/operations/deletewebhook.ts @@ -36,6 +36,9 @@ export class DeleteWebhookMessageResponse extends SpeakeasyBase { } export class DeleteWebhookResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -45,9 +48,15 @@ export class DeleteWebhookResponse extends SpeakeasyBase { @SpeakeasyMetadata() messageResponse?: DeleteWebhookMessageResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getallinsightsbranches.ts b/src/sdk/models/operations/getallinsightsbranches.ts index bc7ac36e..0271ad57 100755 --- a/src/sdk/models/operations/getallinsightsbranches.ts +++ b/src/sdk/models/operations/getallinsightsbranches.ts @@ -30,12 +30,21 @@ export class GetAllInsightsBranchesDefaultApplicationJSON extends SpeakeasyBase } export class GetAllInsightsBranchesResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getcheckoutkey.ts b/src/sdk/models/operations/getcheckoutkey.ts index 279b4165..800bf9b2 100755 --- a/src/sdk/models/operations/getcheckoutkey.ts +++ b/src/sdk/models/operations/getcheckoutkey.ts @@ -85,12 +85,21 @@ export class GetCheckoutKeyResponse extends SpeakeasyBase { @SpeakeasyMetadata() checkoutKey?: GetCheckoutKeyCheckoutKey; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getcollaborations.ts b/src/sdk/models/operations/getcollaborations.ts index 90897324..6fd841a3 100755 --- a/src/sdk/models/operations/getcollaborations.ts +++ b/src/sdk/models/operations/getcollaborations.ts @@ -59,12 +59,21 @@ export class GetCollaborationsResponse extends SpeakeasyBase { @SpeakeasyMetadata({ elemType: GetCollaborationsCollaboration }) collaborations?: GetCollaborationsCollaboration[]; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getcontext.ts b/src/sdk/models/operations/getcontext.ts index cb0d3f6c..553ab15e 100755 --- a/src/sdk/models/operations/getcontext.ts +++ b/src/sdk/models/operations/getcontext.ts @@ -51,6 +51,9 @@ export class GetContextContext extends SpeakeasyBase { } export class GetContextResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -60,9 +63,15 @@ export class GetContextResponse extends SpeakeasyBase { @SpeakeasyMetadata() context?: GetContextContext; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getcurrentuser.ts b/src/sdk/models/operations/getcurrentuser.ts index e2f198f4..8f2ae2b1 100755 --- a/src/sdk/models/operations/getcurrentuser.ts +++ b/src/sdk/models/operations/getcurrentuser.ts @@ -42,12 +42,21 @@ export class GetCurrentUserUser extends SpeakeasyBase { } export class GetCurrentUserResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getdecisionlog.ts b/src/sdk/models/operations/getdecisionlog.ts index 6d3ac5d2..99aa7ce4 100755 --- a/src/sdk/models/operations/getdecisionlog.ts +++ b/src/sdk/models/operations/getdecisionlog.ts @@ -76,6 +76,9 @@ export class GetDecisionLog400ApplicationJSON extends SpeakeasyBase { } export class GetDecisionLogResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -127,9 +130,15 @@ export class GetDecisionLogResponse extends SpeakeasyBase { @SpeakeasyMetadata() getDecisionLog500ApplicationJSONObject?: GetDecisionLog500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getdecisionlogpolicybundle.ts b/src/sdk/models/operations/getdecisionlogpolicybundle.ts index e17d284e..6234f938 100755 --- a/src/sdk/models/operations/getdecisionlogpolicybundle.ts +++ b/src/sdk/models/operations/getdecisionlogpolicybundle.ts @@ -75,6 +75,9 @@ export class GetDecisionLogPolicyBundle400ApplicationJSON extends SpeakeasyBase } export class GetDecisionLogPolicyBundleResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -126,9 +129,15 @@ export class GetDecisionLogPolicyBundleResponse extends SpeakeasyBase { @SpeakeasyMetadata() policyBundle?: Record; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getdecisionlogs.ts b/src/sdk/models/operations/getdecisionlogs.ts index 5fed5261..0281f672 100755 --- a/src/sdk/models/operations/getdecisionlogs.ts +++ b/src/sdk/models/operations/getdecisionlogs.ts @@ -26,6 +26,12 @@ export class GetDecisionLogsRequest extends SpeakeasyBase { @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=branch" }) branch?: string; + /** + * Return decisions made for this build number. + */ + @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=build_number" }) + buildNumber?: string; + @SpeakeasyMetadata({ data: "pathParam, style=simple;explode=false;name=context" }) context: string; @@ -97,6 +103,9 @@ export class GetDecisionLogs400ApplicationJSON extends SpeakeasyBase { } export class GetDecisionLogsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -139,9 +148,15 @@ export class GetDecisionLogsResponse extends SpeakeasyBase { @SpeakeasyMetadata() getDecisionLogs500ApplicationJSONObject?: GetDecisionLogs500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getdecisionsettings.ts b/src/sdk/models/operations/getdecisionsettings.ts index 83f25b2b..56f07773 100755 --- a/src/sdk/models/operations/getdecisionsettings.ts +++ b/src/sdk/models/operations/getdecisionsettings.ts @@ -61,6 +61,9 @@ export class GetDecisionSettings400ApplicationJSON extends SpeakeasyBase { } export class GetDecisionSettingsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -103,9 +106,15 @@ export class GetDecisionSettingsResponse extends SpeakeasyBase { @SpeakeasyMetadata() getDecisionSettings500ApplicationJSONObject?: GetDecisionSettings500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getenvvar.ts b/src/sdk/models/operations/getenvvar.ts index 1c38ec9d..b25d1928 100755 --- a/src/sdk/models/operations/getenvvar.ts +++ b/src/sdk/models/operations/getenvvar.ts @@ -56,6 +56,9 @@ export class GetEnvVarEnvironmentVariable extends SpeakeasyBase { } export class GetEnvVarResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -65,9 +68,15 @@ export class GetEnvVarResponse extends SpeakeasyBase { @SpeakeasyMetadata() environmentVariable?: GetEnvVarEnvironmentVariable; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getflakytests.ts b/src/sdk/models/operations/getflakytests.ts index 0e0688e3..4345bd53 100755 --- a/src/sdk/models/operations/getflakytests.ts +++ b/src/sdk/models/operations/getflakytests.ts @@ -127,12 +127,21 @@ export class GetFlakyTests200ApplicationJSON extends SpeakeasyBase { } export class GetFlakyTestsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getjobartifacts.ts b/src/sdk/models/operations/getjobartifacts.ts index 857ffe89..0f4965c3 100755 --- a/src/sdk/models/operations/getjobartifacts.ts +++ b/src/sdk/models/operations/getjobartifacts.ts @@ -79,12 +79,21 @@ export class GetJobArtifactsResponse extends SpeakeasyBase { @SpeakeasyMetadata() artifactListResponse?: GetJobArtifactsArtifactListResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getjobdetails.ts b/src/sdk/models/operations/getjobdetails.ts index 7c07a6dc..add76ad9 100755 --- a/src/sdk/models/operations/getjobdetails.ts +++ b/src/sdk/models/operations/getjobdetails.ts @@ -342,6 +342,9 @@ export class GetJobDetailsJobDetails extends SpeakeasyBase { } export class GetJobDetailsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -351,9 +354,15 @@ export class GetJobDetailsResponse extends SpeakeasyBase { @SpeakeasyMetadata() jobDetails?: GetJobDetailsJobDetails; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getjobtimeseries.ts b/src/sdk/models/operations/getjobtimeseries.ts index 2149f8e2..8643f964 100755 --- a/src/sdk/models/operations/getjobtimeseries.ts +++ b/src/sdk/models/operations/getjobtimeseries.ts @@ -149,7 +149,7 @@ export class GetJobTimeseries200ApplicationJSONItemsMetrics extends SpeakeasyBas totalCreditsUsed: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -218,12 +218,21 @@ export class GetJobTimeseries200ApplicationJSON extends SpeakeasyBase { } export class GetJobTimeseriesResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getorgclaims.ts b/src/sdk/models/operations/getorgclaims.ts index ca973fa4..7747ac7c 100755 --- a/src/sdk/models/operations/getorgclaims.ts +++ b/src/sdk/models/operations/getorgclaims.ts @@ -52,6 +52,9 @@ export class GetOrgClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() claimResponse?: shared.ClaimResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -79,9 +82,15 @@ export class GetOrgClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() getOrgClaims500ApplicationJSONObject?: GetOrgClaims500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getorgsummarydata.ts b/src/sdk/models/operations/getorgsummarydata.ts index 6d074c64..a0b9dccb 100755 --- a/src/sdk/models/operations/getorgsummarydata.ts +++ b/src/sdk/models/operations/getorgsummarydata.ts @@ -6,6 +6,11 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { AxiosResponse } from "axios"; import { Expose, Type } from "class-transformer"; +/** + * List of project names. + */ +export class GetOrgSummaryDataProjectNames extends SpeakeasyBase {} + /** * The time window used to calculate summary metrics. */ @@ -28,7 +33,7 @@ export class GetOrgSummaryDataRequest extends SpeakeasyBase { * List of project names. */ @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=project-names" }) - projectNames?: Record; + projectNames?: GetOrgSummaryDataProjectNames; /** * The time window used to calculate summary metrics. @@ -76,7 +81,7 @@ export class GetOrgSummaryData200ApplicationJSONOrgDataMetrics extends Speakeasy totalDurationSecs: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -167,7 +172,7 @@ export class GetOrgSummaryData200ApplicationJSONOrgProjectDataMetrics extends Sp totalDurationSecs: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -261,12 +266,21 @@ export class GetOrgSummaryData200ApplicationJSON extends SpeakeasyBase { } export class GetOrgSummaryDataResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getpipelinebyid.ts b/src/sdk/models/operations/getpipelinebyid.ts index 9fbde03a..4af77556 100755 --- a/src/sdk/models/operations/getpipelinebyid.ts +++ b/src/sdk/models/operations/getpipelinebyid.ts @@ -288,6 +288,9 @@ export class GetPipelineByIdPipeline extends SpeakeasyBase { } export class GetPipelineByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -297,9 +300,15 @@ export class GetPipelineByIdResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipeline?: GetPipelineByIdPipeline; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getpipelinebynumber.ts b/src/sdk/models/operations/getpipelinebynumber.ts index ce84b8bd..e85ed903 100755 --- a/src/sdk/models/operations/getpipelinebynumber.ts +++ b/src/sdk/models/operations/getpipelinebynumber.ts @@ -294,6 +294,9 @@ export class GetPipelineByNumberPipeline extends SpeakeasyBase { } export class GetPipelineByNumberResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -303,9 +306,15 @@ export class GetPipelineByNumberResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipeline?: GetPipelineByNumberPipeline; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getpipelineconfigbyid.ts b/src/sdk/models/operations/getpipelineconfigbyid.ts index 95253a5a..3a18335a 100755 --- a/src/sdk/models/operations/getpipelineconfigbyid.ts +++ b/src/sdk/models/operations/getpipelineconfigbyid.ts @@ -57,6 +57,9 @@ export class GetPipelineConfigByIdPipelineConfig extends SpeakeasyBase { } export class GetPipelineConfigByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -66,9 +69,15 @@ export class GetPipelineConfigByIdResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipelineConfig?: GetPipelineConfigByIdPipelineConfig; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getpolicybundle.ts b/src/sdk/models/operations/getpolicybundle.ts index 011e1681..279dc741 100755 --- a/src/sdk/models/operations/getpolicybundle.ts +++ b/src/sdk/models/operations/getpolicybundle.ts @@ -60,6 +60,9 @@ export class GetPolicyBundle400ApplicationJSON extends SpeakeasyBase { } export class GetPolicyBundleResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -102,9 +105,15 @@ export class GetPolicyBundleResponse extends SpeakeasyBase { @SpeakeasyMetadata() policyBundle?: Record; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getpolicydocument.ts b/src/sdk/models/operations/getpolicydocument.ts index 850f0677..c70684f2 100755 --- a/src/sdk/models/operations/getpolicydocument.ts +++ b/src/sdk/models/operations/getpolicydocument.ts @@ -79,6 +79,9 @@ export class GetPolicyDocument400ApplicationJSON extends SpeakeasyBase { } export class GetPolicyDocumentResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -130,9 +133,15 @@ export class GetPolicyDocumentResponse extends SpeakeasyBase { @SpeakeasyMetadata() policy?: shared.Policy; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getprojectbyslug.ts b/src/sdk/models/operations/getprojectbyslug.ts index 8f27c3e2..74bb1f15 100755 --- a/src/sdk/models/operations/getprojectbyslug.ts +++ b/src/sdk/models/operations/getprojectbyslug.ts @@ -108,6 +108,9 @@ export class GetProjectBySlugProject extends SpeakeasyBase { } export class GetProjectBySlugResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -117,9 +120,15 @@ export class GetProjectBySlugResponse extends SpeakeasyBase { @SpeakeasyMetadata() project?: GetProjectBySlugProject; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getprojectclaims.ts b/src/sdk/models/operations/getprojectclaims.ts index 085f3709..77c77e7b 100755 --- a/src/sdk/models/operations/getprojectclaims.ts +++ b/src/sdk/models/operations/getprojectclaims.ts @@ -55,6 +55,9 @@ export class GetProjectClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() claimResponse?: shared.ClaimResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -82,9 +85,15 @@ export class GetProjectClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() getProjectClaims500ApplicationJSONObject?: GetProjectClaims500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/getprojectworkflowjobmetrics.ts b/src/sdk/models/operations/getprojectworkflowjobmetrics.ts index dcbf5317..bfc978d5 100755 --- a/src/sdk/models/operations/getprojectworkflowjobmetrics.ts +++ b/src/sdk/models/operations/getprojectworkflowjobmetrics.ts @@ -156,7 +156,7 @@ export class GetProjectWorkflowJobMetrics200ApplicationJSONItemsMetrics extends totalCreditsUsed: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -180,7 +180,7 @@ export class GetProjectWorkflowJobMetrics200ApplicationJSONItems extends Speakea name: string; /** - * The end of the aggregation window for job metrics. + * The timestamp of the last build within the requested reporting window. */ @SpeakeasyMetadata() @Expose({ name: "window_end" }) @@ -188,7 +188,7 @@ export class GetProjectWorkflowJobMetrics200ApplicationJSONItems extends Speakea windowEnd: Date; /** - * The start of the aggregation window for job metrics. + * The timestamp of the first build within the requested reporting window. */ @SpeakeasyMetadata() @Expose({ name: "window_start" }) @@ -217,12 +217,21 @@ export class GetProjectWorkflowJobMetrics200ApplicationJSON extends SpeakeasyBas } export class GetProjectWorkflowJobMetricsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getprojectworkflowmetrics.ts b/src/sdk/models/operations/getprojectworkflowmetrics.ts index 617e85c0..64e162dc 100755 --- a/src/sdk/models/operations/getprojectworkflowmetrics.ts +++ b/src/sdk/models/operations/getprojectworkflowmetrics.ts @@ -164,7 +164,7 @@ export class GetProjectWorkflowMetrics200ApplicationJSONItemsMetrics extends Spe totalRecoveries: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -188,7 +188,14 @@ export class GetProjectWorkflowMetrics200ApplicationJSONItems extends SpeakeasyB name: string; /** - * The end of the aggregation window for workflow metrics. + * The unique ID of the project + */ + @SpeakeasyMetadata() + @Expose({ name: "project_id" }) + projectId: any; + + /** + * The timestamp of the last build within the requested reporting window. */ @SpeakeasyMetadata() @Expose({ name: "window_end" }) @@ -196,7 +203,7 @@ export class GetProjectWorkflowMetrics200ApplicationJSONItems extends SpeakeasyB windowEnd: Date; /** - * The start of the aggregation window for workflow metrics. + * The timestamp of the first build within the requested reporting window. */ @SpeakeasyMetadata() @Expose({ name: "window_start" }) @@ -225,12 +232,21 @@ export class GetProjectWorkflowMetrics200ApplicationJSON extends SpeakeasyBase { } export class GetProjectWorkflowMetricsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getprojectworkflowruns.ts b/src/sdk/models/operations/getprojectworkflowruns.ts index f5df8c9d..9b2e0780 100755 --- a/src/sdk/models/operations/getprojectworkflowruns.ts +++ b/src/sdk/models/operations/getprojectworkflowruns.ts @@ -107,6 +107,13 @@ export class GetProjectWorkflowRuns200ApplicationJSONItems extends SpeakeasyBase @Expose({ name: "id" }) id: string; + /** + * Describes if the job is an approval job or not. Approval jobs are intermediary jobs that are created to pause the workflow until approved. + */ + @SpeakeasyMetadata() + @Expose({ name: "is_approval" }) + isApproval: boolean; + /** * Workflow status. */ @@ -144,12 +151,21 @@ export class GetProjectWorkflowRuns200ApplicationJSON extends SpeakeasyBase { } export class GetProjectWorkflowRunsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getprojectworkflowspagedata.ts b/src/sdk/models/operations/getprojectworkflowspagedata.ts index b5b6825d..7ec75e2a 100755 --- a/src/sdk/models/operations/getprojectworkflowspagedata.ts +++ b/src/sdk/models/operations/getprojectworkflowspagedata.ts @@ -6,6 +6,11 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { AxiosResponse } from "axios"; import { Expose, Type } from "class-transformer"; +/** + * The names of VCS branches to include in branch-level workflow metrics. + */ +export class GetProjectWorkflowsPageDataBranches extends SpeakeasyBase {} + /** * The time window used to calculate summary metrics. */ @@ -17,12 +22,17 @@ export enum GetProjectWorkflowsPageDataReportingWindow { Last60Days = "last-60-days", } +/** + * The names of workflows to include in workflow-level metrics. + */ +export class GetProjectWorkflowsPageDataWorkflowNames extends SpeakeasyBase {} + export class GetProjectWorkflowsPageDataRequest extends SpeakeasyBase { /** * The names of VCS branches to include in branch-level workflow metrics. */ @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=branches" }) - branches?: Record; + branches?: GetProjectWorkflowsPageDataBranches; /** * Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. @@ -40,7 +50,7 @@ export class GetProjectWorkflowsPageDataRequest extends SpeakeasyBase { * The names of workflows to include in workflow-level metrics. */ @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=workflow-names" }) - workflowNames?: Record; + workflowNames?: GetProjectWorkflowsPageDataWorkflowNames; } /** @@ -82,7 +92,7 @@ export class GetProjectWorkflowsPageData200ApplicationJSONProjectDataMetrics ext totalDurationSecs: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -173,7 +183,7 @@ export class GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowBranchD totalCreditsUsed: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -268,7 +278,7 @@ export class GetProjectWorkflowsPageData200ApplicationJSONProjectWorkflowDataMet totalCreditsUsed: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) @@ -395,12 +405,21 @@ export class GetProjectWorkflowsPageData200ApplicationJSON extends SpeakeasyBase } export class GetProjectWorkflowsPageDataResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getprojectworkflowtestmetrics.ts b/src/sdk/models/operations/getprojectworkflowtestmetrics.ts index be835068..cffa6254 100755 --- a/src/sdk/models/operations/getprojectworkflowtestmetrics.ts +++ b/src/sdk/models/operations/getprojectworkflowtestmetrics.ts @@ -300,12 +300,21 @@ export class GetProjectWorkflowTestMetrics200ApplicationJSON extends SpeakeasyBa } export class GetProjectWorkflowTestMetricsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getschedulebyid.ts b/src/sdk/models/operations/getschedulebyid.ts index 6982a8fc..1eef879d 100755 --- a/src/sdk/models/operations/getschedulebyid.ts +++ b/src/sdk/models/operations/getschedulebyid.ts @@ -263,6 +263,9 @@ export class GetScheduleByIdSchedule extends SpeakeasyBase { } export class GetScheduleByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -272,9 +275,15 @@ export class GetScheduleByIdResponse extends SpeakeasyBase { @SpeakeasyMetadata() schedule?: GetScheduleByIdSchedule; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/gettests.ts b/src/sdk/models/operations/gettests.ts index 2fa5ec7a..535e0008 100755 --- a/src/sdk/models/operations/gettests.ts +++ b/src/sdk/models/operations/gettests.ts @@ -98,12 +98,21 @@ export class GetTestsTestsResponse extends SpeakeasyBase { } export class GetTestsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getuser.ts b/src/sdk/models/operations/getuser.ts index 300d6e1b..3d45daa9 100755 --- a/src/sdk/models/operations/getuser.ts +++ b/src/sdk/models/operations/getuser.ts @@ -50,12 +50,21 @@ export class GetUserUser extends SpeakeasyBase { } export class GetUserResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getwebhookbyid.ts b/src/sdk/models/operations/getwebhookbyid.ts index 8dcc75ed..c4ea52aa 100755 --- a/src/sdk/models/operations/getwebhookbyid.ts +++ b/src/sdk/models/operations/getwebhookbyid.ts @@ -119,12 +119,21 @@ export class GetWebhookByIdWebhook extends SpeakeasyBase { } export class GetWebhookByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getwebhooks.ts b/src/sdk/models/operations/getwebhooks.ts index b27df25f..420c3242 100755 --- a/src/sdk/models/operations/getwebhooks.ts +++ b/src/sdk/models/operations/getwebhooks.ts @@ -146,12 +146,21 @@ export class GetWebhooks200ApplicationJSON extends SpeakeasyBase { } export class GetWebhooksResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getworkflowbyid.ts b/src/sdk/models/operations/getworkflowbyid.ts index e841b30b..be6472ce 100755 --- a/src/sdk/models/operations/getworkflowbyid.ts +++ b/src/sdk/models/operations/getworkflowbyid.ts @@ -128,12 +128,21 @@ export class GetWorkflowByIdWorkflow extends SpeakeasyBase { } export class GetWorkflowByIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/getworkflowsummary.ts b/src/sdk/models/operations/getworkflowsummary.ts index 72405625..1b4b23f6 100755 --- a/src/sdk/models/operations/getworkflowsummary.ts +++ b/src/sdk/models/operations/getworkflowsummary.ts @@ -14,10 +14,10 @@ export class GetWorkflowSummaryRequest extends SpeakeasyBase { allBranches?: boolean; /** - * The names of VCS branches to include in branch-level workflow metrics. + * The name of a vcs branch. If not passed we will scope the API call to the default branch. */ - @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=branches" }) - branches?: Record; + @SpeakeasyMetadata({ data: "queryParam, style=form;explode=true;name=branch" }) + branch?: string; /** * Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. @@ -92,6 +92,13 @@ export class GetWorkflowSummary200ApplicationJSONMetricsDurationMetrics extends * Metrics aggregated across a workflow for a given time window. */ export class GetWorkflowSummary200ApplicationJSONMetrics extends SpeakeasyBase { + /** + * The number of runs that ran to completion within the aggregation window + */ + @SpeakeasyMetadata() + @Expose({ name: "completed_runs" }) + completedRuns: number; + /** * Metrics relating to the duration of runs for a workflow. */ @@ -140,14 +147,14 @@ export class GetWorkflowSummary200ApplicationJSONMetrics extends SpeakeasyBase { totalCreditsUsed: number; /** - * The total number of runs. + * The total number of runs, including runs that are still on-hold or running. */ @SpeakeasyMetadata() @Expose({ name: "total_runs" }) totalRuns: number; /** - * The end of the aggregation window for workflow metrics. + * The timestamp of the last build within the requested reporting window. */ @SpeakeasyMetadata() @Expose({ name: "window_end" }) @@ -155,7 +162,7 @@ export class GetWorkflowSummary200ApplicationJSONMetrics extends SpeakeasyBase { windowEnd: Date; /** - * The start of the aggregation window for workflow metrics. + * The timestamp of the first build within the requested reporting window. */ @SpeakeasyMetadata() @Expose({ name: "window_start" }) @@ -253,12 +260,21 @@ export class GetWorkflowSummary200ApplicationJSON extends SpeakeasyBase { } export class GetWorkflowSummaryResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listcheckoutkeys.ts b/src/sdk/models/operations/listcheckoutkeys.ts index f92885f6..82cf76c0 100755 --- a/src/sdk/models/operations/listcheckoutkeys.ts +++ b/src/sdk/models/operations/listcheckoutkeys.ts @@ -96,12 +96,21 @@ export class ListCheckoutKeysResponse extends SpeakeasyBase { @SpeakeasyMetadata() checkoutKeyListResponse?: ListCheckoutKeysCheckoutKeyListResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listcontexts.ts b/src/sdk/models/operations/listcontexts.ts index 10dcbeff..cefbe10a 100755 --- a/src/sdk/models/operations/listcontexts.ts +++ b/src/sdk/models/operations/listcontexts.ts @@ -91,12 +91,21 @@ export class ListContexts200ApplicationJSON extends SpeakeasyBase { } export class ListContextsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listenvironmentvariablesfromcontext.ts b/src/sdk/models/operations/listenvironmentvariablesfromcontext.ts index 76e4a5ed..b29eb5d8 100755 --- a/src/sdk/models/operations/listenvironmentvariablesfromcontext.ts +++ b/src/sdk/models/operations/listenvironmentvariablesfromcontext.ts @@ -79,12 +79,21 @@ export class ListEnvironmentVariablesFromContext200ApplicationJSON extends Speak } export class ListEnvironmentVariablesFromContextResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listenvvars.ts b/src/sdk/models/operations/listenvvars.ts index faa7921a..c5034d2c 100755 --- a/src/sdk/models/operations/listenvvars.ts +++ b/src/sdk/models/operations/listenvvars.ts @@ -67,6 +67,9 @@ export class ListEnvVarsEnvironmentVariableListResponse extends SpeakeasyBase { } export class ListEnvVarsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -76,9 +79,15 @@ export class ListEnvVarsResponse extends SpeakeasyBase { @SpeakeasyMetadata() environmentVariableListResponse?: ListEnvVarsEnvironmentVariableListResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listmypipelines.ts b/src/sdk/models/operations/listmypipelines.ts index a117c084..ad85c867 100755 --- a/src/sdk/models/operations/listmypipelines.ts +++ b/src/sdk/models/operations/listmypipelines.ts @@ -311,6 +311,9 @@ export class ListMyPipelinesPipelineListResponse extends SpeakeasyBase { } export class ListMyPipelinesResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -320,9 +323,15 @@ export class ListMyPipelinesResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipelineListResponse?: ListMyPipelinesPipelineListResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listpipelines.ts b/src/sdk/models/operations/listpipelines.ts index 2ccaec1d..ca8eb8aa 100755 --- a/src/sdk/models/operations/listpipelines.ts +++ b/src/sdk/models/operations/listpipelines.ts @@ -317,6 +317,9 @@ export class ListPipelinesPipelineListResponse extends SpeakeasyBase { } export class ListPipelinesResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -326,9 +329,15 @@ export class ListPipelinesResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipelineListResponse?: ListPipelinesPipelineListResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listpipelinesforproject.ts b/src/sdk/models/operations/listpipelinesforproject.ts index 01585054..0ce0542f 100755 --- a/src/sdk/models/operations/listpipelinesforproject.ts +++ b/src/sdk/models/operations/listpipelinesforproject.ts @@ -317,6 +317,9 @@ export class ListPipelinesForProjectPipelineListResponse extends SpeakeasyBase { } export class ListPipelinesForProjectResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -326,9 +329,15 @@ export class ListPipelinesForProjectResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipelineListResponse?: ListPipelinesForProjectPipelineListResponse; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listschedulesforproject.ts b/src/sdk/models/operations/listschedulesforproject.ts index 9441d6cb..113b8bec 100755 --- a/src/sdk/models/operations/listschedulesforproject.ts +++ b/src/sdk/models/operations/listschedulesforproject.ts @@ -286,12 +286,21 @@ export class ListSchedulesForProject200ApplicationJSON extends SpeakeasyBase { } export class ListSchedulesForProjectResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listworkflowjobs.ts b/src/sdk/models/operations/listworkflowjobs.ts index fcdb9009..ccc91629 100755 --- a/src/sdk/models/operations/listworkflowjobs.ts +++ b/src/sdk/models/operations/listworkflowjobs.ts @@ -160,12 +160,21 @@ export class ListWorkflowJobsWorkflowJobListResponse extends SpeakeasyBase { } export class ListWorkflowJobsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/listworkflowsbypipelineid.ts b/src/sdk/models/operations/listworkflowsbypipelineid.ts index 472e9a34..38ae12f3 100755 --- a/src/sdk/models/operations/listworkflowsbypipelineid.ts +++ b/src/sdk/models/operations/listworkflowsbypipelineid.ts @@ -154,12 +154,21 @@ export class ListWorkflowsByPipelineIdWorkflowListResponse extends SpeakeasyBase } export class ListWorkflowsByPipelineIdResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/makedecision.ts b/src/sdk/models/operations/makedecision.ts index 1800587b..85e40154 100755 --- a/src/sdk/models/operations/makedecision.ts +++ b/src/sdk/models/operations/makedecision.ts @@ -5,7 +5,9 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import * as shared from "../shared"; import { AxiosResponse } from "axios"; -import { Expose } from "class-transformer"; +import { Expose, Type } from "class-transformer"; + +export class MakeDecisionRequestBodyMetadata extends SpeakeasyBase {} export class MakeDecisionRequestBody extends SpeakeasyBase { @SpeakeasyMetadata() @@ -14,7 +16,8 @@ export class MakeDecisionRequestBody extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "metadata" }) - metadata?: Record; + @Type(() => MakeDecisionRequestBodyMetadata) + metadata?: MakeDecisionRequestBodyMetadata; } export class MakeDecisionRequest extends SpeakeasyBase { @@ -62,6 +65,9 @@ export class MakeDecision400ApplicationJSON extends SpeakeasyBase { } export class MakeDecisionResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -95,9 +101,15 @@ export class MakeDecisionResponse extends SpeakeasyBase { @SpeakeasyMetadata() makeDecision500ApplicationJSONObject?: MakeDecision500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/patchorgclaims.ts b/src/sdk/models/operations/patchorgclaims.ts index cc9484d4..1b8c195e 100755 --- a/src/sdk/models/operations/patchorgclaims.ts +++ b/src/sdk/models/operations/patchorgclaims.ts @@ -55,6 +55,9 @@ export class PatchOrgClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() claimResponse?: shared.ClaimResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -82,9 +85,15 @@ export class PatchOrgClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() patchOrgClaims500ApplicationJSONObject?: PatchOrgClaims500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/patchprojectclaims.ts b/src/sdk/models/operations/patchprojectclaims.ts index ed1330c9..edac0e1c 100755 --- a/src/sdk/models/operations/patchprojectclaims.ts +++ b/src/sdk/models/operations/patchprojectclaims.ts @@ -58,6 +58,9 @@ export class PatchProjectClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() claimResponse?: shared.ClaimResponse; + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -85,9 +88,15 @@ export class PatchProjectClaimsResponse extends SpeakeasyBase { @SpeakeasyMetadata() patchProjectClaims500ApplicationJSONObject?: PatchProjectClaims500ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; } diff --git a/src/sdk/models/operations/rerunworkflow.ts b/src/sdk/models/operations/rerunworkflow.ts index 610b80d5..34e754f5 100755 --- a/src/sdk/models/operations/rerunworkflow.ts +++ b/src/sdk/models/operations/rerunworkflow.ts @@ -72,12 +72,21 @@ export class RerunWorkflow202ApplicationJSON extends SpeakeasyBase { } export class RerunWorkflowResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/setdecisionsettings.ts b/src/sdk/models/operations/setdecisionsettings.ts index f034a1ab..171e0594 100755 --- a/src/sdk/models/operations/setdecisionsettings.ts +++ b/src/sdk/models/operations/setdecisionsettings.ts @@ -64,6 +64,9 @@ export class SetDecisionSettings400ApplicationJSON extends SpeakeasyBase { } export class SetDecisionSettingsResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -91,9 +94,15 @@ export class SetDecisionSettingsResponse extends SpeakeasyBase { @SpeakeasyMetadata() setDecisionSettings403ApplicationJSONObject?: SetDecisionSettings403ApplicationJSON; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/triggerpipeline.ts b/src/sdk/models/operations/triggerpipeline.ts index ce7e5915..4691431f 100755 --- a/src/sdk/models/operations/triggerpipeline.ts +++ b/src/sdk/models/operations/triggerpipeline.ts @@ -98,6 +98,9 @@ export class TriggerPipelinePipelineCreation extends SpeakeasyBase { } export class TriggerPipelineResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -107,9 +110,15 @@ export class TriggerPipelineResponse extends SpeakeasyBase { @SpeakeasyMetadata() pipelineCreation?: TriggerPipelinePipelineCreation; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/updateschedule.ts b/src/sdk/models/operations/updateschedule.ts index ebf91770..52992db6 100755 --- a/src/sdk/models/operations/updateschedule.ts +++ b/src/sdk/models/operations/updateschedule.ts @@ -386,6 +386,9 @@ export class UpdateScheduleSchedule extends SpeakeasyBase { } export class UpdateScheduleResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; @@ -395,9 +398,15 @@ export class UpdateScheduleResponse extends SpeakeasyBase { @SpeakeasyMetadata() schedule?: UpdateScheduleSchedule; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/operations/updatewebhook.ts b/src/sdk/models/operations/updatewebhook.ts index e4ba75a6..a53fa47c 100755 --- a/src/sdk/models/operations/updatewebhook.ts +++ b/src/sdk/models/operations/updatewebhook.ts @@ -167,12 +167,21 @@ export class UpdateWebhookWebhook extends SpeakeasyBase { } export class UpdateWebhookResponse extends SpeakeasyBase { + /** + * HTTP response content type for this operation + */ @SpeakeasyMetadata() contentType: string; + /** + * HTTP response status code for this operation + */ @SpeakeasyMetadata() statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ @SpeakeasyMetadata() rawResponse?: AxiosResponse; diff --git a/src/sdk/models/shared/bundlediff.ts b/src/sdk/models/shared/bundlediff.ts index 5fc12ef8..153ffb06 100755 --- a/src/sdk/models/shared/bundlediff.ts +++ b/src/sdk/models/shared/bundlediff.ts @@ -5,9 +5,6 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { Expose } from "class-transformer"; -/** - * Policy-Bundle diff successfully returned. - */ export class BundleDiff extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "created" }) diff --git a/src/sdk/models/shared/claimresponse.ts b/src/sdk/models/shared/claimresponse.ts index 94a43065..654fdd7a 100755 --- a/src/sdk/models/shared/claimresponse.ts +++ b/src/sdk/models/shared/claimresponse.ts @@ -5,9 +5,6 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { Expose, Transform } from "class-transformer"; -/** - * Claims successfully deleted. - */ export class ClaimResponse extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "audience" }) diff --git a/src/sdk/models/shared/decision.ts b/src/sdk/models/shared/decision.ts index 08d19133..a1ea0a51 100755 --- a/src/sdk/models/shared/decision.ts +++ b/src/sdk/models/shared/decision.ts @@ -6,9 +6,6 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { Violation } from "./violation"; import { Expose, Type } from "class-transformer"; -/** - * Decision rendered by applying the policy against the provided data. Response will be modeled by the data and rego processed. - */ export class Decision extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "enabled_rules" }) diff --git a/src/sdk/models/shared/decisionlog.ts b/src/sdk/models/shared/decisionlog.ts index 48304dfb..ac9015cb 100755 --- a/src/sdk/models/shared/decisionlog.ts +++ b/src/sdk/models/shared/decisionlog.ts @@ -43,9 +43,6 @@ export class DecisionLogMetadata extends SpeakeasyBase { vcs?: DecisionLogMetadataVcs; } -/** - * Decision log successfully retrieved. - */ export class DecisionLog extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "created_at" }) diff --git a/src/sdk/models/shared/decisionsettings.ts b/src/sdk/models/shared/decisionsettings.ts index 46581ff3..2a1608cc 100755 --- a/src/sdk/models/shared/decisionsettings.ts +++ b/src/sdk/models/shared/decisionsettings.ts @@ -5,9 +5,6 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { Expose } from "class-transformer"; -/** - * Decision settings successfully retrieved. - */ export class DecisionSettings extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "enabled" }) diff --git a/src/sdk/models/shared/policy.ts b/src/sdk/models/shared/policy.ts index 66a8ba02..0ab2ad1a 100755 --- a/src/sdk/models/shared/policy.ts +++ b/src/sdk/models/shared/policy.ts @@ -5,9 +5,6 @@ import { SpeakeasyBase, SpeakeasyMetadata } from "../../../internal/utils"; import { Expose, Transform } from "class-transformer"; -/** - * Policy retrieved successfully. - */ export class Policy extends SpeakeasyBase { @SpeakeasyMetadata() @Expose({ name: "content" }) diff --git a/src/sdk/oidctokenmanagement.ts b/src/sdk/oidctokenmanagement.ts index 76435d56..b2443b6a 100755 --- a/src/sdk/oidctokenmanagement.ts +++ b/src/sdk/oidctokenmanagement.ts @@ -3,35 +3,21 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; import * as shared from "./models/shared"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; /** * Endpoints related to manage oidc identity tokens */ + export class OIDCTokenManagement { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -48,24 +34,32 @@ export class OIDCTokenManagement { req = new operations.DeleteOrgClaimsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/org/{orgID}/oidc-custom-claims", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -80,34 +74,66 @@ export class OIDCTokenManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.claimResponse = utils.objectToClass(httpRes?.data, shared.ClaimResponse); + res.claimResponse = utils.objectToClass( + JSON.parse(decodedRes), + shared.ClaimResponse + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.deleteOrgClaims400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteOrgClaims400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.deleteOrgClaims403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteOrgClaims403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.deleteOrgClaims500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteOrgClaims500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -129,28 +155,36 @@ export class OIDCTokenManagement { req = new operations.DeleteProjectClaimsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/org/{orgID}/project/{projectID}/oidc-custom-claims", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -166,34 +200,66 @@ export class OIDCTokenManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.claimResponse = utils.objectToClass(httpRes?.data, shared.ClaimResponse); + res.claimResponse = utils.objectToClass( + JSON.parse(decodedRes), + shared.ClaimResponse + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.deleteProjectClaims400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteProjectClaims400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.deleteProjectClaims403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteProjectClaims403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.deleteProjectClaims500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteProjectClaims500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -215,23 +281,31 @@ export class OIDCTokenManagement { req = new operations.GetOrgClaimsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/org/{orgID}/oidc-custom-claims", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -246,34 +320,66 @@ export class OIDCTokenManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.claimResponse = utils.objectToClass(httpRes?.data, shared.ClaimResponse); + res.claimResponse = utils.objectToClass( + JSON.parse(decodedRes), + shared.ClaimResponse + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getOrgClaims400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetOrgClaims400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getOrgClaims403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetOrgClaims403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getOrgClaims500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetOrgClaims500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -295,27 +401,35 @@ export class OIDCTokenManagement { req = new operations.GetProjectClaimsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/org/{orgID}/project/{projectID}/oidc-custom-claims", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -330,34 +444,66 @@ export class OIDCTokenManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.claimResponse = utils.objectToClass(httpRes?.data, shared.ClaimResponse); + res.claimResponse = utils.objectToClass( + JSON.parse(decodedRes), + shared.ClaimResponse + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectClaims400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectClaims400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectClaims403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectClaims403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectClaims500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectClaims500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -379,10 +525,13 @@ export class OIDCTokenManagement { req = new operations.PatchOrgClaimsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/org/{orgID}/oidc-custom-claims", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody( @@ -395,21 +544,30 @@ export class OIDCTokenManagement { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "patch", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -425,34 +583,66 @@ export class OIDCTokenManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.claimResponse = utils.objectToClass(httpRes?.data, shared.ClaimResponse); + res.claimResponse = utils.objectToClass( + JSON.parse(decodedRes), + shared.ClaimResponse + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.patchOrgClaims400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.PatchOrgClaims400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.patchOrgClaims403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.PatchOrgClaims403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.patchOrgClaims500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.PatchOrgClaims500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -474,14 +664,17 @@ export class OIDCTokenManagement { req = new operations.PatchProjectClaimsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/org/{orgID}/project/{projectID}/oidc-custom-claims", req ); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody( @@ -494,21 +687,30 @@ export class OIDCTokenManagement { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "patch", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -525,34 +727,66 @@ export class OIDCTokenManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.claimResponse = utils.objectToClass(httpRes?.data, shared.ClaimResponse); + res.claimResponse = utils.objectToClass( + JSON.parse(decodedRes), + shared.ClaimResponse + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.patchProjectClaims400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.PatchProjectClaims400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.patchProjectClaims403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.PatchProjectClaims403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.patchProjectClaims500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.PatchProjectClaims500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/pipeline.ts b/src/sdk/pipeline.ts index 4ba6da0f..f95738ff 100755 --- a/src/sdk/pipeline.ts +++ b/src/sdk/pipeline.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Pipeline { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,10 +30,13 @@ export class Pipeline { req = new operations.ContinuePipelineRequestBody(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/pipeline/continue"; - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "request", "json"); @@ -56,20 +45,30 @@ export class Pipeline { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -85,21 +84,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ContinuePipelineMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.continuePipelineDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ContinuePipelineDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -121,22 +135,31 @@ export class Pipeline { req = new operations.GetPipelineByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/pipeline/{pipeline-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -151,21 +174,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.pipeline = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPipelineByIdPipeline ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getPipelineByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPipelineByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -187,26 +225,35 @@ export class Pipeline { req = new operations.GetPipelineByNumberRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/pipeline/{pipeline-number}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -222,21 +269,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.pipeline = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPipelineByNumberPipeline ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getPipelineByNumberDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPipelineByNumberDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -258,22 +320,31 @@ export class Pipeline { req = new operations.GetPipelineConfigByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/pipeline/{pipeline-id}/config", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -289,21 +360,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.pipelineConfig = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPipelineConfigByIdPipelineConfig ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getPipelineConfigByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPipelineConfigByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -325,27 +411,36 @@ export class Pipeline { req = new operations.ListMyPipelinesRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/pipeline/mine", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -360,21 +455,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.pipelineListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListMyPipelinesPipelineListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listMyPipelinesDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListMyPipelinesDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -396,23 +506,32 @@ export class Pipeline { req = new operations.ListPipelinesRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/pipeline"; - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -427,21 +546,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.pipelineListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListPipelinesPipelineListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listPipelinesDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListPipelinesDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -463,23 +597,32 @@ export class Pipeline { req = new operations.ListPipelinesForProjectRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/pipeline", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -495,21 +638,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.pipelineListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListPipelinesForProjectPipelineListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listPipelinesForProjectDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListPipelinesForProjectDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -531,23 +689,32 @@ export class Pipeline { req = new operations.ListWorkflowsByPipelineIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/pipeline/{pipeline-id}/workflow", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -563,21 +730,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.workflowListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListWorkflowsByPipelineIdWorkflowListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listWorkflowsByPipelineIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListWorkflowsByPipelineIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -599,10 +781,13 @@ export class Pipeline { req = new operations.TriggerPipelineRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/pipeline", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -611,20 +796,30 @@ export class Pipeline { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -640,21 +835,36 @@ export class Pipeline { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 201: if (utils.matchContentType(contentType, `application/json`)) { res.pipelineCreation = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.TriggerPipelinePipelineCreation ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.triggerPipelineDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.TriggerPipelineDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/policymanagement.ts b/src/sdk/policymanagement.ts index d4a42929..6fff1c0d 100755 --- a/src/sdk/policymanagement.ts +++ b/src/sdk/policymanagement.ts @@ -3,35 +3,21 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; import * as shared from "./models/shared"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; /** * Endpoints related to managing policies and making policy decisions */ + export class PolicyManagement { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -48,14 +34,17 @@ export class PolicyManagement { req = new operations.CreatePolicyBundleRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/policy-bundle", req ); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "bundlePayload", "json"); @@ -64,22 +53,31 @@ export class PolicyManagement { throw new Error(`Error serializing request body, cause: ${e.message}`); } } - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.7, application/json;q=0.5, application/json;q=0.3, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -96,50 +94,93 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case [200, 201].includes(httpRes?.status): if (utils.matchContentType(contentType, `application/json`)) { - res.bundleDiff = utils.objectToClass(httpRes?.data, shared.BundleDiff); + res.bundleDiff = utils.objectToClass(JSON.parse(decodedRes), shared.BundleDiff); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.createPolicyBundle400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreatePolicyBundle400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.createPolicyBundle401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreatePolicyBundle401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.createPolicyBundle403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreatePolicyBundle403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 413: if (utils.matchContentType(contentType, `application/json`)) { res.createPolicyBundle413ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreatePolicyBundle413ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.createPolicyBundle500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreatePolicyBundle500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -161,27 +202,35 @@ export class PolicyManagement { req = new operations.GetDecisionLogRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/decision/{decisionID}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.7, application/json;q=0.5, application/json;q=0.3, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -196,50 +245,96 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.decisionLog = utils.objectToClass(httpRes?.data, shared.DecisionLog); + res.decisionLog = utils.objectToClass( + JSON.parse(decodedRes), + shared.DecisionLog + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLog400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLog400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLog401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLog401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLog403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLog403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 404: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLog404ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLog404ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLog500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLog500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -261,27 +356,35 @@ export class PolicyManagement { req = new operations.GetDecisionLogPolicyBundleRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/decision/{decisionID}/policy-bundle", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.7, application/json;q=0.5, application/json;q=0.3, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -297,50 +400,93 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.policyBundle = utils.objectToClass(httpRes?.data); + res.policyBundle = utils.objectToClass(JSON.parse(decodedRes)); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogPolicyBundle400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogPolicyBundle400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogPolicyBundle401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogPolicyBundle401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogPolicyBundle403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogPolicyBundle403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 404: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogPolicyBundle404ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogPolicyBundle404ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogPolicyBundle500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogPolicyBundle500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -362,28 +508,36 @@ export class PolicyManagement { req = new operations.GetDecisionLogsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/decision", req ); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.6, application/json;q=0.4, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -398,48 +552,84 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.decisionLogs = []; const resFieldDepth: number = utils.getResFieldDepth(res); res.decisionLogs = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), shared.DecisionLog, resFieldDepth ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogs400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogs400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogs401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogs401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogs403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogs403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionLogs500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionLogs500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -461,27 +651,35 @@ export class PolicyManagement { req = new operations.GetDecisionSettingsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/decision/settings", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.6, application/json;q=0.4, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -497,45 +695,81 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.decisionSettings = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), shared.DecisionSettings ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionSettings400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionSettings400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionSettings401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionSettings401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionSettings403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionSettings403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getDecisionSettings500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetDecisionSettings500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -557,27 +791,35 @@ export class PolicyManagement { req = new operations.GetPolicyBundleRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/policy-bundle", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.6, application/json;q=0.4, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -592,42 +834,78 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.policyBundle = utils.objectToClass(httpRes?.data); + res.policyBundle = utils.objectToClass(JSON.parse(decodedRes)); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyBundle400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyBundle400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyBundle401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyBundle401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyBundle403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyBundle403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyBundle500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyBundle500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -649,27 +927,35 @@ export class PolicyManagement { req = new operations.GetPolicyDocumentRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/policy-bundle/{policyName}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.7, application/json;q=0.5, application/json;q=0.3, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -684,50 +970,93 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.policy = utils.objectToClass(httpRes?.data, shared.Policy); + res.policy = utils.objectToClass(JSON.parse(decodedRes), shared.Policy); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyDocument400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyDocument400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyDocument401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyDocument401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyDocument403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyDocument403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 404: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyDocument404ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyDocument404ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.getPolicyDocument500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetPolicyDocument500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -749,14 +1078,17 @@ export class PolicyManagement { req = new operations.MakeDecisionRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/decision", req ); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -765,21 +1097,30 @@ export class PolicyManagement { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.5, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -795,34 +1136,63 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.decision = utils.objectToClass(httpRes?.data, shared.Decision); + res.decision = utils.objectToClass(JSON.parse(decodedRes), shared.Decision); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.makeDecision400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.MakeDecision400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.makeDecision401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.MakeDecision401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.makeDecision500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.MakeDecision500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -844,14 +1214,17 @@ export class PolicyManagement { req = new operations.SetDecisionSettingsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/owner/{ownerID}/context/{context}/decision/settings", req ); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "decisionSettings", "json"); @@ -860,21 +1233,30 @@ export class PolicyManagement { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = - "application/json;q=1, application/json;q=0.8, application/json;q=0.6, application/json;q=0.4, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "patch", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -891,45 +1273,81 @@ export class PolicyManagement { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.decisionSettings = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), shared.DecisionSettings ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 400: if (utils.matchContentType(contentType, `application/json`)) { res.setDecisionSettings400ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.SetDecisionSettings400ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 401: if (utils.matchContentType(contentType, `application/json`)) { res.setDecisionSettings401ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.SetDecisionSettings401ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 403: if (utils.matchContentType(contentType, `application/json`)) { res.setDecisionSettings403ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.SetDecisionSettings403ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; case httpRes?.status == 500: if (utils.matchContentType(contentType, `application/json`)) { res.setDecisionSettings500ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.SetDecisionSettings500ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/project.ts b/src/sdk/project.ts index 32b8d0f7..6454ec4d 100755 --- a/src/sdk/project.ts +++ b/src/sdk/project.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Project { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,10 +30,13 @@ export class Project { req = new operations.CreateCheckoutKeyRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/checkout-key", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -56,20 +45,30 @@ export class Project { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -85,21 +84,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 201: if (utils.matchContentType(contentType, `application/json`)) { res.checkoutKey = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateCheckoutKeyCheckoutKey ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.createCheckoutKeyDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateCheckoutKeyDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -121,10 +135,13 @@ export class Project { req = new operations.CreateEnvVarRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/envvar", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -133,20 +150,30 @@ export class Project { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -162,21 +189,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 201: if (utils.matchContentType(contentType, `application/json`)) { res.environmentVariable = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateEnvVarEnvironmentVariable1 ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.createEnvVarDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateEnvVarDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -198,26 +240,35 @@ export class Project { req = new operations.DeleteCheckoutKeyRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/checkout-key/{fingerprint}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -232,21 +283,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteCheckoutKeyMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.deleteCheckoutKeyDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteCheckoutKeyDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -268,26 +334,35 @@ export class Project { req = new operations.DeleteEnvVarRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/envvar/{name}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -302,21 +377,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteEnvVarMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.deleteEnvVarDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteEnvVarDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -338,26 +428,35 @@ export class Project { req = new operations.GetCheckoutKeyRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/checkout-key/{fingerprint}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -372,21 +471,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.checkoutKey = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetCheckoutKeyCheckoutKey ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getCheckoutKeyDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetCheckoutKeyDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -408,26 +522,35 @@ export class Project { req = new operations.GetEnvVarRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/project/{project-slug}/envvar/{name}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -442,21 +565,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.environmentVariable = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetEnvVarEnvironmentVariable ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getEnvVarDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetEnvVarDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -478,22 +616,31 @@ export class Project { req = new operations.GetProjectBySlugRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -508,21 +655,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.project = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectBySlugProject ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getProjectBySlugDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetProjectBySlugDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -544,22 +706,31 @@ export class Project { req = new operations.ListCheckoutKeysRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/checkout-key", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -574,21 +745,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.checkoutKeyListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListCheckoutKeysCheckoutKeyListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listCheckoutKeysDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListCheckoutKeysDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -610,22 +796,31 @@ export class Project { req = new operations.ListEnvVarsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/envvar", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -640,21 +835,36 @@ export class Project { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.environmentVariableListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListEnvVarsEnvironmentVariableListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listEnvVarsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListEnvVarsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/schedule.ts b/src/sdk/schedule.ts index e1054280..e08715c9 100755 --- a/src/sdk/schedule.ts +++ b/src/sdk/schedule.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Schedule { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,10 +30,13 @@ export class Schedule { req = new operations.CreateScheduleRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/schedule", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -56,20 +45,30 @@ export class Schedule { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -85,21 +84,36 @@ export class Schedule { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 201: if (utils.matchContentType(contentType, `application/json`)) { res.schedule = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateScheduleSchedule ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.createScheduleDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateScheduleDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -121,22 +135,31 @@ export class Schedule { req = new operations.DeleteScheduleByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/schedule/{schedule-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -152,21 +175,36 @@ export class Schedule { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteScheduleByIdMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.deleteScheduleByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteScheduleByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -188,22 +226,31 @@ export class Schedule { req = new operations.GetScheduleByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/schedule/{schedule-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -218,21 +265,36 @@ export class Schedule { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.schedule = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetScheduleByIdSchedule ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getScheduleByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetScheduleByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -254,23 +316,32 @@ export class Schedule { req = new operations.ListSchedulesForProjectRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/project/{project-slug}/schedule", req); - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -286,21 +357,36 @@ export class Schedule { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.listSchedulesForProject200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListSchedulesForProject200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listSchedulesForProjectDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListSchedulesForProjectDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -322,10 +408,13 @@ export class Schedule { req = new operations.UpdateScheduleRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/schedule/{schedule-id}", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -334,20 +423,30 @@ export class Schedule { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "patch", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -363,21 +462,36 @@ export class Schedule { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.schedule = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.UpdateScheduleSchedule ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.updateScheduleDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.UpdateScheduleDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts index b7772f99..b94a2955 100755 --- a/src/sdk/sdk.ts +++ b/src/sdk/sdk.ts @@ -30,19 +30,45 @@ export type SDKProps = { /** * The security details required to authenticate the SDK */ - security?: shared.Security; + security?: shared.Security | (() => Promise); /** * Allows overriding the default axios client used by the SDK */ defaultClient?: AxiosInstance; + + /** + * Allows overriding the default server used by the SDK + */ + serverIdx?: number; + /** * Allows overriding the default server URL used by the SDK */ serverURL?: string; + /** + * Allows overriding the default retry config used by the SDK + */ + retryConfig?: utils.RetryConfig; }; +export class SDKConfiguration { + defaultClient: AxiosInstance; + security?: shared.Security | (() => Promise); + serverURL: string; + serverDefaults: any; + language = "typescript"; + openapiDocVersion = "v2"; + sdkVersion = "3.59.2"; + genVersion = "2.147.0"; + userAgent = "speakeasy-sdk/typescript 3.59.2 2.147.0 v2 circleci-v2-sdk"; + retryConfig?: utils.RetryConfig; + public constructor(init?: Partial) { + Object.assign(this, init); + } +} + /** - * This describes the resources that make up the CircleCI API v2. + * CircleCI API: This describes the resources that make up the CircleCI API v2. */ export class Circleci { public context: Context; @@ -63,124 +89,34 @@ export class Circleci { public webhook: Webhook; public workflow: Workflow; - public _defaultClient: AxiosInstance; - public _securityClient: AxiosInstance; - public _serverURL: string; - private _language = "typescript"; - private _sdkVersion = "3.30.1"; - private _genVersion = "2.34.2"; - private _globals: any; + private sdkConfiguration: SDKConfiguration; constructor(props?: SDKProps) { - this._serverURL = props?.serverURL ?? ServerList[0]; + let serverURL = props?.serverURL; + const serverIdx = props?.serverIdx ?? 0; - this._defaultClient = props?.defaultClient ?? axios.create({ baseURL: this._serverURL }); - if (props?.security) { - let security: shared.Security = props.security; - if (!(props.security instanceof utils.SpeakeasyBase)) - security = new shared.Security(props.security); - this._securityClient = utils.createSecurityClient(this._defaultClient, security); - } else { - this._securityClient = this._defaultClient; + if (!serverURL) { + serverURL = ServerList[serverIdx]; } - this.context = new Context( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.insights = new Insights( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.job = new Job( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.oidcTokenManagement = new OIDCTokenManagement( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.pipeline = new Pipeline( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.policyManagement = new PolicyManagement( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.project = new Project( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.schedule = new Schedule( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.user = new User( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.webhook = new Webhook( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); - - this.workflow = new Workflow( - this._defaultClient, - this._securityClient, - this._serverURL, - this._language, - this._sdkVersion, - this._genVersion - ); + const defaultClient = props?.defaultClient ?? axios.create({ baseURL: serverURL }); + this.sdkConfiguration = new SDKConfiguration({ + defaultClient: defaultClient, + security: props?.security, + serverURL: serverURL, + retryConfig: props?.retryConfig, + }); + + this.context = new Context(this.sdkConfiguration); + this.insights = new Insights(this.sdkConfiguration); + this.job = new Job(this.sdkConfiguration); + this.oidcTokenManagement = new OIDCTokenManagement(this.sdkConfiguration); + this.pipeline = new Pipeline(this.sdkConfiguration); + this.policyManagement = new PolicyManagement(this.sdkConfiguration); + this.project = new Project(this.sdkConfiguration); + this.schedule = new Schedule(this.sdkConfiguration); + this.user = new User(this.sdkConfiguration); + this.webhook = new Webhook(this.sdkConfiguration); + this.workflow = new Workflow(this.sdkConfiguration); } } diff --git a/src/sdk/types/rfcdate.ts b/src/sdk/types/rfcdate.ts index 1a3d24bc..903ac7da 100755 --- a/src/sdk/types/rfcdate.ts +++ b/src/sdk/types/rfcdate.ts @@ -5,11 +5,24 @@ export class RFCDate { private date: Date; - constructor(date?: Date | string) { + constructor(date: Date | {date:string} | string | undefined) { + if (!date) { + this.date = new Date(); + return; + } + if (typeof date === "string") { this.date = new Date(date); - } else { - this.date = date ?? new Date(); + return; + } + if (date instanceof Date) { + this.date = date as Date + return; + } + + const anyDate = (date as any); + if (date && !!anyDate.date) { + this.date = new Date(anyDate.date); } } diff --git a/src/sdk/user.ts b/src/sdk/user.ts index dfc4e28c..750bbddb 100755 --- a/src/sdk/user.ts +++ b/src/sdk/user.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class User { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -45,22 +31,31 @@ export class User { async getCollaborations( config?: AxiosRequestConfig ): Promise { - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/me/collaborations"; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -75,24 +70,39 @@ export class User { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.collaborations = []; const resFieldDepth: number = utils.getResFieldDepth(res); res.collaborations = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetCollaborationsCollaboration, resFieldDepth ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getCollaborationsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetCollaborationsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -107,22 +117,31 @@ export class User { * Provides information about the user that is currently signed in. */ async getCurrentUser(config?: AxiosRequestConfig): Promise { - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/me"; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -137,18 +156,36 @@ export class User { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.user = utils.objectToClass(httpRes?.data, operations.GetCurrentUserUser); + res.user = utils.objectToClass( + JSON.parse(decodedRes), + operations.GetCurrentUserUser + ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getCurrentUserDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetCurrentUserDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -170,22 +207,31 @@ export class User { req = new operations.GetUserRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/user/{id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -200,18 +246,33 @@ export class User { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { - res.user = utils.objectToClass(httpRes?.data, operations.GetUserUser); + res.user = utils.objectToClass(JSON.parse(decodedRes), operations.GetUserUser); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getUserDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetUserDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/webhook.ts b/src/sdk/webhook.ts index 795b5b55..068d275b 100755 --- a/src/sdk/webhook.ts +++ b/src/sdk/webhook.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Webhook { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -41,10 +27,13 @@ export class Webhook { req = new operations.CreateWebhookRequestBody(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/webhook"; - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "request", "json"); @@ -53,20 +42,30 @@ export class Webhook { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -82,21 +81,36 @@ export class Webhook { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 201: if (utils.matchContentType(contentType, `application/json`)) { res.webhook = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateWebhookWebhook ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.createWebhookDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CreateWebhookDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -115,22 +129,31 @@ export class Webhook { req = new operations.DeleteWebhookRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/webhook/{webhook-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "delete", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -145,21 +168,36 @@ export class Webhook { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteWebhookMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.deleteWebhookDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.DeleteWebhookDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -181,22 +219,31 @@ export class Webhook { req = new operations.GetWebhookByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/webhook/{webhook-id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -211,21 +258,36 @@ export class Webhook { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.webhook = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWebhookByIdWebhook ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getWebhookByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWebhookByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -247,23 +309,32 @@ export class Webhook { req = new operations.GetWebhooksRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = baseURL.replace(/\/$/, "") + "/webhook"; - - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; const queryParams: string = utils.serializeQueryParams(req); - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["Accept"] = "application/json"; + + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url + queryParams, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -278,21 +349,36 @@ export class Webhook { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.getWebhooks200ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWebhooks200ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getWebhooksDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWebhooksDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -311,10 +397,13 @@ export class Webhook { req = new operations.UpdateWebhookRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/webhook/{webhook-id}", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -323,20 +412,30 @@ export class Webhook { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "put", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -352,21 +451,36 @@ export class Webhook { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.webhook = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.UpdateWebhookWebhook ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.updateWebhookDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.UpdateWebhookDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/src/sdk/workflow.ts b/src/sdk/workflow.ts index 36a1fea9..7842f8ea 100755 --- a/src/sdk/workflow.ts +++ b/src/sdk/workflow.ts @@ -3,31 +3,17 @@ */ import * as utils from "../internal/utils"; +import * as errors from "./models/errors"; import * as operations from "./models/operations"; -import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios"; +import * as shared from "./models/shared"; +import { SDKConfiguration } from "./sdk"; +import { AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from "axios"; export class Workflow { - _defaultClient: AxiosInstance; - _securityClient: AxiosInstance; - _serverURL: string; - _language: string; - _sdkVersion: string; - _genVersion: string; - - constructor( - defaultClient: AxiosInstance, - securityClient: AxiosInstance, - serverURL: string, - language: string, - sdkVersion: string, - genVersion: string - ) { - this._defaultClient = defaultClient; - this._securityClient = securityClient; - this._serverURL = serverURL; - this._language = language; - this._sdkVersion = sdkVersion; - this._genVersion = genVersion; + private sdkConfiguration: SDKConfiguration; + + constructor(sdkConfig: SDKConfiguration) { + this.sdkConfiguration = sdkConfig; } /** @@ -44,26 +30,35 @@ export class Workflow { req = new operations.ApprovePendingApprovalJobByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL( baseURL, "/workflow/{id}/approve/{approval_request_id}", req ); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -79,22 +74,37 @@ export class Workflow { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 202: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ApprovePendingApprovalJobByIdMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.approvePendingApprovalJobByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ApprovePendingApprovalJobByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -116,22 +126,31 @@ export class Workflow { req = new operations.CancelWorkflowRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/workflow/{id}/cancel", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -146,21 +165,36 @@ export class Workflow { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 202: if (utils.matchContentType(contentType, `application/json`)) { res.messageResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CancelWorkflowMessageResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.cancelWorkflowDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.CancelWorkflowDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -182,22 +216,31 @@ export class Workflow { req = new operations.GetWorkflowByIdRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/workflow/{id}", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -212,21 +255,36 @@ export class Workflow { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.workflow = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWorkflowByIdWorkflow ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.getWorkflowByIdDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.GetWorkflowByIdDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -248,22 +306,31 @@ export class Workflow { req = new operations.ListWorkflowJobsRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/workflow/{id}/job", req); + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { ...config?.headers, ...properties.headers }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "get", headers: headers, + responseType: "arraybuffer", ...config, }); @@ -278,21 +345,36 @@ export class Workflow { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 200: if (utils.matchContentType(contentType, `application/json`)) { res.workflowJobListResponse = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListWorkflowJobsWorkflowJobListResponse ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.listWorkflowJobsDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.ListWorkflowJobsDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } @@ -314,10 +396,13 @@ export class Workflow { req = new operations.RerunWorkflowRequest(req); } - const baseURL: string = this._serverURL; + const baseURL: string = utils.templateUrl( + this.sdkConfiguration.serverURL, + this.sdkConfiguration.serverDefaults + ); const url: string = utils.generateURL(baseURL, "/workflow/{id}/rerun", req); - let [reqBodyHeaders, reqBody]: [object, any] = [{}, {}]; + let [reqBodyHeaders, reqBody]: [object, any] = [{}, null]; try { [reqBodyHeaders, reqBody] = utils.serializeRequestBody(req, "requestBody", "json"); @@ -326,20 +411,30 @@ export class Workflow { throw new Error(`Error serializing request body, cause: ${e.message}`); } } + const client: AxiosInstance = this.sdkConfiguration.defaultClient; + let globalSecurity = this.sdkConfiguration.security; + if (typeof globalSecurity === "function") { + globalSecurity = await globalSecurity(); + } + if (!(globalSecurity instanceof utils.SpeakeasyBase)) { + globalSecurity = new shared.Security(globalSecurity); + } + const properties = utils.parseSecurityProperties(globalSecurity); + const headers: RawAxiosRequestHeaders = { + ...reqBodyHeaders, + ...config?.headers, + ...properties.headers, + }; + headers["Accept"] = "application/json"; - const client: AxiosInstance = this._securityClient || this._defaultClient; - - const headers = { ...reqBodyHeaders, ...config?.headers }; - headers["Accept"] = "application/json;q=1, application/json;q=0"; - headers[ - "user-agent" - ] = `speakeasy-sdk/${this._language} ${this._sdkVersion} ${this._genVersion}`; + headers["user-agent"] = this.sdkConfiguration.userAgent; const httpRes: AxiosResponse = await client.request({ validateStatus: () => true, url: url, method: "post", headers: headers, + responseType: "arraybuffer", data: reqBody, ...config, }); @@ -355,21 +450,36 @@ export class Workflow { contentType: contentType, rawResponse: httpRes, }); + const decodedRes = new TextDecoder().decode(httpRes?.data); switch (true) { case httpRes?.status == 202: if (utils.matchContentType(contentType, `application/json`)) { res.rerunWorkflow202ApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.RerunWorkflow202ApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; default: if (utils.matchContentType(contentType, `application/json`)) { res.rerunWorkflowDefaultApplicationJSONObject = utils.objectToClass( - httpRes?.data, + JSON.parse(decodedRes), operations.RerunWorkflowDefaultApplicationJSON ); + } else { + throw new errors.SDKError( + "unknown content-type received: " + contentType, + httpRes.status, + decodedRes, + httpRes + ); } break; } diff --git a/tsconfig.json b/tsconfig.json index 0f5face1..0e90e5e5 100755 --- a/tsconfig.json +++ b/tsconfig.json @@ -6,6 +6,7 @@ "rootDir": "src", "outDir": "dist", "allowJs": true, + "downlevelIteration": true, "skipLibCheck": true, "esModuleInterop": true, "allowSyntheticDefaultImports": true,