import { ListPage } from '../models/ListPage'; import { Searchable } from '../models/Searchable'; import { Sortable } from '../models/Sortable'; import { Filters } from '../models/Filters'; import { Organization } from '../models/Organization'; import { BackboneLoginUrl } from '../models/BackboneLoginUrl'; import { StagingRestoreWebhook } from '../models/StagingRestoreWebhook'; import { OrganizationTransfer } from '../models/OrganizationTransfer'; import { User } from '../models/User'; import { ContributorDetail } from '../models/ContributorDetail'; import { UserAssignment } from '../models/UserAssignment'; import { TeamAssignment } from '../models/TeamAssignment'; import { OrgAssignmentRequest } from '../models/OrgAssignmentRequest'; import { SearchIndexResponse } from '../models/SearchIndexResponse'; import { SearchIndexErrorResponse } from '../models/SearchIndexErrorResponse'; import { SearchIndexRebuildRequest } from '../models/SearchIndexRebuildRequest'; import { ProcessSubscriptionsRequest } from '../models/ProcessSubscriptionsRequest'; import { ProcessSubscriptionsResponse } from '../models/ProcessSubscriptionsResponse'; import { SyncCatalogRequest } from '../models/SyncCatalogRequest'; import { SyncOrdersRequest } from '../models/SyncOrdersRequest'; import { RequiredDeep } from '../models/RequiredDeep'; import { RequestOptions } from '../models/RequestOptions'; declare class Organizations { /** * @ignore * not part of public api, don't include in generated docs */ constructor(); /** * Get a list of seller organizations you have access to * * @param listOptions.search * @param listOptions.page * @param listOptions.pageSize * @param listOptions.searchOn * @param listOptions.sortBy * @param listOptions.filters Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ List(listOptions?: { search?: string; page?: number; pageSize?: number; searchOn?: Searchable<'Organizations.List'>; sortBy?: Sortable<'Organizations.List'>; filters?: Filters; }, requestOptions?: RequestOptions): Promise>>; /** * Get a single organization * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Get(id: string, requestOptions?: RequestOptions): Promise>; /** * Create or Update a single organization * * @param id Unique identifier of the seller organization * @param organization Required fields: ID, Name * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Save(id: string, organization: Organization, requestOptions?: RequestOptions): Promise>; /** * Permanently delete a single organization * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Delete(id: string, requestOptions?: RequestOptions): Promise; /** * Only works with Organizations properly linked to a Sitecore Org ID * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ GetBackboneLoginUrl(id: string, requestOptions?: RequestOptions): Promise>; /** * Only works with Staging organizations, retrieve the current staging restore webhook information * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ GetStagingRestoreWebhook(id: string, requestOptions?: RequestOptions): Promise>; /** * Only works with Staging organizations, crete or update the current staging restore webhook information * * @param id Unique identifier of the seller organization * @param stagingRestoreWebhook Required fields: URL * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ SaveStagingRestoreWebhook(id: string, stagingRestoreWebhook: StagingRestoreWebhook, requestOptions?: RequestOptions): Promise>; /** * Only works with Staging organizations, permanently delete a staging restore webhook * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ DeleteStagingRestoreWebhook(id: string, requestOptions?: RequestOptions): Promise; /** * Only works with Staging organizations, test the current staging restore webhook * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ TestStagingRestoreWebhook(id: string, requestOptions?: RequestOptions): Promise; /** * Transfer an organization you own to a contributor * * @param id Unique identifier of the seller organization * @param organizationTransfer * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Transfer(id: string, organizationTransfer: OrganizationTransfer, requestOptions?: RequestOptions): Promise; /** * Get a list of contributors for a seller organization * * @param listOptions.search * @param listOptions.page * @param listOptions.pageSize * @param listOptions.searchOn * @param listOptions.sortBy * @param listOptions.filters Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ListContributors(id: string, listOptions?: { search?: string; page?: number; pageSize?: number; searchOn?: Searchable<'Organizaions.ListContributors'>; sortBy?: Sortable<'Organizaions.ListContributors'>; filters?: Filters; }, requestOptions?: RequestOptions): Promise>>; /** * Get a single contributor * * @param id Unique identifier of the seller organization * @param username Username of the contributor * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ GetContributor(id: string, username: string, requestOptions?: RequestOptions): Promise>; /** * Get a list of user assignments by organization * * @param listOptions.page * @param listOptions.pageSize * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ListUserAssignments(id: string, listOptions?: { page?: number; pageSize?: number; }, requestOptions?: RequestOptions): Promise>>; /** * Get a list of team assignments by organization * * @param listOptions.page * @param listOptions.pageSize * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ListTeamAssignments(id: string, listOptions?: { page?: number; pageSize?: number; }, requestOptions?: RequestOptions): Promise>>; /** * Create or update an assignment of a user to an organization * * @param id Unique identifier of the seller organization * @param username Username of the contributing user * @param orgAssignmentRequest * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ SaveUserAssignment(id: string, username: string, orgAssignmentRequest: OrgAssignmentRequest, requestOptions?: RequestOptions): Promise; /** * Delete an assignment of a user to an organization * * @param id Unique identifier of the seller organization * @param username Username of the contributing user * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ DeleteUserAssignment(id: string, username: string, requestOptions?: RequestOptions): Promise; /** * Create or update an assignment of a team to an organization * * @param id Unique identifier of the seller organization * @param teamId Unique identifier of the contributing team * @param orgAssignmentRequest * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ SaveTeamAssignment(id: string, teamId: string, orgAssignmentRequest: OrgAssignmentRequest, requestOptions?: RequestOptions): Promise; /** * Delete an assignment of a team to an organization * * @param id Unique identifier of the seller organization * @param teamId Unique identifier of the contributing team * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ DeleteTeamAssignment(id: string, teamId: string, requestOptions?: RequestOptions): Promise; /** * List search indexes for an organization * * @param id Unique identifier of the seller organization * @param listOptions.type * @param listOptions.status * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ListSearchIndexes(id: string, listOptions?: { type?: 'Products' | 'Orders'; status?: 'Building' | 'Rebuilding' | 'Ready' | 'Failed' | 'Invalid' | 'Canceled' | 'WaitingToBuild'; }, requestOptions?: RequestOptions): Promise>; /** * List search index errors for a given search index * * @param id Unique identifier of the seller organization * @param indexID Unique identifier of the search index * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ListSearchIndexErrors(id: string, indexID: string, requestOptions?: RequestOptions): Promise>; /** * Trigger a search index rebuild for an active search index * * @param id Unique identifier of the seller organization * @param type Type of the search index * @param searchIndexRebuildRequest * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ RebuildSearchIndex(id: string, type: string, searchIndexRebuildRequest: SearchIndexRebuildRequest, requestOptions?: RequestOptions): Promise; /** * Trigger the process subscriptions job outside of the hourly process * * @param id Unique identifier of the seller organization * @param processSubscriptionsRequest * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ProcessSubscriptions(id: string, processSubscriptionsRequest: ProcessSubscriptionsRequest, requestOptions?: RequestOptions): Promise>; /** * Trigger a sync of a given catalog ID and optionally a category ID * * @param id Unique identifier of the seller organization * @param syncCatalogRequest * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ SyncCatalog(id: string, syncCatalogRequest: SyncCatalogRequest, requestOptions?: RequestOptions): Promise; /** * Trigger an order sync with optional start and end date inputs * * @param id Unique identifier of the seller organization * @param syncOrdersRequest * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ SyncOrders(id: string, syncOrdersRequest: SyncOrdersRequest, requestOptions?: RequestOptions): Promise; /** * Retrieve metadata for entity sync models * * @param id Unique identifier of the seller organization * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ EntitySyncMetadata(id: string, requestOptions?: RequestOptions): Promise; } declare const _default: Organizations; export default _default;