getricky 0.1.17 → 0.1.18

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.
@@ -1,5 +1,5 @@
1
1
  import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
2
- import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, AssignConversationsData, AssignConversationsErrors, AssignConversationsResponses, CancelBroadcastData, CancelBroadcastErrors, CancelBroadcastResponses, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CompleteProfilePhotoUploadData, CompleteProfilePhotoUploadErrors, CompleteProfilePhotoUploadResponses, CompleteTemplateMediaUploadData, CompleteTemplateMediaUploadErrors, CompleteTemplateMediaUploadResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBroadcastData, CreateBroadcastErrors, CreateBroadcastResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateProfilePhotoUploadData, CreateProfilePhotoUploadErrors, CreateProfilePhotoUploadResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateMediaUploadData, CreateTemplateMediaUploadErrors, CreateTemplateMediaUploadResponses, CreateTemplateResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteContactFieldData, DeleteContactFieldErrors, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyErrors, DeleteQuickReplyResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, FetchMessageMediaData, FetchMessageMediaErrors, FetchMessageMediaResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetAgentData, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsErrors, GetAgentOptionsResponses, GetAgentResponses, GetBroadcastData, GetBroadcastErrors, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportErrors, GetBroadcastsReportResponses, GetContactData, GetContactErrors, GetContactResponses, GetConversationData, GetConversationErrors, GetConversationResponses, GetConversationsReportData, GetConversationsReportErrors, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportErrors, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactErrors, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileErrors, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationErrors, GetKnowledgeLocationResponses, GetMessageData, GetMessageErrors, GetMessageResponses, GetMessagesReportData, GetMessagesReportErrors, GetMessagesReportResponses, GetQuickReplyData, GetQuickReplyErrors, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportErrors, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportErrors, GetResponsesReportResponses, GetSendData, GetSendErrors, GetSendResponses, GetTeamReportData, GetTeamReportErrors, GetTeamReportResponses, GetTemplateData, GetTemplateErrors, GetTemplateFieldMappingsData, GetTemplateFieldMappingsErrors, GetTemplateFieldMappingsResponses, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberErrors, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponses, GetWorkflowResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsErrors, ListBroadcastsResponses, ListChannelsData, ListChannelsErrors, ListChannelsResponses, ListContactFieldsData, ListContactFieldsErrors, ListContactFieldsResponses, ListContactsData, ListContactsErrors, ListContactsResponses, ListConversationsData, ListConversationsErrors, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsErrors, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesErrors, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListMessagesData, ListMessagesErrors, ListMessagesResponses, ListQuickRepliesData, ListQuickRepliesErrors, ListQuickRepliesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowReminderStatesData, ListWorkflowReminderStatesErrors, ListWorkflowReminderStatesResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadErrors, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadErrors, MarkConversationUnreadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, PreviewBroadcastAudienceData, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponses, RefreshWhatsAppNumberData, RefreshWhatsAppNumberErrors, RefreshWhatsAppNumberResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, ReplaceTemplateFieldMappingsData, ReplaceTemplateFieldMappingsErrors, ReplaceTemplateFieldMappingsResponses, RequestWhatsAppDisplayNameData, RequestWhatsAppDisplayNameErrors, RequestWhatsAppDisplayNameResponses, ResolveConversationHandoffData, ResolveConversationHandoffErrors, ResolveConversationHandoffResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsErrors, SearchConversationsResponses, SearchMessagesData, SearchMessagesErrors, SearchMessagesResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateKnowledgeContactData, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponses, UpdateKnowledgeFileData, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponses, UpdateKnowledgeLocationData, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponses, UpdateQuickReplyData, UpdateQuickReplyErrors, UpdateQuickReplyResponses, UpdateTagData, UpdateTagErrors, UpdateTagResponses, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateWhatsAppBusinessProfileData, UpdateWhatsAppBusinessProfileErrors, UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppNumberData, UpdateWhatsAppNumberErrors, UpdateWhatsAppNumberResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponses, ValidateTemplateData, ValidateTemplateErrors, ValidateTemplateResponses } from './types.gen.js';
2
+ import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, AssignConversationsData, AssignConversationsErrors, AssignConversationsResponses, CancelBroadcastData, CancelBroadcastErrors, CancelBroadcastResponses, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CompleteProfilePhotoUploadData, CompleteProfilePhotoUploadErrors, CompleteProfilePhotoUploadResponses, CompleteTemplateMediaUploadData, CompleteTemplateMediaUploadErrors, CompleteTemplateMediaUploadResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBroadcastData, CreateBroadcastErrors, CreateBroadcastResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateProfilePhotoUploadData, CreateProfilePhotoUploadErrors, CreateProfilePhotoUploadResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateMediaUploadData, CreateTemplateMediaUploadErrors, CreateTemplateMediaUploadResponses, CreateTemplateResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteContactFieldData, DeleteContactFieldErrors, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyErrors, DeleteQuickReplyResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, FetchMessageMediaData, FetchMessageMediaErrors, FetchMessageMediaResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetAgentData, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsErrors, GetAgentOptionsResponses, GetAgentResponses, GetBroadcastData, GetBroadcastErrors, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportErrors, GetBroadcastsReportResponses, GetContactData, GetContactErrors, GetContactResponses, GetConversationData, GetConversationErrors, GetConversationResponses, GetConversationsReportData, GetConversationsReportErrors, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportErrors, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactErrors, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileErrors, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationErrors, GetKnowledgeLocationResponses, GetMessageData, GetMessageErrors, GetMessageResponses, GetMessagesReportData, GetMessagesReportErrors, GetMessagesReportResponses, GetMetaAdsInsightsData, GetMetaAdsInsightsErrors, GetMetaAdsInsightsResponses, GetQuickReplyData, GetQuickReplyErrors, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportErrors, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportErrors, GetResponsesReportResponses, GetSendData, GetSendErrors, GetSendResponses, GetTeamReportData, GetTeamReportErrors, GetTeamReportResponses, GetTemplateData, GetTemplateErrors, GetTemplateFieldMappingsData, GetTemplateFieldMappingsErrors, GetTemplateFieldMappingsResponses, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberErrors, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowReminderHistoryData, GetWorkflowReminderHistoryErrors, GetWorkflowReminderHistoryResponses, GetWorkflowResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsErrors, ListBroadcastsResponses, ListChannelsData, ListChannelsErrors, ListChannelsResponses, ListContactFieldsData, ListContactFieldsErrors, ListContactFieldsResponses, ListContactsData, ListContactsErrors, ListContactsResponses, ListConversationsData, ListConversationsErrors, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsErrors, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesErrors, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListMessagesData, ListMessagesErrors, ListMessagesResponses, ListMetaAdsAdSetsData, ListMetaAdsAdSetsErrors, ListMetaAdsAdSetsResponses, ListMetaAdsCampaignsData, ListMetaAdsCampaignsErrors, ListMetaAdsCampaignsResponses, ListMetaAdsData, ListMetaAdsErrors, ListMetaAdsResponses, ListQuickRepliesData, ListQuickRepliesErrors, ListQuickRepliesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowReminderStatesData, ListWorkflowReminderStatesErrors, ListWorkflowReminderStatesResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadErrors, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadErrors, MarkConversationUnreadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, PreviewBroadcastAudienceData, PreviewBroadcastAudienceErrors, PreviewBroadcastAudienceResponses, PreviewWorkflowRemindersData, PreviewWorkflowRemindersErrors, PreviewWorkflowRemindersResponses, RefreshWhatsAppNumberData, RefreshWhatsAppNumberErrors, RefreshWhatsAppNumberResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, ReplaceTemplateFieldMappingsData, ReplaceTemplateFieldMappingsErrors, ReplaceTemplateFieldMappingsResponses, RequestWhatsAppDisplayNameData, RequestWhatsAppDisplayNameErrors, RequestWhatsAppDisplayNameResponses, ResolveConversationHandoffData, ResolveConversationHandoffErrors, ResolveConversationHandoffResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsErrors, SearchConversationsResponses, SearchMessagesData, SearchMessagesErrors, SearchMessagesResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateKnowledgeContactData, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponses, UpdateKnowledgeFileData, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponses, UpdateKnowledgeLocationData, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponses, UpdateQuickReplyData, UpdateQuickReplyErrors, UpdateQuickReplyResponses, UpdateTagData, UpdateTagErrors, UpdateTagResponses, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateWhatsAppBusinessProfileData, UpdateWhatsAppBusinessProfileErrors, UpdateWhatsAppBusinessProfileResponses, UpdateWhatsAppNumberData, UpdateWhatsAppNumberErrors, UpdateWhatsAppNumberResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses, UploadWorkflowHeaderMediaData, UploadWorkflowHeaderMediaErrors, UploadWorkflowHeaderMediaResponses, ValidateTemplateData, ValidateTemplateErrors, ValidateTemplateResponses } from './types.gen.js';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -415,6 +415,38 @@ export declare class RickyApi extends HeyApiClient {
415
415
  * Scope: `reports:read`.
416
416
  */
417
417
  getAdsReport<ThrowOnError extends boolean = true>(options?: Options<GetAdsReportData, ThrowOnError>): RequestResult<GetAdsReportResponses, GetAdsReportErrors, ThrowOnError, 'data'>;
418
+ /**
419
+ * List Meta ad campaigns
420
+ *
421
+ * Campaigns of the connected Meta ad accounts, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
422
+ *
423
+ * Scope: `reports:read`.
424
+ */
425
+ listMetaAdsCampaigns<ThrowOnError extends boolean = true>(options?: Options<ListMetaAdsCampaignsData, ThrowOnError>): RequestResult<ListMetaAdsCampaignsResponses, ListMetaAdsCampaignsErrors, ThrowOnError, 'data'>;
426
+ /**
427
+ * List Meta ad sets
428
+ *
429
+ * Ad sets of the connected Meta ad accounts with budget and targeting, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
430
+ *
431
+ * Scope: `reports:read`.
432
+ */
433
+ listMetaAdsAdSets<ThrowOnError extends boolean = true>(options?: Options<ListMetaAdsAdSetsData, ThrowOnError>): RequestResult<ListMetaAdsAdSetsResponses, ListMetaAdsAdSetsErrors, ThrowOnError, 'data'>;
434
+ /**
435
+ * List Meta ads
436
+ *
437
+ * Ads of the connected Meta ad accounts with their creative copy, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
438
+ *
439
+ * Scope: `reports:read`.
440
+ */
441
+ listMetaAds<ThrowOnError extends boolean = true>(options?: Options<ListMetaAdsData, ThrowOnError>): RequestResult<ListMetaAdsResponses, ListMetaAdsErrors, ThrowOnError, 'data'>;
442
+ /**
443
+ * Get Meta ads insights
444
+ *
445
+ * Spend, delivery and Meta's actions for the connected ad accounts over a period, per account, campaign, ad set or ad, computed live by Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
446
+ *
447
+ * Scope: `reports:read`.
448
+ */
449
+ getMetaAdsInsights<ThrowOnError extends boolean = true>(options: Options<GetMetaAdsInsightsData, ThrowOnError>): RequestResult<GetMetaAdsInsightsResponses, GetMetaAdsInsightsErrors, ThrowOnError, 'data'>;
418
450
  /**
419
451
  * List agents
420
452
  *
@@ -802,6 +802,66 @@ export class RickyApi extends HeyApiClient {
802
802
  ...options
803
803
  });
804
804
  }
805
+ /**
806
+ * List Meta ad campaigns
807
+ *
808
+ * Campaigns of the connected Meta ad accounts, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
809
+ *
810
+ * Scope: `reports:read`.
811
+ */
812
+ listMetaAdsCampaigns(options) {
813
+ return (options?.client ?? this.client).get({
814
+ responseStyle: 'data',
815
+ security: [{ scheme: 'bearer', type: 'http' }],
816
+ url: '/ads/campaigns',
817
+ ...options
818
+ });
819
+ }
820
+ /**
821
+ * List Meta ad sets
822
+ *
823
+ * Ad sets of the connected Meta ad accounts with budget and targeting, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
824
+ *
825
+ * Scope: `reports:read`.
826
+ */
827
+ listMetaAdsAdSets(options) {
828
+ return (options?.client ?? this.client).get({
829
+ responseStyle: 'data',
830
+ security: [{ scheme: 'bearer', type: 'http' }],
831
+ url: '/ads/ad-sets',
832
+ ...options
833
+ });
834
+ }
835
+ /**
836
+ * List Meta ads
837
+ *
838
+ * Ads of the connected Meta ad accounts with their creative copy, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
839
+ *
840
+ * Scope: `reports:read`.
841
+ */
842
+ listMetaAds(options) {
843
+ return (options?.client ?? this.client).get({
844
+ responseStyle: 'data',
845
+ security: [{ scheme: 'bearer', type: 'http' }],
846
+ url: '/ads/ads',
847
+ ...options
848
+ });
849
+ }
850
+ /**
851
+ * Get Meta ads insights
852
+ *
853
+ * Spend, delivery and Meta's actions for the connected ad accounts over a period, per account, campaign, ad set or ad, computed live by Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection.
854
+ *
855
+ * Scope: `reports:read`.
856
+ */
857
+ getMetaAdsInsights(options) {
858
+ return (options.client ?? this.client).get({
859
+ responseStyle: 'data',
860
+ security: [{ scheme: 'bearer', type: 'http' }],
861
+ url: '/ads/insights',
862
+ ...options
863
+ });
864
+ }
805
865
  /**
806
866
  * List agents
807
867
  *