@wix/auto_sdk_premium_google-subscriptions 1.0.0

package/build/internal/es/index.d.mts

@@ -0,0 +1,96 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { IsEligibleOptions, IsEligibleResponse, ObserveEmailActionsOptions, ObserveEmailActionsResponse, ReceiveCloudChannelPushOptions, RawHttpResponse, RetrieveUsersByDomainResponse, GetStorageUsageResponse, GetStorageUsageApplicationErrors, AssignLicenseOptions, RevokeLicenseOptions, GoogleSubscriptionsQueryBuilder, GoogleSubscriptionQuery, typedQueryGoogleSubscriptions } from './index.typings.mjs';
+export { AcceptTosRequired, AccountInfo, ActionEvent, AddonAlreadyExists, AssignLicenseRequest, AssignLicenseResponse, CommonQueryWithEntityContext, CreateGoogleSubscriptionRequest, CreateGoogleSubscriptionResponse, CursorPaging, CursorPagingMetadata, Cursors, DeleteGoogleSubscriptionRequest, DeleteGoogleSubscriptionResponse, DomainEvent, DomainEventBodyOneOf, DomainNotFound, DomainNotOwnedByUser, EligibilityResult, EligibilityResultResultOneOf, Eligible, EmailPackageAlreadyExists, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetGoogleSubscriptionRequest, GetGoogleSubscriptionResponse, GetStorageUsageRequest, GoogleCustomerAlreadyTakenOnGoogle, GoogleData, GoogleSubscription, GoogleSubscriptionQuerySpec, GoogleSubscriptionsQueryResult, GoogleWorkspaceValidationFailure, HeadersEntry, IdentificationData, IdentificationDataIdOneOf, IncompatibleGWSSeats, IncompatibleWithCurrentGWSProduct, InvalidDomainName, InvalidRequestedSeats, IsEligibleRequest, MessageEnvelope, NoGWSFound, NoPurchasableSkus, NotEligible, NotEligibleCloudIdentityType, NotEligibleCountry, NotEligibleReason, NotEligibleReasonReasonOneOf, ObserveEmailActionsRequest, Paging, PathParametersEntry, PostEligibilityActions, QueryGoogleSubscriptionsRequest, QueryGoogleSubscriptionsResponse, QueryParametersEntry, QueryV2, QueryV2PagingMethodOneOf, RawHttpRequest, RecoveryAction, RecoveryActionWithLiterals, RecoveryReason, RecoveryReasonWithLiterals, RenewalType, RenewalTypeWithLiterals, ResolveEmailActionRequest, ResolveEmailActionResponse, RestoreInfo, RestrictedDomainName, RestrictedDomainReason, RestrictedDomainReasonWithLiterals, RetrieveUsersByDomainRequest, RevokeLicenseRequest, RevokeLicenseResponse, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, UpdateGoogleSubscriptionRequest, UpdateGoogleSubscriptionResponse, User, UserName, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WorkspaceSubscriptionAlreadyExists, utils } from './index.typings.mjs';
+
+declare function isEligible$1(httpClient: HttpClient): IsEligibleSignature;
+interface IsEligibleSignature {
+    /**
+     * Checks whether the caller's account can purchase a Google product for a domain.
+     *
+     * Specify the product in `productTypeId`. Supported products: Business Email, Business Email for Base44, Google Workspace, and the Google Voice add-on.
+     *
+     * The response contains either an eligible result, with the maximum number of seats the account can purchase, or a not-eligible result that lists the reasons.
+     *
+     * To check eligibility to upgrade an existing Business Email subscription, specify `existingSubscriptionPremiumId`.
+     */
+    (options?: IsEligibleOptions): Promise<NonNullablePaths<IsEligibleResponse, `domainName` | `result.eligible.seats` | `result.eligible.freeTrial` | `result.eligible.renewalType` | `result.notEligible.reasons` | `result.notEligible.reasons.${number}.invalidRequestedSeats.availableSeats` | `result.notEligible.reasons.${number}.invalidRequestedSeats.requestedSeat` | `result.notEligible.reasons.${number}.incompatibleGws.gwsSkuId` | `result.notEligible.reasons.${number}.acceptTosRequired.acceptTosGwsId` | `result.notEligible.reasons.${number}.alreadyTaken.domainName` | `result.notEligible.reasons.${number}.emailPackageAlreadyExists.domainName` | `result.notEligible.reasons.${number}.emailPackageAlreadyExists.targetAccountId` | `result.notEligible.reasons.${number}.domainNotOwnedByUser.domainName` | `result.notEligible.reasons.${number}.domainNotFound.domainName` | `result.notEligible.reasons.${number}.noPurchasableSkus.domainName` | `result.notEligible.reasons.${number}.addonAlreadyExists.domainName` | `result.notEligible.reasons.${number}.addonAlreadyExists.status` | `result.notEligible.reasons.${number}.addonAlreadyExists.productTypeId` | `result.notEligible.reasons.${number}.notEligibleCountry.domainName` | `result.notEligible.reasons.${number}.notEligibleCountry.countryCode` | `result.notEligible.reasons.${number}.notEligibleCloudIdentityType.domainName` | `result.notEligible.reasons.${number}.notEligibleCloudIdentityType.reason` | `result.notEligible.reasons.${number}.invalidDomainName.domainName` | `result.notEligible.reasons.${number}.workspaceSubscriptionAlreadyExists.domainName` | `result.notEligible.reasons.${number}.workspaceSubscriptionAlreadyExists.status` | `result.notEligible.reasons.${number}.workspaceSubscriptionAlreadyExists.productTypeId` | `result.notEligible.reasons.${number}.restrictedDomainName.domainName` | `result.notEligible.reasons.${number}.restrictedDomainName.reason` | `result.notEligible.reasons.${number}.validationFailure.reason` | `result.notEligible.reasons.${number}.incompatibleSeats.seats` | `results` | `results.${number}.eligible.seats` | `results.${number}.eligible.freeTrial` | `results.${number}.eligible.renewalType`, 5>>;
+}
+declare function observeEmailActions$1(httpClient: HttpClient): ObserveEmailActionsSignature;
+interface ObserveEmailActionsSignature {
+    /**
+     * Evaluates the email recovery state of the specified domains.
+     *
+     * Returns only how many domains were evaluated and how many were skipped. Results for individual domains aren't returned, and the method doesn't change any data.
+     *
+     * Domains the caller's account doesn't own are skipped. Up to 20 distinct domains are evaluated per request, and any others are counted in `skipped`.
+     *
+     * Evaluation isn't available for every caller. When it isn't available, every requested domain is counted in `skipped`.
+     */
+    (options?: ObserveEmailActionsOptions): Promise<NonNullablePaths<ObserveEmailActionsResponse, `observed` | `skipped`, 0>>;
+}
+declare function receiveCloudChannelPush$1(httpClient: HttpClient): ReceiveCloudChannelPushSignature;
+interface ReceiveCloudChannelPushSignature {
+    /**
+     * Receives Google Cloud Channel push notifications about Business Email customers, and isn't intended to be called by apps.
+     */
+    (options?: ReceiveCloudChannelPushOptions): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 2>>;
+}
+declare function retrieveUsersByDomain$1(httpClient: HttpClient): RetrieveUsersByDomainSignature;
+interface RetrieveUsersByDomainSignature {
+    /**
+     * Retrieves the users of the Google Workspace on a domain owned by the caller's account.
+     *
+     * Returns all users, including administrators, up to 300 users. Additional users aren't returned, and the method doesn't support paging.
+     * @param - Domain whose Google Workspace users to retrieve. Must be a domain the caller's account owns.
+     */
+    (domainName: string): Promise<NonNullablePaths<RetrieveUsersByDomainResponse, `users` | `users.${number}._id` | `users.${number}.primaryEmail` | `users.${number}.admin` | `users.${number}.delegatedAdmin` | `users.${number}.customerId`, 2>>;
+}
+declare function getStorageUsage$1(httpClient: HttpClient): GetStorageUsageSignature;
+interface GetStorageUsageSignature {
+    /**
+     * Retrieves how much storage a Google Workspace has used out of its pooled quota.
+     *
+     * The numbers come from Google's daily usage report, so they trail live usage by about a day. `asOfDate` is the report day.
+     *
+     * The response is empty when no usage data is available. For example, when the subscription isn't live, when Google doesn't grant access to the customer's reports, or when the day's report isn't published yet.
+     *
+     * Storage usage isn't available for every caller. When it isn't available, the response is empty.
+     * @param - Premium subscription ID of the Google Workspace whose storage usage to retrieve.
+     */
+    (googleWorkspacePremiumId: string): Promise<GetStorageUsageResponse & {
+        __applicationErrorsType?: GetStorageUsageApplicationErrors;
+    }>;
+}
+/** @internal */
+declare function assignLicense$1(httpClient: HttpClient): AssignLicenseSignature;
+interface AssignLicenseSignature {
+    /**
+     * Assigns a Google subscription license to a user.
+     */
+    (options?: AssignLicenseOptions): Promise<void>;
+}
+/** @internal */
+declare function revokeLicense$1(httpClient: HttpClient): RevokeLicenseSignature;
+interface RevokeLicenseSignature {
+    /**
+     * Revokes a user's Google subscription license.
+     */
+    (options?: RevokeLicenseOptions): Promise<void>;
+}
+
+declare function customQueryGoogleSubscriptions(httpClient: HttpClient): {
+    (): GoogleSubscriptionsQueryBuilder;
+    (query: GoogleSubscriptionQuery): ReturnType<typeof typedQueryGoogleSubscriptions>;
+};
+declare const isEligible: MaybeContext<BuildRESTFunction<typeof isEligible$1> & typeof isEligible$1>;
+declare const observeEmailActions: MaybeContext<BuildRESTFunction<typeof observeEmailActions$1> & typeof observeEmailActions$1>;
+declare const receiveCloudChannelPush: MaybeContext<BuildRESTFunction<typeof receiveCloudChannelPush$1> & typeof receiveCloudChannelPush$1>;
+declare const retrieveUsersByDomain: MaybeContext<BuildRESTFunction<typeof retrieveUsersByDomain$1> & typeof retrieveUsersByDomain$1>;
+declare const getStorageUsage: MaybeContext<BuildRESTFunction<typeof getStorageUsage$1> & typeof getStorageUsage$1>;
+/** @internal */
+declare const assignLicense: MaybeContext<BuildRESTFunction<typeof assignLicense$1> & typeof assignLicense$1>;
+/** @internal */
+declare const revokeLicense: MaybeContext<BuildRESTFunction<typeof revokeLicense$1> & typeof revokeLicense$1>;
+declare const queryGoogleSubscriptions: MaybeContext<BuildRESTFunction<typeof customQueryGoogleSubscriptions> & typeof customQueryGoogleSubscriptions>;
+
+export { AssignLicenseOptions, GetStorageUsageApplicationErrors, GetStorageUsageResponse, GoogleSubscriptionQuery, GoogleSubscriptionsQueryBuilder, IsEligibleOptions, IsEligibleResponse, ObserveEmailActionsOptions, ObserveEmailActionsResponse, RawHttpResponse, ReceiveCloudChannelPushOptions, RetrieveUsersByDomainResponse, RevokeLicenseOptions, assignLicense, getStorageUsage, isEligible, observeEmailActions, queryGoogleSubscriptions, receiveCloudChannelPush, retrieveUsersByDomain, revokeLicense };