@automate.ax/integration-contracts 0.139.2 → 0.142.0

package/dist/meta-ads/schemas.d.ts

@@ -0,0 +1,184 @@
+import * as z from "zod";
+export declare const META_ADS_ID_SCHEMA: z.ZodString;
+export declare const META_ADS_STATUS_SCHEMA: z.ZodEnum<{
+    ACTIVE: "ACTIVE";
+    ARCHIVED: "ARCHIVED";
+    DELETED: "DELETED";
+    PAUSED: "PAUSED";
+}>;
+export declare const META_ADS_BUSINESS_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    verificationStatus: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_ACCOUNT_SCHEMA: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodString>;
+    amountSpent: z.ZodOptional<z.ZodString>;
+    balance: z.ZodOptional<z.ZodString>;
+    business: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>>;
+    currency: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    timezoneId: z.ZodOptional<z.ZodNumber>;
+    timezoneName: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_CAMPAIGN_SCHEMA: z.ZodObject<{
+    buyingType: z.ZodOptional<z.ZodString>;
+    configuredStatus: z.ZodOptional<z.ZodString>;
+    effectiveStatus: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    objective: z.ZodOptional<z.ZodString>;
+    specialAdCategories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    status: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_AD_SET_SCHEMA: z.ZodObject<{
+    bidAmount: z.ZodOptional<z.ZodNumber>;
+    billingEvent: z.ZodOptional<z.ZodString>;
+    campaignId: z.ZodOptional<z.ZodString>;
+    configuredStatus: z.ZodOptional<z.ZodString>;
+    dailyBudget: z.ZodOptional<z.ZodString>;
+    effectiveStatus: z.ZodOptional<z.ZodString>;
+    endTime: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    lifetimeBudget: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    optimizationGoal: z.ZodOptional<z.ZodString>;
+    startTime: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    targeting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_AD_SCHEMA: z.ZodObject<{
+    adsetId: z.ZodOptional<z.ZodString>;
+    campaignId: z.ZodOptional<z.ZodString>;
+    configuredStatus: z.ZodOptional<z.ZodString>;
+    creative: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>>;
+    effectiveStatus: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    status: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_CREATIVE_SCHEMA: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+    effectiveObjectStoryId: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    objectStoryId: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_AUDIENCE_SCHEMA: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodString>;
+    approximateCountLowerBound: z.ZodOptional<z.ZodNumber>;
+    approximateCountUpperBound: z.ZodOptional<z.ZodNumber>;
+    description: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    subtype: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_LEAD_FORM_SCHEMA: z.ZodObject<{
+    id: z.ZodString;
+    locale: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    status: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_LEAD_SCHEMA: z.ZodObject<{
+    adId: z.ZodOptional<z.ZodString>;
+    adName: z.ZodOptional<z.ZodString>;
+    adsetId: z.ZodOptional<z.ZodString>;
+    adsetName: z.ZodOptional<z.ZodString>;
+    campaignId: z.ZodOptional<z.ZodString>;
+    campaignName: z.ZodOptional<z.ZodString>;
+    createdTime: z.ZodOptional<z.ZodString>;
+    fieldData: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        values: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>;
+    formId: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    isOrganic: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_PIXEL_SCHEMA: z.ZodObject<{
+    code: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    isUnavailable: z.ZodOptional<z.ZodBoolean>;
+    lastFiredTime: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_INSIGHT_SCHEMA: z.ZodObject<{
+    accountId: z.ZodOptional<z.ZodString>;
+    accountName: z.ZodOptional<z.ZodString>;
+    adId: z.ZodOptional<z.ZodString>;
+    adName: z.ZodOptional<z.ZodString>;
+    adsetId: z.ZodOptional<z.ZodString>;
+    adsetName: z.ZodOptional<z.ZodString>;
+    campaignId: z.ZodOptional<z.ZodString>;
+    campaignName: z.ZodOptional<z.ZodString>;
+    clicks: z.ZodOptional<z.ZodString>;
+    cpc: z.ZodOptional<z.ZodString>;
+    cpm: z.ZodOptional<z.ZodString>;
+    ctr: z.ZodOptional<z.ZodString>;
+    dateStart: z.ZodOptional<z.ZodString>;
+    dateStop: z.ZodOptional<z.ZodString>;
+    impressions: z.ZodOptional<z.ZodString>;
+    reach: z.ZodOptional<z.ZodString>;
+    spend: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_SUBSCRIPTION_SCHEMA: z.ZodObject<{
+    eventType: z.ZodEnum<{
+        INSIGHTS_MILESTONE_REACHED: "INSIGHTS_MILESTONE_REACHED";
+        INSIGHTS_UPDATED: "INSIGHTS_UPDATED";
+        OBJECT_CREATED: "OBJECT_CREATED";
+        OBJECT_UPDATED: "OBJECT_UPDATED";
+    }>;
+    field: z.ZodOptional<z.ZodString>;
+    filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        operator: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>>;
+    operator: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    subscriptionId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    value: z.ZodOptional<z.ZodString>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_SUBSCRIPTION_CREATE_RESULT_SCHEMA: z.ZodObject<{
+    subscriptionId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_MUTATION_RESULT_SCHEMA: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    success: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_CONVERSION_RESULT_SCHEMA: z.ZodObject<{
+    eventsReceived: z.ZodNumber;
+    fbtraceId: z.ZodOptional<z.ZodString>;
+    messages: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
+export declare const META_ADS_PAGE_INFO_SCHEMA: z.ZodObject<{
+    after: z.ZodOptional<z.ZodString>;
+    before: z.ZodOptional<z.ZodString>;
+    next: z.ZodOptional<z.ZodString>;
+    previous: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const META_ADS_WEBHOOK_CHANGE_SCHEMA: z.ZodObject<{
+    field: z.ZodString;
+    value: z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>;
+}, z.core.$strip>;
+export declare const META_ADS_WEBHOOK_ENVELOPE_SCHEMA: z.ZodObject<{
+    entry: z.ZodArray<z.ZodObject<{
+        changes: z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            value: z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>;
+        }, z.core.$strip>>;
+        id: z.ZodString;
+        time: z.ZodNumber;
+    }, z.core.$strip>>;
+    object: z.ZodString;
+}, z.core.$strip>;
+export type MetaAdsWebhookEnvelope = z.output<typeof META_ADS_WEBHOOK_ENVELOPE_SCHEMA>;

package/dist/meta-ads/schemas.js

@@ -0,0 +1,181 @@
+import * as z from "zod";
+import { encodableSchema } from "@automate.ax/codec";
+const metaObject = (shape) => z.object(shape).catchall(encodableSchema);
+export const META_ADS_ID_SCHEMA = z.string().trim().min(1);
+export const META_ADS_STATUS_SCHEMA = z.enum([
+    "ACTIVE",
+    "ARCHIVED",
+    "DELETED",
+    "PAUSED",
+]);
+export const META_ADS_BUSINESS_SCHEMA = metaObject({
+    id: META_ADS_ID_SCHEMA,
+    name: z.string(),
+    verificationStatus: z.string().optional(),
+});
+export const META_ADS_ACCOUNT_SCHEMA = metaObject({
+    accountId: z.string().optional(),
+    amountSpent: z.string().optional(),
+    balance: z.string().optional(),
+    business: metaObject({
+        id: z.string(),
+        name: z.string().optional(),
+    }).optional(),
+    currency: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    name: z.string(),
+    timezoneId: z.number().optional(),
+    timezoneName: z.string().optional(),
+});
+export const META_ADS_CAMPAIGN_SCHEMA = metaObject({
+    buyingType: z.string().optional(),
+    configuredStatus: z.string().optional(),
+    effectiveStatus: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    name: z.string(),
+    objective: z.string().optional(),
+    specialAdCategories: z.string().array().optional(),
+    status: z.string().optional(),
+});
+export const META_ADS_AD_SET_SCHEMA = metaObject({
+    bidAmount: z.number().optional(),
+    billingEvent: z.string().optional(),
+    campaignId: META_ADS_ID_SCHEMA.optional(),
+    configuredStatus: z.string().optional(),
+    dailyBudget: z.string().optional(),
+    effectiveStatus: z.string().optional(),
+    endTime: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    lifetimeBudget: z.string().optional(),
+    name: z.string(),
+    optimizationGoal: z.string().optional(),
+    startTime: z.string().optional(),
+    status: z.string().optional(),
+    targeting: z.record(z.string(), encodableSchema).optional(),
+});
+export const META_ADS_AD_SCHEMA = metaObject({
+    adsetId: META_ADS_ID_SCHEMA.optional(),
+    campaignId: META_ADS_ID_SCHEMA.optional(),
+    configuredStatus: z.string().optional(),
+    creative: metaObject({ id: z.string() }).optional(),
+    effectiveStatus: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    name: z.string(),
+    status: z.string().optional(),
+});
+export const META_ADS_CREATIVE_SCHEMA = metaObject({
+    accountId: z.string().optional(),
+    body: z.string().optional(),
+    effectiveObjectStoryId: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    name: z.string().optional(),
+    objectStoryId: z.string().optional(),
+    status: z.string().optional(),
+    title: z.string().optional(),
+});
+export const META_ADS_AUDIENCE_SCHEMA = metaObject({
+    accountId: z.string().optional(),
+    approximateCountLowerBound: z.number().optional(),
+    approximateCountUpperBound: z.number().optional(),
+    description: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    name: z.string(),
+    subtype: z.string().optional(),
+});
+export const META_ADS_LEAD_FORM_SCHEMA = metaObject({
+    id: META_ADS_ID_SCHEMA,
+    locale: z.string().optional(),
+    name: z.string(),
+    status: z.string().optional(),
+});
+export const META_ADS_LEAD_SCHEMA = metaObject({
+    adId: z.string().optional(),
+    adName: z.string().optional(),
+    adsetId: z.string().optional(),
+    adsetName: z.string().optional(),
+    campaignId: z.string().optional(),
+    campaignName: z.string().optional(),
+    createdTime: z.string().optional(),
+    fieldData: z
+        .object({ name: z.string(), values: z.string().array() })
+        .array()
+        .optional(),
+    formId: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    isOrganic: z.boolean().optional(),
+});
+export const META_ADS_PIXEL_SCHEMA = metaObject({
+    code: z.string().optional(),
+    id: META_ADS_ID_SCHEMA,
+    isUnavailable: z.boolean().optional(),
+    lastFiredTime: z.string().optional(),
+    name: z.string(),
+});
+export const META_ADS_INSIGHT_SCHEMA = metaObject({
+    accountId: z.string().optional(),
+    accountName: z.string().optional(),
+    adId: z.string().optional(),
+    adName: z.string().optional(),
+    adsetId: z.string().optional(),
+    adsetName: z.string().optional(),
+    campaignId: z.string().optional(),
+    campaignName: z.string().optional(),
+    clicks: z.string().optional(),
+    cpc: z.string().optional(),
+    cpm: z.string().optional(),
+    ctr: z.string().optional(),
+    dateStart: z.string().optional(),
+    dateStop: z.string().optional(),
+    impressions: z.string().optional(),
+    reach: z.string().optional(),
+    spend: z.string().optional(),
+});
+export const META_ADS_SUBSCRIPTION_SCHEMA = metaObject({
+    eventType: z.enum([
+        "INSIGHTS_MILESTONE_REACHED",
+        "INSIGHTS_UPDATED",
+        "OBJECT_CREATED",
+        "OBJECT_UPDATED",
+    ]),
+    field: z.string().optional(),
+    filters: z
+        .object({ field: z.string(), operator: z.string(), value: z.string() })
+        .array()
+        .optional(),
+    operator: z.string().optional(),
+    status: z.string().optional(),
+    subscriptionId: z.union([META_ADS_ID_SCHEMA, z.number()]).transform(String),
+    value: z.string().optional(),
+});
+export const META_ADS_SUBSCRIPTION_CREATE_RESULT_SCHEMA = metaObject({
+    subscriptionId: z.union([META_ADS_ID_SCHEMA, z.number()]).transform(String),
+});
+export const META_ADS_MUTATION_RESULT_SCHEMA = metaObject({
+    id: z.string().optional(),
+    success: z.boolean().optional(),
+});
+export const META_ADS_CONVERSION_RESULT_SCHEMA = metaObject({
+    eventsReceived: z.number().int().nonnegative(),
+    fbtraceId: z.string().optional(),
+    messages: z.string().array().optional(),
+});
+export const META_ADS_PAGE_INFO_SCHEMA = z.object({
+    after: z.string().optional(),
+    before: z.string().optional(),
+    next: z.string().url().optional(),
+    previous: z.string().url().optional(),
+});
+export const META_ADS_WEBHOOK_CHANGE_SCHEMA = z.object({
+    field: z.string(),
+    value: encodableSchema,
+});
+export const META_ADS_WEBHOOK_ENVELOPE_SCHEMA = z.object({
+    entry: z
+        .object({
+        changes: META_ADS_WEBHOOK_CHANGE_SCHEMA.array(),
+        id: z.string(),
+        time: z.number(),
+    })
+        .array(),
+    object: z.string(),
+});