ProjectsApi class
Methods
deleteProjectsBySlug (String slug → Future <void >
Deletes a project and takes its site off the internet.
deleteProjectsBySlugDomainsByHost (String slug , String host → Future <void >
Gives a custom hostname back, so the name is free to reuse.
deleteProjectsBySlugDomainsByHostWithHttpInfo (String slug , String host → Future <Response >
Gives a custom hostname back, so the name is free to reuse.
deleteProjectsBySlugStar (String slug → Future <ProjectsStar ?
Removes the caller's own bookmark from a project, and answers whether it is starred afterwards.
deleteProjectsBySlugStarWithHttpInfo (String slug → Future <Response >
Removes the caller's own bookmark from a project, and answers whether it is starred afterwards.
deleteProjectsBySlugWithHttpInfo (String slug → Future <Response >
Deletes a project and takes its site off the internet.
getProjects ()
→ Future <List <ProjectsProject ?
Returns every project your org owns.
getProjectsBySlug (String slug → Future <ProjectsProject ?
Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it.
getProjectsBySlugDeployments (String slug → Future <List <ProjectsDeployment ?
Returns a project's deploy history, newest version first.
getProjectsBySlugDeploymentsById (String slug , String id → Future <ProjectsDeployment ?
Returns one deployment of a project by id.
getProjectsBySlugDeploymentsByIdWithHttpInfo (String slug , String id → Future <Response >
Returns one deployment of a project by id.
getProjectsBySlugDeploymentsWithHttpInfo (String slug → Future <Response >
Returns a project's deploy history, newest version first.
getProjectsBySlugDomains (String slug → Future <ProjectsDomains ?
Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.
getProjectsBySlugDomainsWithHttpInfo (String slug → Future <Response >
Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.
getProjectsBySlugReleases (String slug → Future <List <ProjectsRelease ?
Returns a site's releases newest-first, marking the active one — the rollback menu.
getProjectsBySlugReleasesWithHttpInfo (String slug → Future <Response >
Returns a site's releases newest-first, marking the active one — the rollback menu.
getProjectsBySlugShot (String slug → Future <void >
Get a PNG of the project's live site
getProjectsBySlugShotWithHttpInfo (String slug → Future <Response >
Get a PNG of the project's live site
getProjectsBySlugWithHttpInfo (String slug → Future <Response >
Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it.
getProjectsEdge ()
→ Future <EdgeState ?
health reports whether a publish reaches readers, rather than whether it was accepted.
getProjectsEdgeWithHttpInfo ()
→ Future <Response >
health reports whether a publish reaches readers, rather than whether it was accepted.
getProjectsSites ()
→ Future <List <ProjectsSite ?
Returns the org's deployed sites at the pretty URLs they serve at.
getProjectsSitesBySlug (String slug → Future <ProjectsSite ?
Returns one site — the same row ListSites carries, for one slug.
getProjectsSitesBySlugWithHttpInfo (String slug → Future <Response >
Returns one site — the same row ListSites carries, for one slug.
getProjectsSitesWithHttpInfo ()
→ Future <Response >
Returns the org's deployed sites at the pretty URLs they serve at.
getProjectsTags ()
→ Future <TagConfig ?
The site's browser tag set for the hosted tag — which pixels to inject, by publishable key
getProjectsTagsWithHttpInfo ()
→ Future <Response >
The site's browser tag set for the hosted tag — which pixels to inject, by publishable key
getProjectsWithHttpInfo ()
→ Future <Response >
Returns every project your org owns.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patchProjectsBySlug (String slug , ProjectsUpdate projectsUpdate → Future <ProjectsProject ?
Changes a project's settings, and only the settings you send.
patchProjectsBySlugWithHttpInfo (String slug , ProjectsUpdate projectsUpdate → Future <Response >
Changes a project's settings, and only the settings you send.
postProjects (ProjectsCreate projectsCreate → Future <ProjectsProject ?
Creates a project — the handle a site is deployed and served under — and answers 201 with it in draft.
postProjectsBySlugDeploy (String slug , {MultipartFile? body → Future <ProjectsDeployment ?
Upload a built site as one archive and serve it
postProjectsBySlugDeployments (String slug , ProjectsDeployStart projectsDeployStart → Future <ProjectsDeployment ?
Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage.
postProjectsBySlugDeploymentsByIdComplete (String slug , String id , ProjectsComplete projectsComplete → Future <ProjectsDeployment ?
CompleteDeployment is the CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3.
postProjectsBySlugDeploymentsByIdCompleteWithHttpInfo (String slug , String id , ProjectsComplete projectsComplete → Future <Response >
CompleteDeployment is the CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3.
postProjectsBySlugDeploymentsWithHttpInfo (String slug , ProjectsDeployStart projectsDeployStart → Future <Response >
Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage.
postProjectsBySlugDeployWithHttpInfo (String slug , {MultipartFile? body → Future <Response >
Upload a built site as one archive and serve it
postProjectsBySlugDomains (String slug , ProjectsDomainsBind projectsDomainsBind → Future <ProjectsBoundDomains ?
Attaches one or more CUSTOM public hostnames to this org's site.
postProjectsBySlugDomainsByHostVerify (String slug , String host → Future <ProjectsDomain ?
Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge.
postProjectsBySlugDomainsByHostVerifyWithHttpInfo (String slug , String host → Future <Response >
Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge.
postProjectsBySlugDomainsWithHttpInfo (String slug , ProjectsDomainsBind projectsDomainsBind → Future <Response >
Attaches one or more CUSTOM public hostnames to this org's site.
postProjectsBySlugPublish (String slug , ProjectsPublish projectsPublish → Future <ProjectsRelease ?
Promotes a build output into a new release AND goes live with it — create+activate in one call, which is the 99% path.
postProjectsBySlugPublishWithHttpInfo (String slug , ProjectsPublish projectsPublish → Future <Response >
Promotes a build output into a new release AND goes live with it — create+activate in one call, which is the 99% path.
postProjectsBySlugPurge (String slug → Future <ProjectsProject ?
Flushes the site's edge cache without redeploying anything.
postProjectsBySlugPurgeWithHttpInfo (String slug → Future <Response >
Flushes the site's edge cache without redeploying anything.
postProjectsBySlugReleases (String slug , ProjectsPublish projectsPublish → Future <ProjectsRelease ?
Promotes a build output into a new immutable release WITHOUT serving it — the staged half of publishing, for when you want to check a release before it goes live.
postProjectsBySlugReleasesByReleaseActivate (String slug , String release → Future <ProjectsRelease ?
Points the site at an existing release — the go-live, and equally the ROLLBACK.
postProjectsBySlugReleasesByReleaseActivateWithHttpInfo (String slug , String release → Future <Response >
Points the site at an existing release — the go-live, and equally the ROLLBACK.
postProjectsBySlugReleasesWithHttpInfo (String slug , ProjectsPublish projectsPublish → Future <Response >
Promotes a build output into a new immutable release WITHOUT serving it — the staged half of publishing, for when you want to check a release before it goes live.
postProjectsFork (ProjectsFork projectsFork → Future <ProjectsProject ?
Creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE embedded gallery catalog, or any live project on the platform (an example a seeded creator published, or another org's app serving at
postProjectsForkWithHttpInfo (ProjectsFork projectsFork → Future <Response >
Creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE embedded gallery catalog, or any live project on the platform (an example a seeded creator published, or another org's app serving at
postProjectsSites (ProjectsBuildSite projectsBuildSite → Future <ProjectsSiteDeploy ?
Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call.
postProjectsSitesDeploy (ProjectsDeploySite projectsDeploySite → Future <ProjectsSiteDeploy ?
Deploys a caller-supplied file manifest — the deploy_site capability an agent calls — and answers with where it went live.
postProjectsSitesDeployWithHttpInfo (ProjectsDeploySite projectsDeploySite → Future <Response >
Deploys a caller-supplied file manifest — the deploy_site capability an agent calls — and answers with where it went live.
postProjectsSitesWithHttpInfo (ProjectsBuildSite projectsBuildSite → Future <Response >
Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call.
postProjectsWithHttpInfo (ProjectsCreate projectsCreate → Future <Response >
Creates a project — the handle a site is deployed and served under — and answers 201 with it in draft.
putProjectsBySlugStar (String slug → Future <ProjectsStar ?
Bookmarks a project for the person calling, and answers whether it is starred afterwards.
putProjectsBySlugStarWithHttpInfo (String slug → Future <Response >
Bookmarks a project for the person calling, and answers whether it is starred afterwards.
toString ()
→ String
A string representation of this object.
inherited
