Files
b5c2d278-ac3e-4542-8f83-dd9…/src/clientsdk/sdk.gen.ts
“dongming” ed40350aeb first commit
2025-12-28 22:43:26 +08:00

1099 lines
45 KiB
TypeScript

// This file is auto-generated by @hey-api/openapi-ts
import type { Client, Options as Options2, TDataShape } from './client';
import { client } from './client.gen';
import type { CreateCategoryData, CreateCategoryResponses, CreateFolderData, CreateFolderResponses, CreateFormData, CreateFormResponses, CreateFormSubmissionData, CreateFormSubmissionResponses, CreateMediaData, CreateMediaResponses, CreatePageData, CreatePageResponses, CreatePayloadJobData, CreatePayloadJobResponses, CreatePayloadKvData, CreatePayloadKvResponses, CreatePayloadLockedDocumentData, CreatePayloadLockedDocumentResponses, CreatePayloadMigrationData, CreatePayloadMigrationResponses, CreatePayloadPreferenceData, CreatePayloadPreferenceResponses, CreatePostData, CreatePostResponses, CreateRedirectData, CreateRedirectResponses, CreateSearchResultData, CreateSearchResultResponses, CreateTenantData, CreateTenantResponses, CreateUserData, CreateUserResponses, DeleteCategoryData, DeleteCategoryErrors, DeleteCategoryResponses, DeleteFolderData, DeleteFolderErrors, DeleteFolderResponses, DeleteFormData, DeleteFormErrors, DeleteFormResponses, DeleteFormSubmissionData, DeleteFormSubmissionErrors, DeleteFormSubmissionResponses, DeleteMediaData, DeleteMediaErrors, DeleteMediaResponses, DeletePageData, DeletePageErrors, DeletePageResponses, DeletePayloadJobData, DeletePayloadJobErrors, DeletePayloadJobResponses, DeletePayloadKvData, DeletePayloadKvErrors, DeletePayloadKvResponses, DeletePayloadLockedDocumentData, DeletePayloadLockedDocumentErrors, DeletePayloadLockedDocumentResponses, DeletePayloadMigrationData, DeletePayloadMigrationErrors, DeletePayloadMigrationResponses, DeletePayloadPreferenceData, DeletePayloadPreferenceErrors, DeletePayloadPreferenceResponses, DeletePostData, DeletePostErrors, DeletePostResponses, DeleteRedirectData, DeleteRedirectErrors, DeleteRedirectResponses, DeleteSearchResultData, DeleteSearchResultErrors, DeleteSearchResultResponses, DeleteTenantData, DeleteTenantErrors, DeleteTenantResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, FindCategoryByIdData, FindCategoryByIdErrors, FindCategoryByIdResponses, FindFolderByIdData, FindFolderByIdErrors, FindFolderByIdResponses, FindFormByIdData, FindFormByIdErrors, FindFormByIdResponses, FindFormSubmissionByIdData, FindFormSubmissionByIdErrors, FindFormSubmissionByIdResponses, FindMediaByIdData, FindMediaByIdErrors, FindMediaByIdResponses, FindPageByIdData, FindPageByIdErrors, FindPageByIdResponses, FindPayloadJobByIdData, FindPayloadJobByIdErrors, FindPayloadJobByIdResponses, FindPayloadKvByIdData, FindPayloadKvByIdErrors, FindPayloadKvByIdResponses, FindPayloadLockedDocumentByIdData, FindPayloadLockedDocumentByIdErrors, FindPayloadLockedDocumentByIdResponses, FindPayloadMigrationByIdData, FindPayloadMigrationByIdErrors, FindPayloadMigrationByIdResponses, FindPayloadPreferenceByIdData, FindPayloadPreferenceByIdErrors, FindPayloadPreferenceByIdResponses, FindPostByIdData, FindPostByIdErrors, FindPostByIdResponses, FindRedirectByIdData, FindRedirectByIdErrors, FindRedirectByIdResponses, FindSearchResultByIdData, FindSearchResultByIdErrors, FindSearchResultByIdResponses, FindTenantByIdData, FindTenantByIdErrors, FindTenantByIdResponses, FindUserByIdData, FindUserByIdErrors, FindUserByIdResponses, GetApiGlobalsFooterData, GetApiGlobalsFooterResponses, GetApiGlobalsHeaderData, GetApiGlobalsHeaderResponses, ListCategoriesData, ListCategoriesResponses, ListFoldersData, ListFoldersResponses, ListFormsData, ListFormsResponses, ListFormSubmissionsData, ListFormSubmissionsResponses, ListMediaData, ListMediaResponses, ListPagesData, ListPagesResponses, ListPayloadJobsData, ListPayloadJobsResponses, ListPayloadKvsData, ListPayloadKvsResponses, ListPayloadLockedDocumentsData, ListPayloadLockedDocumentsResponses, ListPayloadMigrationsData, ListPayloadMigrationsResponses, ListPayloadPreferencesData, ListPayloadPreferencesResponses, ListPostsData, ListPostsResponses, ListRedirectsData, ListRedirectsResponses, ListSearchResultsData, ListSearchResultsResponses, ListTenantsData, ListTenantsResponses, ListUsersData, ListUsersResponses, PostApiGlobalsFooterData, PostApiGlobalsFooterResponses, PostApiGlobalsHeaderData, PostApiGlobalsHeaderResponses, UpdateCategoryData, UpdateCategoryErrors, UpdateCategoryResponses, UpdateFolderData, UpdateFolderErrors, UpdateFolderResponses, UpdateFormData, UpdateFormErrors, UpdateFormResponses, UpdateFormSubmissionData, UpdateFormSubmissionErrors, UpdateFormSubmissionResponses, UpdateMediaData, UpdateMediaErrors, UpdateMediaResponses, UpdatePageData, UpdatePageErrors, UpdatePageResponses, UpdatePayloadJobData, UpdatePayloadJobErrors, UpdatePayloadJobResponses, UpdatePayloadKvData, UpdatePayloadKvErrors, UpdatePayloadKvResponses, UpdatePayloadLockedDocumentData, UpdatePayloadLockedDocumentErrors, UpdatePayloadLockedDocumentResponses, UpdatePayloadMigrationData, UpdatePayloadMigrationErrors, UpdatePayloadMigrationResponses, UpdatePayloadPreferenceData, UpdatePayloadPreferenceErrors, UpdatePayloadPreferenceResponses, UpdatePostData, UpdatePostErrors, UpdatePostResponses, UpdateRedirectData, UpdateRedirectErrors, UpdateRedirectResponses, UpdateSearchResultData, UpdateSearchResultErrors, UpdateSearchResultResponses, UpdateTenantData, UpdateTenantErrors, UpdateTenantResponses, UpdateUserData, UpdateUserErrors, UpdateUserResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
export class Pages {
/**
* Retrieve a list of Pages
*/
public static listPages<ThrowOnError extends boolean = false>(options?: Options<ListPagesData, ThrowOnError>) {
return (options?.client ?? client).get<ListPagesResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/pages',
...options
});
}
/**
* Create a new Page
*/
public static createPage<ThrowOnError extends boolean = false>(options?: Options<CreatePageData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePageResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/pages',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Page
*/
public static deletePage<ThrowOnError extends boolean = false>(options: Options<DeletePageData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePageResponses, DeletePageErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/pages/{id}',
...options
});
}
/**
* Find a Page by ID
*/
public static findPageById<ThrowOnError extends boolean = false>(options: Options<FindPageByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPageByIdResponses, FindPageByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/pages/{id}',
...options
});
}
/**
* Update a Page
*/
public static updatePage<ThrowOnError extends boolean = false>(options: Options<UpdatePageData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePageResponses, UpdatePageErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/pages/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Posts {
/**
* Retrieve a list of Posts
*/
public static listPosts<ThrowOnError extends boolean = false>(options?: Options<ListPostsData, ThrowOnError>) {
return (options?.client ?? client).get<ListPostsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/posts',
...options
});
}
/**
* Create a new Post
*/
public static createPost<ThrowOnError extends boolean = false>(options?: Options<CreatePostData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePostResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/posts',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Post
*/
public static deletePost<ThrowOnError extends boolean = false>(options: Options<DeletePostData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePostResponses, DeletePostErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/posts/{id}',
...options
});
}
/**
* Find a Post by ID
*/
public static findPostById<ThrowOnError extends boolean = false>(options: Options<FindPostByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPostByIdResponses, FindPostByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/posts/{id}',
...options
});
}
/**
* Update a Post
*/
public static updatePost<ThrowOnError extends boolean = false>(options: Options<UpdatePostData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePostResponses, UpdatePostErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/posts/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Media {
/**
* Retrieve a list of Media
*/
public static listMedia<ThrowOnError extends boolean = false>(options?: Options<ListMediaData, ThrowOnError>) {
return (options?.client ?? client).get<ListMediaResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/media',
...options
});
}
/**
* Create a new Media
*/
public static createMedia<ThrowOnError extends boolean = false>(options?: Options<CreateMediaData, ThrowOnError>) {
return (options?.client ?? client).post<CreateMediaResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/media',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Media
*/
public static deleteMedia<ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/media/{id}',
...options
});
}
/**
* Find a Media by ID
*/
public static findMediaById<ThrowOnError extends boolean = false>(options: Options<FindMediaByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindMediaByIdResponses, FindMediaByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/media/{id}',
...options
});
}
/**
* Update a Media
*/
public static updateMedia<ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/media/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Categories {
/**
* Retrieve a list of Categories
*/
public static listCategories<ThrowOnError extends boolean = false>(options?: Options<ListCategoriesData, ThrowOnError>) {
return (options?.client ?? client).get<ListCategoriesResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/categories',
...options
});
}
/**
* Create a new Category
*/
public static createCategory<ThrowOnError extends boolean = false>(options?: Options<CreateCategoryData, ThrowOnError>) {
return (options?.client ?? client).post<CreateCategoryResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/categories',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Category
*/
public static deleteCategory<ThrowOnError extends boolean = false>(options: Options<DeleteCategoryData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteCategoryResponses, DeleteCategoryErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/categories/{id}',
...options
});
}
/**
* Find a Category by ID
*/
public static findCategoryById<ThrowOnError extends boolean = false>(options: Options<FindCategoryByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindCategoryByIdResponses, FindCategoryByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/categories/{id}',
...options
});
}
/**
* Update a Category
*/
public static updateCategory<ThrowOnError extends boolean = false>(options: Options<UpdateCategoryData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateCategoryResponses, UpdateCategoryErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/categories/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Users {
/**
* Retrieve a list of Users
*/
public static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>) {
return (options?.client ?? client).get<ListUsersResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/users',
...options
});
}
/**
* Create a new User
*/
public static createUser<ThrowOnError extends boolean = false>(options?: Options<CreateUserData, ThrowOnError>) {
return (options?.client ?? client).post<CreateUserResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/users',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a User
*/
public static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteUserResponses, DeleteUserErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/users/{id}',
...options
});
}
/**
* Find a User by ID
*/
public static findUserById<ThrowOnError extends boolean = false>(options: Options<FindUserByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindUserByIdResponses, FindUserByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/users/{id}',
...options
});
}
/**
* Update a User
*/
public static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateUserResponses, UpdateUserErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/users/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Tenants {
/**
* Retrieve a list of Tenants
*/
public static listTenants<ThrowOnError extends boolean = false>(options?: Options<ListTenantsData, ThrowOnError>) {
return (options?.client ?? client).get<ListTenantsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/tenants',
...options
});
}
/**
* Create a new Tenant
*/
public static createTenant<ThrowOnError extends boolean = false>(options?: Options<CreateTenantData, ThrowOnError>) {
return (options?.client ?? client).post<CreateTenantResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/tenants',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Tenant
*/
public static deleteTenant<ThrowOnError extends boolean = false>(options: Options<DeleteTenantData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteTenantResponses, DeleteTenantErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/tenants/{id}',
...options
});
}
/**
* Find a Tenant by ID
*/
public static findTenantById<ThrowOnError extends boolean = false>(options: Options<FindTenantByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindTenantByIdResponses, FindTenantByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/tenants/{id}',
...options
});
}
/**
* Update a Tenant
*/
public static updateTenant<ThrowOnError extends boolean = false>(options: Options<UpdateTenantData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateTenantResponses, UpdateTenantErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/tenants/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Redirects {
/**
* Retrieve a list of Redirects
*/
public static listRedirects<ThrowOnError extends boolean = false>(options?: Options<ListRedirectsData, ThrowOnError>) {
return (options?.client ?? client).get<ListRedirectsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/redirects',
...options
});
}
/**
* Create a new Redirect
*/
public static createRedirect<ThrowOnError extends boolean = false>(options?: Options<CreateRedirectData, ThrowOnError>) {
return (options?.client ?? client).post<CreateRedirectResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/redirects',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Redirect
*/
public static deleteRedirect<ThrowOnError extends boolean = false>(options: Options<DeleteRedirectData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteRedirectResponses, DeleteRedirectErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/redirects/{id}',
...options
});
}
/**
* Find a Redirect by ID
*/
public static findRedirectById<ThrowOnError extends boolean = false>(options: Options<FindRedirectByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindRedirectByIdResponses, FindRedirectByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/redirects/{id}',
...options
});
}
/**
* Update a Redirect
*/
public static updateRedirect<ThrowOnError extends boolean = false>(options: Options<UpdateRedirectData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateRedirectResponses, UpdateRedirectErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/redirects/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Forms {
/**
* Retrieve a list of Forms
*/
public static listForms<ThrowOnError extends boolean = false>(options?: Options<ListFormsData, ThrowOnError>) {
return (options?.client ?? client).get<ListFormsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/forms',
...options
});
}
/**
* Create a new Form
*/
public static createForm<ThrowOnError extends boolean = false>(options?: Options<CreateFormData, ThrowOnError>) {
return (options?.client ?? client).post<CreateFormResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/forms',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Form
*/
public static deleteForm<ThrowOnError extends boolean = false>(options: Options<DeleteFormData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteFormResponses, DeleteFormErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/forms/{id}',
...options
});
}
/**
* Find a Form by ID
*/
public static findFormById<ThrowOnError extends boolean = false>(options: Options<FindFormByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindFormByIdResponses, FindFormByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/forms/{id}',
...options
});
}
/**
* Update a Form
*/
public static updateForm<ThrowOnError extends boolean = false>(options: Options<UpdateFormData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateFormResponses, UpdateFormErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/forms/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class FormSubmissions {
/**
* Retrieve a list of Form Submissions
*/
public static listFormSubmissions<ThrowOnError extends boolean = false>(options?: Options<ListFormSubmissionsData, ThrowOnError>) {
return (options?.client ?? client).get<ListFormSubmissionsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/form-submissions',
...options
});
}
/**
* Create a new Form Submission
*/
public static createFormSubmission<ThrowOnError extends boolean = false>(options?: Options<CreateFormSubmissionData, ThrowOnError>) {
return (options?.client ?? client).post<CreateFormSubmissionResponses, unknown, ThrowOnError>({
url: '/api/form-submissions',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Form Submission
*/
public static deleteFormSubmission<ThrowOnError extends boolean = false>(options: Options<DeleteFormSubmissionData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteFormSubmissionResponses, DeleteFormSubmissionErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/form-submissions/{id}',
...options
});
}
/**
* Find a Form Submission by ID
*/
public static findFormSubmissionById<ThrowOnError extends boolean = false>(options: Options<FindFormSubmissionByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindFormSubmissionByIdResponses, FindFormSubmissionByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/form-submissions/{id}',
...options
});
}
/**
* Update a Form Submission
*/
public static updateFormSubmission<ThrowOnError extends boolean = false>(options: Options<UpdateFormSubmissionData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateFormSubmissionResponses, UpdateFormSubmissionErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/form-submissions/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class SearchResults {
/**
* Retrieve a list of Search Results
*/
public static listSearchResults<ThrowOnError extends boolean = false>(options?: Options<ListSearchResultsData, ThrowOnError>) {
return (options?.client ?? client).get<ListSearchResultsResponses, unknown, ThrowOnError>({ url: '/api/search', ...options });
}
/**
* Create a new Search Result
*/
public static createSearchResult<ThrowOnError extends boolean = false>(options?: Options<CreateSearchResultData, ThrowOnError>) {
return (options?.client ?? client).post<CreateSearchResultResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/search',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Search Result
*/
public static deleteSearchResult<ThrowOnError extends boolean = false>(options: Options<DeleteSearchResultData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteSearchResultResponses, DeleteSearchResultErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/search/{id}',
...options
});
}
/**
* Find a Search Result by ID
*/
public static findSearchResultById<ThrowOnError extends boolean = false>(options: Options<FindSearchResultByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindSearchResultByIdResponses, FindSearchResultByIdErrors, ThrowOnError>({ url: '/api/search/{id}', ...options });
}
/**
* Update a Search Result
*/
public static updateSearchResult<ThrowOnError extends boolean = false>(options: Options<UpdateSearchResultData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateSearchResultResponses, UpdateSearchResultErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/search/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class PayloadKvs {
/**
* Retrieve a list of Payload Kvs
*/
public static listPayloadKvs<ThrowOnError extends boolean = false>(options?: Options<ListPayloadKvsData, ThrowOnError>) {
return (options?.client ?? client).get<ListPayloadKvsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-kv',
...options
});
}
/**
* Create a new Payload Kv
*/
public static createPayloadKv<ThrowOnError extends boolean = false>(options?: Options<CreatePayloadKvData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePayloadKvResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-kv',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Payload Kv
*/
public static deletePayloadKv<ThrowOnError extends boolean = false>(options: Options<DeletePayloadKvData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePayloadKvResponses, DeletePayloadKvErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-kv/{id}',
...options
});
}
/**
* Find a Payload Kv by ID
*/
public static findPayloadKvById<ThrowOnError extends boolean = false>(options: Options<FindPayloadKvByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPayloadKvByIdResponses, FindPayloadKvByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-kv/{id}',
...options
});
}
/**
* Update a Payload Kv
*/
public static updatePayloadKv<ThrowOnError extends boolean = false>(options: Options<UpdatePayloadKvData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePayloadKvResponses, UpdatePayloadKvErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-kv/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class PayloadJobs {
/**
* Retrieve a list of Payload Jobs
*/
public static listPayloadJobs<ThrowOnError extends boolean = false>(options?: Options<ListPayloadJobsData, ThrowOnError>) {
return (options?.client ?? client).get<ListPayloadJobsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-jobs',
...options
});
}
/**
* Create a new Payload Job
*/
public static createPayloadJob<ThrowOnError extends boolean = false>(options?: Options<CreatePayloadJobData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePayloadJobResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-jobs',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Payload Job
*/
public static deletePayloadJob<ThrowOnError extends boolean = false>(options: Options<DeletePayloadJobData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePayloadJobResponses, DeletePayloadJobErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-jobs/{id}',
...options
});
}
/**
* Find a Payload Job by ID
*/
public static findPayloadJobById<ThrowOnError extends boolean = false>(options: Options<FindPayloadJobByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPayloadJobByIdResponses, FindPayloadJobByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-jobs/{id}',
...options
});
}
/**
* Update a Payload Job
*/
public static updatePayloadJob<ThrowOnError extends boolean = false>(options: Options<UpdatePayloadJobData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePayloadJobResponses, UpdatePayloadJobErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-jobs/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Folders {
/**
* Retrieve a list of Folders
*/
public static listFolders<ThrowOnError extends boolean = false>(options?: Options<ListFoldersData, ThrowOnError>) {
return (options?.client ?? client).get<ListFoldersResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-folders',
...options
});
}
/**
* Create a new Folder
*/
public static createFolder<ThrowOnError extends boolean = false>(options?: Options<CreateFolderData, ThrowOnError>) {
return (options?.client ?? client).post<CreateFolderResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-folders',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Folder
*/
public static deleteFolder<ThrowOnError extends boolean = false>(options: Options<DeleteFolderData, ThrowOnError>) {
return (options.client ?? client).delete<DeleteFolderResponses, DeleteFolderErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-folders/{id}',
...options
});
}
/**
* Find a Folder by ID
*/
public static findFolderById<ThrowOnError extends boolean = false>(options: Options<FindFolderByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindFolderByIdResponses, FindFolderByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-folders/{id}',
...options
});
}
/**
* Update a Folder
*/
public static updateFolder<ThrowOnError extends boolean = false>(options: Options<UpdateFolderData, ThrowOnError>) {
return (options.client ?? client).patch<UpdateFolderResponses, UpdateFolderErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-folders/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class PayloadLockedDocuments {
/**
* Retrieve a list of Payload Locked Documents
*/
public static listPayloadLockedDocuments<ThrowOnError extends boolean = false>(options?: Options<ListPayloadLockedDocumentsData, ThrowOnError>) {
return (options?.client ?? client).get<ListPayloadLockedDocumentsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-locked-documents',
...options
});
}
/**
* Create a new Payload Locked Document
*/
public static createPayloadLockedDocument<ThrowOnError extends boolean = false>(options?: Options<CreatePayloadLockedDocumentData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePayloadLockedDocumentResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-locked-documents',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Payload Locked Document
*/
public static deletePayloadLockedDocument<ThrowOnError extends boolean = false>(options: Options<DeletePayloadLockedDocumentData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePayloadLockedDocumentResponses, DeletePayloadLockedDocumentErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-locked-documents/{id}',
...options
});
}
/**
* Find a Payload Locked Document by ID
*/
public static findPayloadLockedDocumentById<ThrowOnError extends boolean = false>(options: Options<FindPayloadLockedDocumentByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPayloadLockedDocumentByIdResponses, FindPayloadLockedDocumentByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-locked-documents/{id}',
...options
});
}
/**
* Update a Payload Locked Document
*/
public static updatePayloadLockedDocument<ThrowOnError extends boolean = false>(options: Options<UpdatePayloadLockedDocumentData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePayloadLockedDocumentResponses, UpdatePayloadLockedDocumentErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-locked-documents/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class PayloadPreferences {
/**
* Retrieve a list of Payload Preferences
*/
public static listPayloadPreferences<ThrowOnError extends boolean = false>(options?: Options<ListPayloadPreferencesData, ThrowOnError>) {
return (options?.client ?? client).get<ListPayloadPreferencesResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-preferences',
...options
});
}
/**
* Create a new Payload Preference
*/
public static createPayloadPreference<ThrowOnError extends boolean = false>(options?: Options<CreatePayloadPreferenceData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePayloadPreferenceResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-preferences',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Payload Preference
*/
public static deletePayloadPreference<ThrowOnError extends boolean = false>(options: Options<DeletePayloadPreferenceData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePayloadPreferenceResponses, DeletePayloadPreferenceErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-preferences/{id}',
...options
});
}
/**
* Find a Payload Preference by ID
*/
public static findPayloadPreferenceById<ThrowOnError extends boolean = false>(options: Options<FindPayloadPreferenceByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPayloadPreferenceByIdResponses, FindPayloadPreferenceByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-preferences/{id}',
...options
});
}
/**
* Update a Payload Preference
*/
public static updatePayloadPreference<ThrowOnError extends boolean = false>(options: Options<UpdatePayloadPreferenceData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePayloadPreferenceResponses, UpdatePayloadPreferenceErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-preferences/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class PayloadMigrations {
/**
* Retrieve a list of Payload Migrations
*/
public static listPayloadMigrations<ThrowOnError extends boolean = false>(options?: Options<ListPayloadMigrationsData, ThrowOnError>) {
return (options?.client ?? client).get<ListPayloadMigrationsResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-migrations',
...options
});
}
/**
* Create a new Payload Migration
*/
public static createPayloadMigration<ThrowOnError extends boolean = false>(options?: Options<CreatePayloadMigrationData, ThrowOnError>) {
return (options?.client ?? client).post<CreatePayloadMigrationResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-migrations',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
/**
* Delete a Payload Migration
*/
public static deletePayloadMigration<ThrowOnError extends boolean = false>(options: Options<DeletePayloadMigrationData, ThrowOnError>) {
return (options.client ?? client).delete<DeletePayloadMigrationResponses, DeletePayloadMigrationErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-migrations/{id}',
...options
});
}
/**
* Find a Payload Migration by ID
*/
public static findPayloadMigrationById<ThrowOnError extends boolean = false>(options: Options<FindPayloadMigrationByIdData, ThrowOnError>) {
return (options.client ?? client).get<FindPayloadMigrationByIdResponses, FindPayloadMigrationByIdErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-migrations/{id}',
...options
});
}
/**
* Update a Payload Migration
*/
public static updatePayloadMigration<ThrowOnError extends boolean = false>(options: Options<UpdatePayloadMigrationData, ThrowOnError>) {
return (options.client ?? client).patch<UpdatePayloadMigrationResponses, UpdatePayloadMigrationErrors, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/payload-migrations/{id}',
...options,
headers: {
'Content-Type': 'application/json',
...options.headers
}
});
}
}
export class Header {
/**
* Get the Header
*/
public static getApiGlobalsHeader<ThrowOnError extends boolean = false>(options?: Options<GetApiGlobalsHeaderData, ThrowOnError>) {
return (options?.client ?? client).get<GetApiGlobalsHeaderResponses, unknown, ThrowOnError>({ url: '/api/globals/header', ...options });
}
/**
* Update the Header
*/
public static postApiGlobalsHeader<ThrowOnError extends boolean = false>(options?: Options<PostApiGlobalsHeaderData, ThrowOnError>) {
return (options?.client ?? client).post<PostApiGlobalsHeaderResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/globals/header',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
}
export class Footer {
/**
* Get the Footer
*/
public static getApiGlobalsFooter<ThrowOnError extends boolean = false>(options?: Options<GetApiGlobalsFooterData, ThrowOnError>) {
return (options?.client ?? client).get<GetApiGlobalsFooterResponses, unknown, ThrowOnError>({ url: '/api/globals/footer', ...options });
}
/**
* Update the Footer
*/
public static postApiGlobalsFooter<ThrowOnError extends boolean = false>(options?: Options<PostApiGlobalsFooterData, ThrowOnError>) {
return (options?.client ?? client).post<PostApiGlobalsFooterResponses, unknown, ThrowOnError>({
security: [{ scheme: 'bearer', type: 'http' }],
url: '/api/globals/footer',
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers
}
});
}
}