v3.0.0

What's Changed

Specs Changes

AdManager:

Added:

• new method fbGetReporting added GET /ad-publishing/facebook/reporting
• new method fbGetCampaignReporting added GET /ad-publishing/facebook/reporting/campaign/{campaignId}
• new method fbGetReportingList added GET /ad-publishing/facebook/reporting/list
• new method fbGetCurrentUser added GET /ad-publishing/facebook/me
• new method fbGetPages added GET /ad-publishing/facebook/pages
• new method fbGetInstagramAccounts added GET /ad-publishing/facebook/page/{pageId}/instagram
• new method fbGetPageLeadForms added GET /ad-publishing/facebook/page/{pageId}/forms
• new method fbCreatePageLeadForm added POST /ad-publishing/facebook/page/{pageId}/forms
• new method fbGetAdAccounts added GET /ad-publishing/facebook/ad-accounts
• new method fbGetAdAccount added GET /ad-publishing/facebook/ad-accounts/{adAccountId}
• new method fbDeleteAdAccount added DELETE /ad-publishing/facebook/ad-accounts/{adAccountId}
• new method fbGetConversationForms added GET /ad-publishing/facebook/conversation-forms
• new method fbCreateConversationForm added POST /ad-publishing/facebook/conversation-forms
• new method fbGetIntegration added GET /ad-publishing/facebook/integration
• new method fbCreateIntegration added POST /ad-publishing/facebook/integration
• new method fbDeleteIntegration added DELETE /ad-publishing/facebook/integration
• new method fbSearchTargeting added GET /ad-publishing/facebook/targeting/search
• new method fbPublishCampaign added POST /ad-publishing/facebook/campaigns/{campaignId}/publish
• new method fbDeletePage added DELETE /ad-publishing/facebook/page
• new method fbGetPixels added GET /ad-publishing/facebook/pixels
• new method fbUpsertPixel added PUT /ad-publishing/facebook/pixels
• new method fbGetCustomAudiences added GET /ad-publishing/facebook/custom-audience
• new method fbGetCustomAudienceById added GET /ad-publishing/facebook/custom-audience/{audienceId}
• new method fbUpdateCustomAudience added PUT /ad-publishing/facebook/custom-audience/{audienceId}
• new method fbDeleteCustomAudience added DELETE /ad-publishing/facebook/custom-audience/{audienceId}
• new method fbAddCustomAudienceMember added PUT /ad-publishing/facebook/custom-audience/{audienceId}/member
• new method fbRemoveCustomAudienceMember added DELETE /ad-publishing/facebook/custom-audience/{audienceId}/member
• new method fbBatchUpdateAudienceMembers added PUT /ad-publishing/facebook/custom-audience/{audienceId}/member/batch
• new method fbSetDefaultPage added PUT /ad-publishing/facebook/page/default
• new method fbGetLeadForm added GET /ad-publishing/facebook/lead-form/{leadFormId}
• new method fbGetCampaign added GET /ad-publishing/facebook/campaign/{campaignId}
• new method fbGetEntity added GET /ad-publishing/facebook/entity
• new method fbUpsertCampaign added PUT /ad-publishing/facebook/campaigns
• new method fbUpsertAdset added PUT /ad-publishing/facebook/adsets
• new method fbUpsertAd added PUT /ad-publishing/facebook/ads-v2
• new method fbPauseCampaign added POST /ad-publishing/facebook/campaigns/{campaignId}/pause
• new method fbResumeCampaign added POST /ad-publishing/facebook/campaigns/{campaignId}/resume
• new method fbDuplicateCampaign added POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate
• new method fbDeleteCampaign added DELETE /ad-publishing/facebook/campaigns/{campaignId}
• new method fbPauseAdset added POST /ad-publishing/facebook/adsets/{adsetId}/pause
• new method fbResumeAdset added POST /ad-publishing/facebook/adsets/{adsetId}/resume
• new method fbDuplicateAdset added POST /ad-publishing/facebook/adsets/{adsetId}/duplicate
• new method fbDeleteAdset added DELETE /ad-publishing/facebook/adsets/{adsetId}
• new method fbPauseAd added POST /ad-publishing/facebook/ads/{adId}/pause
• new method fbResumeAd added POST /ad-publishing/facebook/ads/{adId}/resume
• new method fbDuplicateAd added POST /ad-publishing/facebook/ads/{adId}/duplicate
• new method fbDeleteAd added DELETE /ad-publishing/facebook/ads/{adId}
• new method googleGetReporting added GET /ad-publishing/google/reporting
• new method googleGetReportingList added GET /ad-publishing/google/reporting/list
• new method googleGetCampaignReporting added GET /ad-publishing/google/reporting/campaign/{campaignId}
• new method googleGetConversions added GET /ad-publishing/google/conversions
• new method googleUpsertConversion added PUT /ad-publishing/google/conversions
• new method googleGetConversionById added GET /ad-publishing/google/conversions/{conversionId}
• new method googleDeleteConversion added DELETE /ad-publishing/google/conversions/{conversionId}
• new method googleGetIntegration added GET /ad-publishing/google/integration
• new method googleCreateIntegration added POST /ad-publishing/google/integration
• new method googleGetCurrentUser added GET /ad-publishing/google/me
• new method googleGetAdAccounts added GET /ad-publishing/google/ad-accounts
• new method googleGetAdAccountDetails added GET /ad-publishing/google/ad-accounts/{adAccountId}
• new method googleDeleteAdAccount added DELETE /ad-publishing/google/ad-accounts/{adAccountId}
• new method googlePublishAd added POST /ad-publishing/google/ads/{adId}/publish
• new method googleSearchTargeting added GET /ad-publishing/google/targeting/search
• new method googleGetKeywordIdeas added POST /ad-publishing/google/keyword-ideas
• new method googleGetAssets added GET /ad-publishing/google/assets
• new method googleUpsertAssets added POST /ad-publishing/google/assets
• new method googleGetEntity added GET /ad-publishing/google/entity
• new method googleGetTargetInterests added GET /ad-publishing/google/target-interests
• new method googleGetSegments added GET /ad-publishing/google/segments
• new method googleUpsertSegment added PUT /ad-publishing/google/segments
• new method googleGetSegmentById added GET /ad-publishing/google/segments/{segmentId}
• new method googleDeleteSegment added DELETE /ad-publishing/google/segments/{segmentId}
• new method googleCreateOfflineUserListJob added POST /ad-publishing/google/segments/offline-user-list-job
• new method googleGetAudiences added GET /ad-publishing/google/audiences
• new method googleUpsertAudience added PUT /ad-publishing/google/audiences
• new method googleGetAudienceById added GET /ad-publishing/google/audiences/{audienceId}
• new method googleUpsertCampaign added PUT /ad-publishing/google/ads
• new method googleGetCampaignById added GET /ad-publishing/google/ads/{adId}
• new method googleGetConversionGoals added GET /ad-publishing/google/conversion-goals
• new method liGetIntegration added GET /ad-publishing/linkedin/integration
• new method liCreateIntegration added POST /ad-publishing/linkedin/integration
• new method liGetAdAccounts added GET /ad-publishing/linkedin/ad-accounts
• new method liGetAdAccountDetails added GET /ad-publishing/linkedin/ad-account
• new method liDeleteAdAccount added DELETE /ad-publishing/linkedin/ad-account
• new method liGetCurrentUser added GET /ad-publishing/linkedin/me
• new method liGetCampaignGroup added GET /ad-publishing/linkedin/ads/{adId}
• new method liPublishCampaignGroup added POST /ad-publishing/linkedin/ads/{adId}/publish
• new method liUpsertCampaignGroup added PUT /ad-publishing/linkedin/ads
• new method liSearchTargeting added GET /ad-publishing/linkedin/targeting/search
• new method liGetLeadForms added GET /ad-publishing/linkedin/{accountId}/forms
• new method liCreateLeadForm added POST /ad-publishing/linkedin/{accountId}/form
• new method liUpdateAdStatus added PATCH /ad-publishing/linkedin/{adId}/status
• new method liGetAdAnalytics added GET /ad-publishing/linkedin/reporting
• new method liGetReportingList added GET /ad-publishing/linkedin/reporting/list
• new method liGetCampaignGroupReporting added GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId}

