@wix/auto_sdk_gbp_locations 1.0.14 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +159 -3
- package/build/cjs/index.js +468 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +732 -8
- package/build/cjs/index.typings.js +414 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +507 -9
- package/build/cjs/meta.js +355 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +159 -3
- package/build/es/index.mjs +458 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +732 -8
- package/build/es/index.typings.mjs +404 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +507 -9
- package/build/es/meta.mjs +345 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +159 -3
- package/build/internal/cjs/index.typings.d.ts +732 -8
- package/build/internal/cjs/meta.d.ts +507 -9
- package/build/internal/es/index.d.mts +159 -3
- package/build/internal/es/index.typings.d.mts +732 -8
- package/build/internal/es/meta.d.mts +507 -9
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { GBPLocation, QueryGoogleLocationsOptions, QueryGoogleLocationsResponse, GetGoogleLocationResponse, CreateLocationApplicationErrors, UpdateLocation, CreateGoogleLocationOptions, CreateGoogleLocationResponse, CreateGoogleLocationApplicationErrors, DeleteGoogleLocationApplicationErrors, GoogleLocation, UpdateGoogleLocationOptions, UpdateGoogleLocationResponse, UpdateGoogleLocationApplicationErrors, BulkCreateLocationsOptions, BulkCreateLocationsResponse, BulkCreateLocationsApplicationErrors, BulkDeleteLocationsResponse, ListGbpAccountsOptions, ListGbpAccountsResponse, ListGbpAccountsApplicationErrors, ListUnimportedLocationsOptions, ListUnimportedLocationsResponse, ListUnimportedLocationsApplicationErrors, GetNotificationSettingResponse, GetNotificationSettingApplicationErrors, UpdateNotificationSetting, UpdateNotificationSettingOptions, UpdateNotificationSettingResponse, UpdateNotificationSettingApplicationErrors, ListReviewsOptions, ListReviewsResponse, ListReviewsApplicationErrors, PutReviewReplyIdentifiers, PutReviewReplyResponse, PutReviewReplyApplicationErrors, DeleteReviewReplyIdentifiers, DeleteReviewReplyApplicationErrors, ListMediaOptions, ListMediaResponse, ListMediaApplicationErrors, CreateMediaOptions, CreateMediaResponse, CreateMediaApplicationErrors, DeleteMediaIdentifiers, DeleteMediaApplicationErrors, LocationAttribute, UpdateLocationAttributesResponse, UpdateLocationAttributesApplicationErrors, GetLocationAttributesResponse, GetLocationAttributesApplicationErrors, GetLocationLodgingResponse, GetLocationLodgingApplicationErrors, Lodging, UpdateLocationLodgingOptions, UpdateLocationLodgingResponse, UpdateLocationLodgingApplicationErrors, ListAttributeMetadataOptions, ListAttributeMetadataResponse, ListAttributeMetadataApplicationErrors, ListCategoriesOptions, ListCategoriesResponse, ListCategoriesApplicationErrors, GetVerificationOptions, GetVerificationOptionsResponse, GetVerificationOptionsApplicationErrors, VerificationMethodWithLiterals, StartVerificationOptions, StartVerificationResponse, StartVerificationApplicationErrors, CompleteVerificationOptions, CompleteVerificationResponse, CompleteVerificationApplicationErrors, GetVoiceOfMerchantResponse, InsightsTimeRange, GetLocationInsightsOptions, GetLocationInsightsResponse, MonthlyRange, ListSearchKeywordImpressionsOptions, ListSearchKeywordImpressionsResponse, ListSearchKeywordImpressionsApplicationErrors, InviteAdminToLocationOptions, InviteAdminToLocationResponse, GetLocationAdminsResponse, GetAddressSchemaByCountryCodeOptions, GetAddressSchemaByCountryCodeResponse, GetAddressSchemaByCountryCodeApplicationErrors, SuggestRegionsOptions, SuggestRegionsResponse, SuggestRegionsApplicationErrors, SuggestEstablishmentsOptions, SuggestEstablishmentsResponse, SuggestEstablishmentsApplicationErrors, SearchGoogleLocationsOptions, SearchGoogleLocationsResponse, SearchGoogleLocationsApplicationErrors, LocationsQueryBuilder, GBPLocationQuery, typedQueryGbpLocations } from './index.typings.js';
|
|
3
|
-
export { Accessibility, AccountInfo, ActionEvent, Activities, AddressFieldType, AddressFieldTypeWithLiterals, AddressSchema, AddressVerificationData, AmenityException, AmenityExceptionWithLiterals, ApplicationError, AttributeMetadata, AttributeValueMetadata, AttributeValueMetadataValueOneOf, AttributeValueType, AttributeValueTypeWithLiterals, BreeamCertification, BreeamCertificationWithLiterals, BulkActionMetadata, BulkCreateLocationResult, BulkCreateLocationsRequest, BulkDeleteLocationResult, BulkDeleteLocationsRequest, Business, BusinessHours, BusinessType, BusinessTypeWithLiterals, CalendarMonth, Category, CategoryMetadata, CategoryRegion, CategoryView, CategoryViewWithLiterals, CommonQueryWithEntityContext, CompleteVerificationRequest, Connectivity, CreateGoogleLocationRequest, CreateLocationRequest, CreateLocationResponse, CreateMediaRequest, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DailyMetric, DailyMetricValue, DailyMetricWithLiterals, DayOfWeek, DayOfWeekWithLiterals, DeleteGoogleLocationRequest, DeleteGoogleLocationResponse, DeleteLocationRequest, DeleteLocationResponse, DeleteMediaRequest, DeleteMediaResponse, DeleteReviewReplyRequest, DeleteReviewReplyResponse, DomainEvent, DomainEventBodyOneOf, EcoCertificate, EcoCertificateWithLiterals, EcoCertification, EmailVerificationData, Empty, EnergyEfficiency, EnhancedCleaning, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EstablishmentSuggestion, Families, FieldViolation, FoodAndDrink, FoodMenuResult, GBPLocationQuerySpec, GbpAccount, GetAddressSchemaByCountryCodeRequest, GetGBPLocationRequest, GetGBPLocationResponse, GetGoogleLocationRequest, GetLocationAdminsRequest, GetLocationAttributesRequest, GetLocationInsightsRequest, GetLocationLodgingRequest, GetNotificationSettingRequest, GetVerificationOptionsRequest, GetVoiceOfMerchantRequest, GoogleApiCallFailedError, GoogleLocationMatch, GoogleLocationValidationError, GuestUnitFeatures, GuestUnitType, HealthAndSafety, Housekeeping, IdentificationData, IdentificationDataIdOneOf, IncreasedFoodSafety, InsightsMetric, InvalidUpdateMaskError, InvalidValueJsonError, InviteAdminToLocationRequest, ItemMetadata, LanguageSpoken, LatLng, LeedCertification, LeedCertificationWithLiterals, ListAttributeMetadataOptionsLookupOneOf, ListAttributeMetadataRequest, ListAttributeMetadataRequestLookupOneOf, ListCategoriesRequest, ListGbpAccountsRequest, ListMediaRequest, ListReviewsRequest, ListSearchKeywordImpressionsRequest, ListUnimportedLocationsRequest, LivingArea, LivingAreaAccessibility, LivingAreaEating, LivingAreaFeatures, LivingAreaLayout, LivingAreaSleeping, LocationAdmin, LocationDbPersistFailedError, LocationNotDeletableViaApiError, LocationWithGoogle, LocationWithGoogleGoogleResultOneOf, LocationWithGoogleVoiceOfMerchantResultOneOf, LocationsQueryResult, LodgingMetadata, LodgingTimeOfDay, MatchStatus, MatchStatusWithLiterals, MediaCategory, MediaCategoryWithLiterals, MediaFormat, MediaFormatWithLiterals, MediaItem, MediaItemAttribution, MessageEnvelope, Metadata, MinimizedContact, MoreHoursType, NotificationSetting, NotificationType, NotificationTypeWithLiterals, OfflineVideoVerificationData, OpenInfo, Parking, PaymentOptions, PersonalProtection, Pets, PhysicalDistancing, PlaceInfo, Policies, Pools, PostalAddress, Profile, Property, PutReviewReplyRequest, QueryGBPLocationsRequest, QueryGBPLocationsResponse, QueryGoogleLocationsRequest, RecommendationReason, RecommendationReasonWithLiterals, RegionSuggestion, RestoreInfo, Review, ReviewMetrics, ReviewReply, ReviewSortOrder, ReviewSortOrderWithLiterals, Role, RoleWithLiterals, SearchGoogleLocationsOptionsCriteriaOneOf, SearchGoogleLocationsRequest, SearchGoogleLocationsRequestCriteriaOneOf, SearchKeywordImpression, SearchKeywordImpressionImpressionsOneOf, ServiceArea, ServiceType, Services, SortOrder, SortOrderWithLiterals, Sorting, StartVerificationRequest, State, StateWithLiterals, Status, StatusWithLiterals, SuggestEstablishmentsRequest, SuggestRegionsRequest, Sustainability, SustainabilityCertifications, SustainableSourcing, TimeOfDay, Transportation, UnimportedLocation, UnitTier, UnitTierWithLiterals, UpdateGoogleLocationRequest, UpdateLocationAttributesRequest, UpdateLocationFoodMenusApplicationErrors, UpdateLocationFoodMenusOptions, UpdateLocationFoodMenusRequest, UpdateLocationFoodMenusResponse, UpdateLocationLodgingRequest, UpdateLocationRequest, UpdateLocationResponse, UpdateNotificationSettingRequest, VerificationMethod, VerificationOption, VerificationOptionDataOneOf, VerificationState, VerificationStateWithLiterals, ViewsFromUnit, Violation, VoiceOfMerchantState, WasteReduction, WaterConservation, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Wellness, utils } from './index.typings.js';
|
|
2
|
+
import { GBPLocation, QueryGoogleLocationsOptions, QueryGoogleLocationsResponse, GetGoogleLocationResponse, CreateLocationApplicationErrors, UpdateLocation, CreateGoogleLocationOptions, CreateGoogleLocationResponse, CreateGoogleLocationApplicationErrors, DeleteGoogleLocationApplicationErrors, GoogleLocation, UpdateGoogleLocationOptions, UpdateGoogleLocationResponse, UpdateGoogleLocationApplicationErrors, BulkCreateLocationsOptions, BulkCreateLocationsResponse, BulkCreateLocationsApplicationErrors, BulkDeleteLocationsResponse, ListGbpAccountsOptions, ListGbpAccountsResponse, ListGbpAccountsApplicationErrors, ListUnimportedLocationsOptions, ListUnimportedLocationsResponse, ListUnimportedLocationsApplicationErrors, GetNotificationSettingResponse, GetNotificationSettingApplicationErrors, UpdateNotificationSetting, UpdateNotificationSettingOptions, UpdateNotificationSettingResponse, UpdateNotificationSettingApplicationErrors, ListReviewsOptions, ListReviewsResponse, ListReviewsApplicationErrors, PutReviewReplyIdentifiers, PutReviewReplyResponse, PutReviewReplyApplicationErrors, DeleteReviewReplyIdentifiers, DeleteReviewReplyApplicationErrors, ListMediaOptions, ListMediaResponse, ListMediaApplicationErrors, CreateMediaOptions, CreateMediaResponse, CreateMediaApplicationErrors, DeleteMediaIdentifiers, DeleteMediaApplicationErrors, LocalPost, CreateLocalPostResponse, CreateLocalPostApplicationErrors, ListLocalPostsOptions, ListLocalPostsResponse, ListLocalPostsApplicationErrors, GetLocalPostIdentifiers, GetLocalPostResponse, GetLocalPostApplicationErrors, UpdateLocalPostIdentifiers, UpdateLocalPostOptions, UpdateLocalPostResponse, UpdateLocalPostApplicationErrors, DeleteLocalPostIdentifiers, DeleteLocalPostApplicationErrors, ReportLocalPostInsightsOptions, ReportLocalPostInsightsResponse, ReportLocalPostInsightsApplicationErrors, LocationAttribute, UpdateLocationAttributesResponse, UpdateLocationAttributesApplicationErrors, GetLocationAttributesResponse, GetLocationAttributesApplicationErrors, GetLocationLodgingResponse, GetLocationLodgingApplicationErrors, Lodging, UpdateLocationLodgingOptions, UpdateLocationLodgingResponse, UpdateLocationLodgingApplicationErrors, ListAttributeMetadataOptions, ListAttributeMetadataResponse, ListAttributeMetadataApplicationErrors, ListCategoriesOptions, ListCategoriesResponse, ListCategoriesApplicationErrors, GetVerificationOptions, GetVerificationOptionsResponse, GetVerificationOptionsApplicationErrors, VerificationMethodWithLiterals, StartVerificationOptions, StartVerificationResponse, StartVerificationApplicationErrors, CompleteVerificationOptions, CompleteVerificationResponse, CompleteVerificationApplicationErrors, GetVoiceOfMerchantResponse, InsightsTimeRange, GetLocationInsightsOptions, GetLocationInsightsResponse, MonthlyRange, ListSearchKeywordImpressionsOptions, ListSearchKeywordImpressionsResponse, ListSearchKeywordImpressionsApplicationErrors, InviteAdminToLocationOptions, InviteAdminToLocationResponse, GetLocationAdminsResponse, GetAddressSchemaByCountryCodeOptions, GetAddressSchemaByCountryCodeResponse, GetAddressSchemaByCountryCodeApplicationErrors, SuggestRegionsOptions, SuggestRegionsResponse, SuggestRegionsApplicationErrors, SuggestEstablishmentsOptions, SuggestEstablishmentsResponse, SuggestEstablishmentsApplicationErrors, SearchGoogleLocationsOptions, SearchGoogleLocationsResponse, SearchGoogleLocationsApplicationErrors, LocationsQueryBuilder, GBPLocationQuery, typedQueryGbpLocations } from './index.typings.js';
|
|
3
|
+
export { Accessibility, AccountInfo, ActionEvent, ActionType, ActionTypeWithLiterals, Activities, AddressFieldType, AddressFieldTypeWithLiterals, AddressSchema, AddressVerificationData, AmenityException, AmenityExceptionWithLiterals, ApplicationError, AttributeMetadata, AttributeValueMetadata, AttributeValueMetadataValueOneOf, AttributeValueType, AttributeValueTypeWithLiterals, BreeamCertification, BreeamCertificationWithLiterals, BulkActionMetadata, BulkCreateLocationResult, BulkCreateLocationsRequest, BulkDeleteLocationResult, BulkDeleteLocationsRequest, Business, BusinessHours, BusinessType, BusinessTypeWithLiterals, CalendarMonth, CallToAction, Category, CategoryMetadata, CategoryRegion, CategoryView, CategoryViewWithLiterals, CommonQueryWithEntityContext, CompleteVerificationRequest, Connectivity, CreateGoogleLocationRequest, CreateLocalPostRequest, CreateLocationRequest, CreateLocationResponse, CreateMediaRequest, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DailyMetric, DailyMetricValue, DailyMetricWithLiterals, DayOfWeek, DayOfWeekWithLiterals, DeleteGoogleLocationRequest, DeleteGoogleLocationResponse, DeleteLocalPostRequest, DeleteLocalPostResponse, DeleteLocationRequest, DeleteLocationResponse, DeleteMediaRequest, DeleteMediaResponse, DeleteReviewReplyRequest, DeleteReviewReplyResponse, DomainEvent, DomainEventBodyOneOf, EcoCertificate, EcoCertificateWithLiterals, EcoCertification, EmailVerificationData, Empty, EnergyEfficiency, EnhancedCleaning, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EstablishmentSuggestion, Families, FieldViolation, FoodAndDrink, FoodMenuResult, GBPLocationQuerySpec, GbpAccount, GetAddressSchemaByCountryCodeRequest, GetGBPLocationRequest, GetGBPLocationResponse, GetGoogleLocationRequest, GetLocalPostRequest, GetLocationAdminsRequest, GetLocationAttributesRequest, GetLocationInsightsRequest, GetLocationLodgingRequest, GetNotificationSettingRequest, GetVerificationOptionsRequest, GetVoiceOfMerchantRequest, GoogleApiCallFailedError, GoogleLocationMatch, GoogleLocationValidationError, GuestUnitFeatures, GuestUnitType, HealthAndSafety, Housekeeping, IdentificationData, IdentificationDataIdOneOf, IncreasedFoodSafety, InsightsMetric, InvalidUpdateMaskError, InvalidValueJsonError, InviteAdminToLocationRequest, ItemMetadata, LanguageSpoken, LatLng, LeedCertification, LeedCertificationWithLiterals, ListAttributeMetadataOptionsLookupOneOf, ListAttributeMetadataRequest, ListAttributeMetadataRequestLookupOneOf, ListCategoriesRequest, ListGbpAccountsRequest, ListLocalPostsRequest, ListMediaRequest, ListReviewsRequest, ListSearchKeywordImpressionsRequest, ListUnimportedLocationsRequest, LivingArea, LivingAreaAccessibility, LivingAreaEating, LivingAreaFeatures, LivingAreaLayout, LivingAreaSleeping, LocalPostDate, LocalPostEvent, LocalPostFieldError, LocalPostInsights, LocalPostMedia, LocalPostMetric, LocalPostMetricValue, LocalPostMetricWithLiterals, LocalPostOffer, LocalPostSchedule, LocalPostState, LocalPostStateWithLiterals, LocalPostTimeOfDay, LocalPostTopicType, LocalPostTopicTypeWithLiterals, LocationAdmin, LocationDbPersistFailedError, LocationNotDeletableViaApiError, LocationWithGoogle, LocationWithGoogleGoogleResultOneOf, LocationWithGoogleVoiceOfMerchantResultOneOf, LocationsQueryResult, LodgingMetadata, LodgingTimeOfDay, MatchStatus, MatchStatusWithLiterals, MediaCategory, MediaCategoryWithLiterals, MediaFormat, MediaFormatWithLiterals, MediaItem, MediaItemAttribution, MessageEnvelope, Metadata, MinimizedContact, MoreHoursType, NotificationSetting, NotificationType, NotificationTypeWithLiterals, OfflineVideoVerificationData, OpenInfo, Parking, PaymentOptions, PersonalProtection, Pets, PhysicalDistancing, PlaceInfo, Policies, Pools, PostalAddress, Profile, Property, PutReviewReplyRequest, QueryGBPLocationsRequest, QueryGBPLocationsResponse, QueryGoogleLocationsRequest, RecommendationReason, RecommendationReasonWithLiterals, RegionSuggestion, ReportLocalPostInsightsRequest, RestoreInfo, Review, ReviewMetrics, ReviewReply, ReviewSortOrder, ReviewSortOrderWithLiterals, Role, RoleWithLiterals, SearchGoogleLocationsOptionsCriteriaOneOf, SearchGoogleLocationsRequest, SearchGoogleLocationsRequestCriteriaOneOf, SearchKeywordImpression, SearchKeywordImpressionImpressionsOneOf, ServiceArea, ServiceType, Services, SortOrder, SortOrderWithLiterals, Sorting, StartVerificationRequest, State, StateWithLiterals, Status, StatusWithLiterals, SuggestEstablishmentsRequest, SuggestRegionsRequest, Sustainability, SustainabilityCertifications, SustainableSourcing, TimeOfDay, Transportation, UnimportedLocation, UnitTier, UnitTierWithLiterals, UpdateGoogleLocationRequest, UpdateLocalPostRequest, UpdateLocationAttributesRequest, UpdateLocationFoodMenusApplicationErrors, UpdateLocationFoodMenusOptions, UpdateLocationFoodMenusRequest, UpdateLocationFoodMenusResponse, UpdateLocationLodgingRequest, UpdateLocationRequest, UpdateLocationResponse, UpdateNotificationSettingRequest, VerificationMethod, VerificationOption, VerificationOptionDataOneOf, VerificationState, VerificationStateWithLiterals, ViewsFromUnit, Violation, VoiceOfMerchantState, WasteReduction, WaterConservation, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Wellness, utils } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function getGbpLocation$1(httpClient: HttpClient): GetGbpLocationSignature;
|
|
6
6
|
interface GetGbpLocationSignature {
|
|
@@ -506,6 +506,156 @@ interface DeleteMediaSignature {
|
|
|
506
506
|
__applicationErrorsType?: DeleteMediaApplicationErrors;
|
|
507
507
|
}>;
|
|
508
508
|
}
|
|
509
|
+
declare function createLocalPost$1(httpClient: HttpClient): CreateLocalPostSignature;
|
|
510
|
+
interface CreateLocalPostSignature {
|
|
511
|
+
/**
|
|
512
|
+
* Creates a post on a location's Business Profile.
|
|
513
|
+
*
|
|
514
|
+
* Set `topicType` to choose the kind of post:
|
|
515
|
+
*
|
|
516
|
+
* - `STANDARD`: an update with `summary` and an optional photo in `media`.
|
|
517
|
+
* Don't set `event` or `offer`.
|
|
518
|
+
* - `EVENT`: an event. Requires `event.title` and `event.schedule`.
|
|
519
|
+
* - `OFFER`: a promotion. Requires `event.title` and `event.schedule`, and
|
|
520
|
+
* accepts coupon details in `offer`.
|
|
521
|
+
*
|
|
522
|
+
* Add a button with `callToAction`. Every `actionType` except `CALL` needs a
|
|
523
|
+
* `url`. `CALL` dials the phone number on the Business Profile and doesn't
|
|
524
|
+
* accept one.
|
|
525
|
+
*
|
|
526
|
+
* Google reviews every new post before showing it, so the returned post is
|
|
527
|
+
* usually in the `PROCESSING` state. Call Get Local Post later to see whether
|
|
528
|
+
* it became `LIVE` or `REJECTED`. A rejected post isn't an error: it comes
|
|
529
|
+
* back with `state` set to `REJECTED`.
|
|
530
|
+
*
|
|
531
|
+
* Google doesn't deduplicate posts. Calling this twice creates two posts.
|
|
532
|
+
*
|
|
533
|
+
* Errors:
|
|
534
|
+
* - `LOCAL_POST_INVALID_FOR_TOPIC`: a field doesn't fit `topicType`, for
|
|
535
|
+
* example an `EVENT` post without `event.schedule`. The field is named in
|
|
536
|
+
* the error payload. Google isn't called.
|
|
537
|
+
* - `INVALID_LOCAL_POST_REQUEST`: a field is invalid regardless of the topic,
|
|
538
|
+
* for example a `callToAction` without a `url`. Google isn't called.
|
|
539
|
+
* - `GOOGLE_LOCATION_VALIDATION_FAILED`: Google rejected the post and said
|
|
540
|
+
* why. The reasons are in the error payload.
|
|
541
|
+
* - `GOOGLE_API_CALL_FAILED`: the call to Google failed for any other reason.
|
|
542
|
+
* Google's status and response are in the error payload.
|
|
543
|
+
* @param - Location ID. This is Google's location identifier.
|
|
544
|
+
* @param - The post to create.
|
|
545
|
+
*/
|
|
546
|
+
(locationId: string, localPost: NonNullablePaths<LocalPost, `topicType`, 0>): Promise<NonNullablePaths<CreateLocalPostResponse, `localPost.localPostId` | `localPost.topicType` | `localPost.summary` | `localPost.callToAction.actionType` | `localPost.event.title` | `localPost.event.schedule.startDate.year` | `localPost.event.schedule.startDate.month` | `localPost.event.schedule.startDate.day` | `localPost.event.schedule.startTime.hours` | `localPost.event.schedule.startTime.minutes` | `localPost.offer.couponCode` | `localPost.offer.termsConditions` | `localPost.media` | `localPost.media.${number}.sourceUrl` | `localPost.state`, 4> & {
|
|
547
|
+
__applicationErrorsType?: CreateLocalPostApplicationErrors;
|
|
548
|
+
}>;
|
|
549
|
+
}
|
|
550
|
+
declare function listLocalPosts$1(httpClient: HttpClient): ListLocalPostsSignature;
|
|
551
|
+
interface ListLocalPostsSignature {
|
|
552
|
+
/**
|
|
553
|
+
* Retrieves a list of up to 100 posts on a location's Business Profile.
|
|
554
|
+
*
|
|
555
|
+
* Each post includes its current `state`, so this is also how to follow up on
|
|
556
|
+
* posts that were `PROCESSING` when created.
|
|
557
|
+
*
|
|
558
|
+
* Don't rely on the order of the results. Page through with `paging.cursor`.
|
|
559
|
+
*
|
|
560
|
+
* Errors:
|
|
561
|
+
* - `GOOGLE_API_CALL_FAILED`: the call to Google failed. Google's status is in
|
|
562
|
+
* the error payload.
|
|
563
|
+
* @param - Location ID. This is Google's location identifier.
|
|
564
|
+
*/
|
|
565
|
+
(locationId: string, options?: ListLocalPostsOptions): Promise<NonNullablePaths<ListLocalPostsResponse, `localPosts` | `localPosts.${number}.localPostId` | `localPosts.${number}.topicType` | `localPosts.${number}.summary` | `localPosts.${number}.callToAction.actionType` | `localPosts.${number}.event.title` | `localPosts.${number}.offer.couponCode` | `localPosts.${number}.offer.termsConditions` | `localPosts.${number}.state`, 3> & {
|
|
566
|
+
__applicationErrorsType?: ListLocalPostsApplicationErrors;
|
|
567
|
+
}>;
|
|
568
|
+
}
|
|
569
|
+
declare function getLocalPost$1(httpClient: HttpClient): GetLocalPostSignature;
|
|
570
|
+
interface GetLocalPostSignature {
|
|
571
|
+
/**
|
|
572
|
+
* Retrieves a post from a location's Business Profile.
|
|
573
|
+
*
|
|
574
|
+
* Use it after Create Local Post or Update Local Post to see whether Google
|
|
575
|
+
* approved the change: `state` moves from `PROCESSING` to `LIVE` or
|
|
576
|
+
* `REJECTED`.
|
|
577
|
+
*
|
|
578
|
+
* Errors:
|
|
579
|
+
* - `LOCAL_POST_NOT_FOUND`: the post doesn't exist on the location.
|
|
580
|
+
* - `GOOGLE_API_CALL_FAILED`: the call to Google failed. Google's status is in
|
|
581
|
+
* the error payload.
|
|
582
|
+
*/
|
|
583
|
+
(identifiers: NonNullablePaths<GetLocalPostIdentifiers, `localPostId` | `locationId`, 0>): Promise<NonNullablePaths<GetLocalPostResponse, `localPost.localPostId` | `localPost.topicType` | `localPost.summary` | `localPost.callToAction.actionType` | `localPost.event.title` | `localPost.event.schedule.startDate.year` | `localPost.event.schedule.startDate.month` | `localPost.event.schedule.startDate.day` | `localPost.event.schedule.startTime.hours` | `localPost.event.schedule.startTime.minutes` | `localPost.offer.couponCode` | `localPost.offer.termsConditions` | `localPost.media` | `localPost.media.${number}.sourceUrl` | `localPost.state`, 4> & {
|
|
584
|
+
__applicationErrorsType?: GetLocalPostApplicationErrors;
|
|
585
|
+
}>;
|
|
586
|
+
}
|
|
587
|
+
declare function updateLocalPost$1(httpClient: HttpClient): UpdateLocalPostSignature;
|
|
588
|
+
interface UpdateLocalPostSignature {
|
|
589
|
+
/**
|
|
590
|
+
* Updates a post on a location's Business Profile.
|
|
591
|
+
*
|
|
592
|
+
* Name the fields to change in `fieldMask`. Only these paths are accepted:
|
|
593
|
+
* `summary`, `callToAction`, `event`, `offer`, `media`, `languageCode`. Each
|
|
594
|
+
* one replaces that whole part of the post, so send the complete value you
|
|
595
|
+
* want. `topicType` can't be changed: create a new post instead.
|
|
596
|
+
*
|
|
597
|
+
* Google reviews the edited post again, so the returned post is usually back
|
|
598
|
+
* in the `PROCESSING` state. Call Get Local Post later to see the outcome.
|
|
599
|
+
*
|
|
600
|
+
* Errors:
|
|
601
|
+
* - `INVALID_UPDATE_MASK`: the mask is empty or names a path that can't be
|
|
602
|
+
* updated. Google isn't called.
|
|
603
|
+
* - `INVALID_LOCAL_POST_REQUEST`: a masked field is invalid, for example a
|
|
604
|
+
* `callToAction` without a `url`. Google isn't called.
|
|
605
|
+
* - `LOCAL_POST_NOT_FOUND`: the post doesn't exist on the location.
|
|
606
|
+
* - `GOOGLE_LOCATION_VALIDATION_FAILED`: Google rejected the change and said
|
|
607
|
+
* why, for example a field that doesn't fit the post's `topicType`. The
|
|
608
|
+
* reasons are in the error payload.
|
|
609
|
+
* - `GOOGLE_API_CALL_FAILED`: the call to Google failed for any other reason.
|
|
610
|
+
* Google's status and response are in the error payload.
|
|
611
|
+
* @param - The values to set. Only the fields named in `fieldMask` are sent to Google,
|
|
612
|
+
* so this can be partial.
|
|
613
|
+
*/
|
|
614
|
+
(identifiers: NonNullablePaths<UpdateLocalPostIdentifiers, `localPostId` | `locationId`, 0>, localPost: LocalPost, options: NonNullablePaths<UpdateLocalPostOptions, `fieldMask`, 0>): Promise<NonNullablePaths<UpdateLocalPostResponse, `localPost.localPostId` | `localPost.topicType` | `localPost.summary` | `localPost.callToAction.actionType` | `localPost.event.title` | `localPost.event.schedule.startDate.year` | `localPost.event.schedule.startDate.month` | `localPost.event.schedule.startDate.day` | `localPost.event.schedule.startTime.hours` | `localPost.event.schedule.startTime.minutes` | `localPost.offer.couponCode` | `localPost.offer.termsConditions` | `localPost.media` | `localPost.media.${number}.sourceUrl` | `localPost.state`, 4> & {
|
|
615
|
+
__applicationErrorsType?: UpdateLocalPostApplicationErrors;
|
|
616
|
+
}>;
|
|
617
|
+
}
|
|
618
|
+
declare function deleteLocalPost$1(httpClient: HttpClient): DeleteLocalPostSignature;
|
|
619
|
+
interface DeleteLocalPostSignature {
|
|
620
|
+
/**
|
|
621
|
+
* Deletes a post from a location's Business Profile.
|
|
622
|
+
*
|
|
623
|
+
* The post is removed from Google Search and Maps, and can't be restored.
|
|
624
|
+
*
|
|
625
|
+
* Errors:
|
|
626
|
+
* - `LOCAL_POST_NOT_FOUND`: the post doesn't exist on the location, for
|
|
627
|
+
* example because it was already deleted.
|
|
628
|
+
* - `GOOGLE_API_CALL_FAILED`: the call to Google failed for any other reason.
|
|
629
|
+
* Google's status and response are in the error payload.
|
|
630
|
+
*/
|
|
631
|
+
(identifiers: NonNullablePaths<DeleteLocalPostIdentifiers, `localPostId` | `locationId`, 0>): Promise<void & {
|
|
632
|
+
__applicationErrorsType?: DeleteLocalPostApplicationErrors;
|
|
633
|
+
}>;
|
|
634
|
+
}
|
|
635
|
+
declare function reportLocalPostInsights$1(httpClient: HttpClient): ReportLocalPostInsightsSignature;
|
|
636
|
+
interface ReportLocalPostInsightsSignature {
|
|
637
|
+
/**
|
|
638
|
+
* Retrieves metric totals for up to 100 posts on a location.
|
|
639
|
+
*
|
|
640
|
+
* Specify the posts in `localPostIds`, the metrics in `metrics`, and the
|
|
641
|
+
* window in `timeRange`. The window can start at most 18 months before
|
|
642
|
+
* today, and not later than today. Each post comes back with one total per requested metric.
|
|
643
|
+
*
|
|
644
|
+
* Google can report data late, so totals for the last few days may still
|
|
645
|
+
* grow.
|
|
646
|
+
*
|
|
647
|
+
* Errors:
|
|
648
|
+
* - `INVALID_LOCAL_POST_REQUEST`: `timeRange` ends before it starts, starts in
|
|
649
|
+
* the future, or starts more than 18 months ago. Google isn't called.
|
|
650
|
+
* - `GOOGLE_API_CALL_FAILED`: the call to Google failed. Google's status is in
|
|
651
|
+
* the error payload.
|
|
652
|
+
* @param - Location ID. This is Google's location identifier.
|
|
653
|
+
* @param - IDs of the posts to report on. Every post must belong to the location.
|
|
654
|
+
*/
|
|
655
|
+
(locationId: string, localPostIds: string[], options: NonNullablePaths<ReportLocalPostInsightsOptions, `metrics` | `timeRange`, 0>): Promise<NonNullablePaths<ReportLocalPostInsightsResponse, `localPostInsights` | `localPostInsights.${number}.localPostId` | `timeZone`, 2> & {
|
|
656
|
+
__applicationErrorsType?: ReportLocalPostInsightsApplicationErrors;
|
|
657
|
+
}>;
|
|
658
|
+
}
|
|
509
659
|
declare function updateLocationAttributes$1(httpClient: HttpClient): UpdateLocationAttributesSignature;
|
|
510
660
|
interface UpdateLocationAttributesSignature {
|
|
511
661
|
/**
|
|
@@ -952,6 +1102,12 @@ declare const deleteReviewReply: MaybeContext<BuildRESTFunction<typeof deleteRev
|
|
|
952
1102
|
declare const listMedia: MaybeContext<BuildRESTFunction<typeof listMedia$1> & typeof listMedia$1>;
|
|
953
1103
|
declare const createMedia: MaybeContext<BuildRESTFunction<typeof createMedia$1> & typeof createMedia$1>;
|
|
954
1104
|
declare const deleteMedia: MaybeContext<BuildRESTFunction<typeof deleteMedia$1> & typeof deleteMedia$1>;
|
|
1105
|
+
declare const createLocalPost: MaybeContext<BuildRESTFunction<typeof createLocalPost$1> & typeof createLocalPost$1>;
|
|
1106
|
+
declare const listLocalPosts: MaybeContext<BuildRESTFunction<typeof listLocalPosts$1> & typeof listLocalPosts$1>;
|
|
1107
|
+
declare const getLocalPost: MaybeContext<BuildRESTFunction<typeof getLocalPost$1> & typeof getLocalPost$1>;
|
|
1108
|
+
declare const updateLocalPost: MaybeContext<BuildRESTFunction<typeof updateLocalPost$1> & typeof updateLocalPost$1>;
|
|
1109
|
+
declare const deleteLocalPost: MaybeContext<BuildRESTFunction<typeof deleteLocalPost$1> & typeof deleteLocalPost$1>;
|
|
1110
|
+
declare const reportLocalPostInsights: MaybeContext<BuildRESTFunction<typeof reportLocalPostInsights$1> & typeof reportLocalPostInsights$1>;
|
|
955
1111
|
declare const updateLocationAttributes: MaybeContext<BuildRESTFunction<typeof updateLocationAttributes$1> & typeof updateLocationAttributes$1>;
|
|
956
1112
|
declare const getLocationAttributes: MaybeContext<BuildRESTFunction<typeof getLocationAttributes$1> & typeof getLocationAttributes$1>;
|
|
957
1113
|
declare const getLocationLodging: MaybeContext<BuildRESTFunction<typeof getLocationLodging$1> & typeof getLocationLodging$1>;
|
|
@@ -972,4 +1128,4 @@ declare const suggestEstablishments: MaybeContext<BuildRESTFunction<typeof sugge
|
|
|
972
1128
|
declare const searchGoogleLocations: MaybeContext<BuildRESTFunction<typeof searchGoogleLocations$1> & typeof searchGoogleLocations$1>;
|
|
973
1129
|
declare const queryGbpLocations: MaybeContext<BuildRESTFunction<typeof customQueryGbpLocations> & typeof customQueryGbpLocations>;
|
|
974
1130
|
|
|
975
|
-
export { BulkCreateLocationsApplicationErrors, BulkCreateLocationsOptions, BulkCreateLocationsResponse, BulkDeleteLocationsResponse, CompleteVerificationApplicationErrors, CompleteVerificationOptions, CompleteVerificationResponse, CreateGoogleLocationApplicationErrors, CreateGoogleLocationOptions, CreateGoogleLocationResponse, CreateLocationApplicationErrors, CreateMediaApplicationErrors, CreateMediaOptions, CreateMediaResponse, DeleteGoogleLocationApplicationErrors, DeleteMediaApplicationErrors, DeleteMediaIdentifiers, DeleteReviewReplyApplicationErrors, DeleteReviewReplyIdentifiers, GBPLocation, GBPLocationQuery, GetAddressSchemaByCountryCodeApplicationErrors, GetAddressSchemaByCountryCodeOptions, GetAddressSchemaByCountryCodeResponse, GetGoogleLocationResponse, GetLocationAdminsResponse, GetLocationAttributesApplicationErrors, GetLocationAttributesResponse, GetLocationInsightsOptions, GetLocationInsightsResponse, GetLocationLodgingApplicationErrors, GetLocationLodgingResponse, GetNotificationSettingApplicationErrors, GetNotificationSettingResponse, GetVerificationOptions, GetVerificationOptionsApplicationErrors, GetVerificationOptionsResponse, GetVoiceOfMerchantResponse, GoogleLocation, InsightsTimeRange, InviteAdminToLocationOptions, InviteAdminToLocationResponse, ListAttributeMetadataApplicationErrors, ListAttributeMetadataOptions, ListAttributeMetadataResponse, ListCategoriesApplicationErrors, ListCategoriesOptions, ListCategoriesResponse, ListGbpAccountsApplicationErrors, ListGbpAccountsOptions, ListGbpAccountsResponse, ListMediaApplicationErrors, ListMediaOptions, ListMediaResponse, ListReviewsApplicationErrors, ListReviewsOptions, ListReviewsResponse, ListSearchKeywordImpressionsApplicationErrors, ListSearchKeywordImpressionsOptions, ListSearchKeywordImpressionsResponse, ListUnimportedLocationsApplicationErrors, ListUnimportedLocationsOptions, ListUnimportedLocationsResponse, LocationAttribute, LocationsQueryBuilder, Lodging, MonthlyRange, PutReviewReplyApplicationErrors, PutReviewReplyIdentifiers, PutReviewReplyResponse, QueryGoogleLocationsOptions, QueryGoogleLocationsResponse, SearchGoogleLocationsApplicationErrors, SearchGoogleLocationsOptions, SearchGoogleLocationsResponse, StartVerificationApplicationErrors, StartVerificationOptions, StartVerificationResponse, SuggestEstablishmentsApplicationErrors, SuggestEstablishmentsOptions, SuggestEstablishmentsResponse, SuggestRegionsApplicationErrors, SuggestRegionsOptions, SuggestRegionsResponse, UpdateGoogleLocationApplicationErrors, UpdateGoogleLocationOptions, UpdateGoogleLocationResponse, UpdateLocation, UpdateLocationAttributesApplicationErrors, UpdateLocationAttributesResponse, UpdateLocationLodgingApplicationErrors, UpdateLocationLodgingOptions, UpdateLocationLodgingResponse, UpdateNotificationSetting, UpdateNotificationSettingApplicationErrors, UpdateNotificationSettingOptions, UpdateNotificationSettingResponse, VerificationMethodWithLiterals, bulkCreateLocations, bulkDeleteLocations, completeVerification, createGoogleLocation, createLocation, createMedia, deleteGoogleLocation, deleteLocation, deleteMedia, deleteReviewReply, getAddressSchemaByCountryCode, getGbpLocation, getGoogleLocation, getLocationAdmins, getLocationAttributes, getLocationInsights, getLocationLodging, getNotificationSetting, getVerificationOptions, getVoiceOfMerchant, inviteAdminToLocation, listAttributeMetadata, listCategories, listGbpAccounts, listMedia, listReviews, listSearchKeywordImpressions, listUnimportedLocations, putReviewReply, queryGbpLocations, queryGoogleLocations, searchGoogleLocations, startVerification, suggestEstablishments, suggestRegions, updateGoogleLocation, updateLocation, updateLocationAttributes, updateLocationLodging, updateNotificationSetting };
|
|
1131
|
+
export { BulkCreateLocationsApplicationErrors, BulkCreateLocationsOptions, BulkCreateLocationsResponse, BulkDeleteLocationsResponse, CompleteVerificationApplicationErrors, CompleteVerificationOptions, CompleteVerificationResponse, CreateGoogleLocationApplicationErrors, CreateGoogleLocationOptions, CreateGoogleLocationResponse, CreateLocalPostApplicationErrors, CreateLocalPostResponse, CreateLocationApplicationErrors, CreateMediaApplicationErrors, CreateMediaOptions, CreateMediaResponse, DeleteGoogleLocationApplicationErrors, DeleteLocalPostApplicationErrors, DeleteLocalPostIdentifiers, DeleteMediaApplicationErrors, DeleteMediaIdentifiers, DeleteReviewReplyApplicationErrors, DeleteReviewReplyIdentifiers, GBPLocation, GBPLocationQuery, GetAddressSchemaByCountryCodeApplicationErrors, GetAddressSchemaByCountryCodeOptions, GetAddressSchemaByCountryCodeResponse, GetGoogleLocationResponse, GetLocalPostApplicationErrors, GetLocalPostIdentifiers, GetLocalPostResponse, GetLocationAdminsResponse, GetLocationAttributesApplicationErrors, GetLocationAttributesResponse, GetLocationInsightsOptions, GetLocationInsightsResponse, GetLocationLodgingApplicationErrors, GetLocationLodgingResponse, GetNotificationSettingApplicationErrors, GetNotificationSettingResponse, GetVerificationOptions, GetVerificationOptionsApplicationErrors, GetVerificationOptionsResponse, GetVoiceOfMerchantResponse, GoogleLocation, InsightsTimeRange, InviteAdminToLocationOptions, InviteAdminToLocationResponse, ListAttributeMetadataApplicationErrors, ListAttributeMetadataOptions, ListAttributeMetadataResponse, ListCategoriesApplicationErrors, ListCategoriesOptions, ListCategoriesResponse, ListGbpAccountsApplicationErrors, ListGbpAccountsOptions, ListGbpAccountsResponse, ListLocalPostsApplicationErrors, ListLocalPostsOptions, ListLocalPostsResponse, ListMediaApplicationErrors, ListMediaOptions, ListMediaResponse, ListReviewsApplicationErrors, ListReviewsOptions, ListReviewsResponse, ListSearchKeywordImpressionsApplicationErrors, ListSearchKeywordImpressionsOptions, ListSearchKeywordImpressionsResponse, ListUnimportedLocationsApplicationErrors, ListUnimportedLocationsOptions, ListUnimportedLocationsResponse, LocalPost, LocationAttribute, LocationsQueryBuilder, Lodging, MonthlyRange, PutReviewReplyApplicationErrors, PutReviewReplyIdentifiers, PutReviewReplyResponse, QueryGoogleLocationsOptions, QueryGoogleLocationsResponse, ReportLocalPostInsightsApplicationErrors, ReportLocalPostInsightsOptions, ReportLocalPostInsightsResponse, SearchGoogleLocationsApplicationErrors, SearchGoogleLocationsOptions, SearchGoogleLocationsResponse, StartVerificationApplicationErrors, StartVerificationOptions, StartVerificationResponse, SuggestEstablishmentsApplicationErrors, SuggestEstablishmentsOptions, SuggestEstablishmentsResponse, SuggestRegionsApplicationErrors, SuggestRegionsOptions, SuggestRegionsResponse, UpdateGoogleLocationApplicationErrors, UpdateGoogleLocationOptions, UpdateGoogleLocationResponse, UpdateLocalPostApplicationErrors, UpdateLocalPostIdentifiers, UpdateLocalPostOptions, UpdateLocalPostResponse, UpdateLocation, UpdateLocationAttributesApplicationErrors, UpdateLocationAttributesResponse, UpdateLocationLodgingApplicationErrors, UpdateLocationLodgingOptions, UpdateLocationLodgingResponse, UpdateNotificationSetting, UpdateNotificationSettingApplicationErrors, UpdateNotificationSettingOptions, UpdateNotificationSettingResponse, VerificationMethodWithLiterals, bulkCreateLocations, bulkDeleteLocations, completeVerification, createGoogleLocation, createLocalPost, createLocation, createMedia, deleteGoogleLocation, deleteLocalPost, deleteLocation, deleteMedia, deleteReviewReply, getAddressSchemaByCountryCode, getGbpLocation, getGoogleLocation, getLocalPost, getLocationAdmins, getLocationAttributes, getLocationInsights, getLocationLodging, getNotificationSetting, getVerificationOptions, getVoiceOfMerchant, inviteAdminToLocation, listAttributeMetadata, listCategories, listGbpAccounts, listLocalPosts, listMedia, listReviews, listSearchKeywordImpressions, listUnimportedLocations, putReviewReply, queryGbpLocations, queryGoogleLocations, reportLocalPostInsights, searchGoogleLocations, startVerification, suggestEstablishments, suggestRegions, updateGoogleLocation, updateLocalPost, updateLocation, updateLocationAttributes, updateLocationLodging, updateNotificationSetting };
|