@wix/auto_sdk_editor-branches_branches 1.0.11 → 1.0.12

package/build/cjs/index.d.ts

@@ -1 +1,89 @@
-export * from './src/editor-branches-v1-branch-branches.context.js';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Branch, CreateBranchApplicationErrors, UpdateBranch, UpdateBranchApplicationErrors, DeleteBranchApplicationErrors, BranchesQueryBuilder, SetDefaultBranchResponse, GetDefaultBranchResponse, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, Asset, BaseEventMetadata, BranchSourceOneOf, BranchesQueryResult, CreateBranchRequest, CreateBranchResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteBranchRequest, DeleteBranchResponse, DeleteContext, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorType, EditorTypeOptions, EditorTypeOptionsWithLiterals, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetBranchRequest, GetBranchResponse, GetDefaultBranchRequest, HtmlSitePublished, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, PicassoAssigned, PicassoUnassigned, QueryBranchesRequest, QueryBranchesResponse, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetDefaultBranchRequest, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SourceBranch, SourceTemplate, SourceType, SourceTypeWithLiterals, State, StateWithLiterals, StudioAssigned, StudioUnassigned, Type, TypeWithLiterals, UpdateBranchRequest, UpdateBranchResponse, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function createBranch$1(httpClient: HttpClient): CreateBranchSignature;
+interface CreateBranchSignature {
+    /**
+     * Creates a branch.
+     * If a source branch is not provided, the branch will include a blank website.
+     * @param - Branch to be created.
+     * @returns Created branch.
+     */
+    (branch: Branch): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3> & {
+        __applicationErrorsType?: CreateBranchApplicationErrors;
+    }>;
+}
+declare function getBranch$1(httpClient: HttpClient): GetBranchSignature;
+interface GetBranchSignature {
+    /**
+     * Retrieves a branch.
+     * @param - ID of branch to retrieve.
+     * @returns Requested branch.
+     */
+    (branchId: string): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3>>;
+}
+declare function updateBranch$1(httpClient: HttpClient): UpdateBranchSignature;
+interface UpdateBranchSignature {
+    /**
+     * Updates a branch.
+     *
+     * `ORIGINAL_BRANCH` types can't be updated.
+     * @param - Branch ID.
+     * @returns Updated branch.
+     */
+    (_id: string, branch: NonNullablePaths<UpdateBranch, `revision`, 2>): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3> & {
+        __applicationErrorsType?: UpdateBranchApplicationErrors;
+    }>;
+}
+declare function deleteBranch$1(httpClient: HttpClient): DeleteBranchSignature;
+interface DeleteBranchSignature {
+    /**
+     * Permanently deletes a branch.
+     * @param - ID of branch to delete.
+     */
+    (branchId: string): Promise<void & {
+        __applicationErrorsType?: DeleteBranchApplicationErrors;
+    }>;
+}
+declare function queryBranches$1(httpClient: HttpClient): QueryBranchesSignature;
+interface QueryBranchesSignature {
+    /**
+     * Retrieves a list of branches, given the specified [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+     */
+    (): BranchesQueryBuilder;
+}
+declare function setDefaultBranch$1(httpClient: HttpClient): SetDefaultBranchSignature;
+interface SetDefaultBranchSignature {
+    /**
+     * Set branch as the default branch.
+     * @param - Branch Id.
+     */
+    (branchId: string): Promise<NonNullablePaths<SetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
+}
+declare function getDefaultBranch$1(httpClient: HttpClient): GetDefaultBranchSignature;
+interface GetDefaultBranchSignature {
+    /**
+     * Get default branch.
+     */
+    (): Promise<NonNullablePaths<GetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
+}
+declare const onBranchCreated$1: EventDefinition<BranchCreatedEnvelope, "wix.editor.branches.v1.branch_created">;
+declare const onBranchDeleted$1: EventDefinition<BranchDeletedEnvelope, "wix.editor.branches.v1.branch_deleted">;
+declare const onBranchUpdated$1: EventDefinition<BranchUpdatedEnvelope, "wix.editor.branches.v1.branch_updated">;
+
+declare const createBranch: MaybeContext<BuildRESTFunction<typeof createBranch$1> & typeof createBranch$1>;
+declare const getBranch: MaybeContext<BuildRESTFunction<typeof getBranch$1> & typeof getBranch$1>;
+declare const updateBranch: MaybeContext<BuildRESTFunction<typeof updateBranch$1> & typeof updateBranch$1>;
+declare const deleteBranch: MaybeContext<BuildRESTFunction<typeof deleteBranch$1> & typeof deleteBranch$1>;
+declare const queryBranches: MaybeContext<BuildRESTFunction<typeof queryBranches$1> & typeof queryBranches$1>;
+declare const setDefaultBranch: MaybeContext<BuildRESTFunction<typeof setDefaultBranch$1> & typeof setDefaultBranch$1>;
+declare const getDefaultBranch: MaybeContext<BuildRESTFunction<typeof getDefaultBranch$1> & typeof getDefaultBranch$1>;
+/** */
+declare const onBranchCreated: BuildEventDefinition<typeof onBranchCreated$1>;
+/** */
+declare const onBranchDeleted: BuildEventDefinition<typeof onBranchDeleted$1>;
+/** */
+declare const onBranchUpdated: BuildEventDefinition<typeof onBranchUpdated$1>;
+
+export { Branch, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope, BranchesQueryBuilder, CreateBranchApplicationErrors, DeleteBranchApplicationErrors, GetDefaultBranchResponse, SetDefaultBranchResponse, UpdateBranch, UpdateBranchApplicationErrors, createBranch, deleteBranch, getBranch, getDefaultBranch, onBranchCreated, onBranchDeleted, onBranchUpdated, queryBranches, setDefaultBranch, updateBranch };