AffiliateManager:

Added:

• new method listAffiliates added GET /affiliate-manager/{locationId}/affiliates
• new method getAffiliate added GET /affiliate-manager/{locationId}/affiliates/{affiliateId}
• new method listPayouts added GET /affiliate-manager/{locationId}/payouts
• new method listCommissions added GET /affiliate-manager/{locationId}/commissions

AgentStudio:

Added:

• new method getAgents added GET /agent-studio/agent
• new method createAgent added POST /agent-studio/agent
• new method updateAgentVersion added PATCH /agent-studio/agent/versions/{versionId}
• new method getAgentById added GET /agent-studio/agent/{agentId}
• new method deleteAgent added DELETE /agent-studio/agent/{agentId}
• new method updateAgentMetadata added PATCH /agent-studio/agent/{agentId}
• new method promoteAndPublish added POST /agent-studio/agent/versions/{versionId}/publish
• new method executeAgent added POST /agent-studio/agent/{agentId}/execute
• new method getAgentsDeprecated added GET /agent-studio/public-api/agents (deprecated)
• new method getAgentByIdDeprecated added GET /agent-studio/public-api/agents/{agentId} (deprecated)
• new method executeAgentDeprecated added POST /agent-studio/public-api/agents/{agentId}/execute (deprecated)

BrandBoards:

Added:

• new method getBrandBoardsByLocation added GET /brand-boards/{locationId}
• new method getBrandBoardById added GET /brand-boards/{locationId}/{id}
• new method deleteBrandBoard added DELETE /brand-boards/{locationId}/{id}
• new method updateBrandBoard added PATCH /brand-boards/{locationId}/{id}
• new method createBrandBoard added POST /brand-boards/

Businesses:

Added:

• query param limit is added in getBusinessesByLocation method (optional)
• quer...

v2.3.0

What's Changed

SDK Changes

• feat: ed25519 signature support added in webhook, axios version bumped (f58cb4f)

v2.2.2

What's Changed

Specs Changes

Calendars:

Added:

• request body field added in method (optional)
• response body nested field added in method (optional)
• request body field added in method (optional)
• response body array item field added in method (optional)
• response body array item field added in method (optional)
• response body field added in method (optional)
• response body field added in method (optional)
• request body field added in method (optional)
• request body field added in method (optional)

Removed:

• response body removed in method

SDK Changes

• fix: add return statements and await calls in webhook processing, pass raw body for oauth, remove unique key for tokens and create index for appId and resourceId (f5bd807)

v2.2.1

What's Changed

SDK Changes

• fix: remove all params from axios request config object which is causing 422 errors (e96f45b)

v2.2.0

What's Changed

SDK Changes

• refactor: service template params and token handle improved (6b46327)

v2.1.0

What's Changed

SDK Changes

• changes in config to reduce the size of the sdk (8ce6d34)
• fix: token not getting auto refreshed when api throws 401 error (3747ddb)

v2.0.0

What's Changed

Specs changes

Contacts:

Removed:

• response body SearchContactSuccessResponseDto removed in searchContactsAdvanced method

Modified:

• method name changed from deleteContactToWorkflow to deleteContactFromWorkflow for DELETE /contacts/{contactId}/workflow/{workflowId}

Locations:

Added:

• new method getRecurringTaskById added GET /locations/{locationId}/recurring-tasks/{id}
• new method updateRecurringTask added PUT /locations/{locationId}/recurring-tasks/{id}
• new method deleteRecurringTask added DELETE /locations/{locationId}/recurring-tasks/{id}
• new method createRecurringTask added POST /locations/{locationId}/recurring-tasks

Payments:

Added:

• new method recordOrderPayment added POST /payments/orders/{orderId}/record-payment
• new method postMigrateOrderPaymentStatus added POST /payments/orders/migrate-order-ps
• new method listOrderNotes added GET /payments/orders/{orderId}/notes
• new method customProviderMarketplaceAppUpdateCapabilities added PUT /payments/custom-provider/capabilities
• response body field automaticTaxesCalculated added in getOrderById method (optional)
• response body field taxCalculationProvider added in getOrderById method (optional)
• response body array item field data[].items[].product.automaticTaxCategoryId added in listOrderFulfillment method (optional)
• response body array item field data.items[].product.automaticTaxCategoryId added in createOrderFulfillment method (optional)
• response body array item field data[].mergedFromContactId added in listTransactions method (optional)
• response body array item field data[].fulfilledAt added in listTransactions method (required)
• response body field mergedFromContactId added in getTransactionById method (optional)
• request body field supportsSubscriptionSchedule added in createIntegration method (required)

Removed:

• query param altType is removed in getOrderById method (required)
• response body array item field data[].hasAffiliateCoupon removed in listCoupons method
• response body array item field data[].deleted removed in listCoupons method

PhoneSystem:

Added:

• new method getNumberPoolList added GET /phone-system/number-pools
• new method activeNumbers added GET /phone-system/numbers/location/{locationId}

Products:

Added:

• new method bulkEdit added POST /products/bulk-update/edit
• new method updateDisplayPriority added POST /products/store/{storeId}/priority
• request body field altId added in updateStoreStatus method (required)
• request body field altType added in updateStoreStatus method (required)
• query param altId is added in getProductCollectionId method (required)
• query param sendWishlistStatus is added in getProductById method (optional)
• request body field taxInclusive added in updateProductById method (optional)
• request body field prices added in updateProductById method (optional)
• query param sendWishlistStatus is added in deleteProductById method (optional)
• request body field taxInclusive added in createProduct method (optional)

Removed:

• response body field medias removed in getProductById method
• response body field userId removed in getProductById method
• response body field isLabelEnabled removed in getProductById method
• response body field seo removed in getProductById method
• response body field medias removed in updateProductById method
• response body field userId removed in updateProductById method
• response body field isLabelEnabled removed in updateProductById method
• response body field seo removed in updateProductById method
• response body array item field products[].medias removed in listInvoices method
• response body array item field products[].userId removed in listInvoices method
• response body array item field products[].isLabelEnabled removed in listInvoices method
• response body array item field products[].seo removed in listInvoices method
• response body field medias removed in createProduct method
• response body field userId removed in createProduct method
• response body field isLabelEnabled removed in createProduct method
• response body field seo removed in createProduct method

Proposals:

Added:

• new method listDocumentsContracts added GET /proposals/document
• new method sendDocumentsContracts added POST /proposals/document/send
• new method listDocumentsContractsTemplates added GET /proposals/templates
• new method sendDocumentsContractsTemplate added POST /proposals/templates/send

Store:

Added:

• new method listShippingZones added GET /store/shipping-zone
• new method createShippingZone added POST /store/shipping-zone
• new method getShippingZones added GET /store/shipping-zone/{shippingZoneId}
• new method updateShippingZone added PUT /store/shipping-zone/{shippingZoneId}
• new method deleteShippingZone added DELETE /store/shipping-zone/{shippingZoneId}
• new method getAvailableShippingZones added POST /store/shipping-zone/shipping-rates
• new method listShippingRates added GET /store/shipping-zone/{shippingZoneId}/shipping-rate
• new method createShippingRate added POST /store/shipping-zone/{shippingZoneId}/shipping-rate
• new method getShippingRates added GET /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}
• new method updateShippingRate added PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}
• new method deleteShippingRate added DELETE /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}
• new method listShippingCarriers added GET /store/shipping-carrier
• new method createShippingCarrier added POST /store/shipping-carrier
• new method getShippingCarriers added GET /store/shipping-carrier/{shippingCarrierId}
• new method updateShippingCarrier added PUT /store/shipping-carrier/{shippingCarrierId}
• new method deleteShippingCarrier added DELETE /store/shipping-carrier/{shippingCarrierId}
• new method getStoreSettings added GET /store/store-setting
• new method createStoreSetting added POST /store/store-setting

VoiceAi:

Added:

• new method getAgents added GET /voice-ai/agents
• new method createAgent added POST /voice-ai/agents
• new method getAgent added GET /voice-ai/agents/{agentId}
• new method deleteAgent added DELETE /voice-ai/agents/{agentId}
• new method patchAgent added PATCH /voice-ai/agents/{agentId}
• new method getCallLogs added GET /voice-ai/dashboard/call-logs
• new method getCallLog added GET /voice-ai/dashboard/call-logs/{callId}
• new method createAction added POST /voice-ai/actions
• new method getAction added GET /voice-ai/actions/{actionId}
• new method updateAction added PUT /voice-ai/actions/{actionId}
• new method deleteAction added DELETE /voice-ai/actions/{actionId}

SDK changes

• fix: remove extra things from package to reduce the build size (3fe5b3a)

v1.0.1

What's Changed

Specs Changes

Conversations:
Added:

• response body field added in method (optional)
• response body array item field added in method (optional)

Marketplace:
Added:

• request body field added in method (optional)

Modified:

• method endpoint changed from GET /marketplace/app/{appId}/installer-details to GET /marketplace/app/{appId}/installations

Users:
Added:

• path param is added in method

Removed:

• header param is removed in method

SDK Changes

• fix: crypto package removed, token expire function moved to base storage class (d96d25c)

v1.0.0

What's Changed

SDK Changes

• feat: package name updated for highlevel api client (e85cc51)

v0.1.0

What's Changed

SDK Changes

• feat: use company token as fallback if available while refreshing location token (4dfa77e)