facebookgen

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

type Content struct {
	// Product Id
	Id string `json:"id,omitempty"`
	// number of product
	Quantity int32 `json:"quantity,omitempty"`
	// Item Price.
	ItemPrice float32 `json:"item_price,omitempty"`
}

type CustomData struct {
	// A numeric value associated with this event. This could be a monetary value or a value in some other metric.
	Value float32 `json:"value,omitempty"`
	// The currency for the value specified, if applicable. Currency must be a valid ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217) three digit currency code.
	Currency string `json:"currency,omitempty"`
	// The name of the page or product associated with the event.
	ContentName string `json:"content_name,omitempty"`
	// The category of the content associated with the event.
	ContentCategory string `json:"content_category,omitempty"`
	// The content IDs associated with the event, such as product SKUs for items in an AddToCart event: ['ABC123', 'XYZ789']. If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values.
	ContentIds []string `json:"content_ids,omitempty"`
	// A list of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields.
	Contents []Content `json:"contents,omitempty"`
	// It should be set to 'product' or 'product_group'. Use 'product', if the keys you send represent products. Sent keys could be content_ids or contents. Use product_group, if the keys you send in content_ids represent product groups. Product groups are used to distinguish products that are identical but have variations such as color, material, size or pattern.
	ContentType string `json:"content_type,omitempty"`
	// The order ID for this transaction as a String.
	OrderId string `json:"order_id,omitempty"`
	// The predicted lifetime value of a conversion event, as a String.
	PredictedLtv float32 `json:"predicted_ltv,omitempty"`
	// Use only with InitiateCheckout events. The number of items that a user tries to buy during checkout.
	NumItems int32 `json:"num_items,omitempty"`
	// Use only with Search events. A search query made by a user.
	SearchString string `json:"search_string,omitempty"`
	// Use only with CompleteRegistration events. The status of the registration event
	Status string `json:"status,omitempty"`
}

type DefaultApiService service

type Event struct {
	// A Facebook pixel Standard Event or Custom Event name. This field is used to deduplicate events sent by both Facebook Pixel and Conversions API. event_id is also used in deduplication. For the same customer action, event from the browser event match event_name from the server event. If we find a match between events sent within 48 hours of each other, we only consider the first one. If a server and browser event arrive at approximately the same time (within 5 minutes of each other), we favor the browser event.
	EventName string `json:"event_name"`
	// A Unix timestamp in seconds indicating when the actual event occurred. The specified time may be earlier than the time you send the event to Facebook. This is to enable batch processing and server performance optimization. event_time can be up to 7 days before you send an event to Facebook. If any event_time in data is greater than 7 days in the past, we return an error for the entire request and process no events.
	EventTime int64 `json:"event_time"`
	// The browser URL where the event happened.
	EventSourceUrl string `json:"event_source_url,omitempty"`
	// A flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution.
	OptOut bool `json:"opt_out,omitempty"`
	// This ID can be any unique string chosen by the advertiser. event_id is used to deduplicate events sent by both Facebook Pixel and Conversions API. event_name is also used in deduplication. For deduplication, the eventID from a browser event must match the event_id in the corresponding server event.
	EventId string `json:"event_id,omitempty"`
	// This field allows you to specify where your conversions occurred. Knowing where your events took place helps ensure your ads go to the right people. See docs for the allowable values. https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#action-source
	ActionSource string      `json:"action_source"`
	UserData     *UserData   `json:"user_data"`
	CustomData   *CustomData `json:"custom_data,omitempty"`
	// Processing options you would like to enable for a specific event. For more details see: https://developers.facebook.com/docs/marketing-apis/data-processing-options.
	DataProcessingOptions []string `json:"data_processing_options,omitempty"`
	// The country that you want to associate to this data processing option. If you set a country, you must also set a state. For more details see: https://developers.facebook.com/docs/marketing-apis/data-processing-options
	DataProcessingOptionsCountry int32 `json:"data_processing_options_country,omitempty"`
	// The state that you want to associate with this data processing option. For more details see: https://developers.facebook.com/docs/marketing-apis/data-processing-options.
	DataProcessingOptionsState int32 `json:"data_processing_options_state,omitempty"`
}

type EventRequest struct {
	// An array of Server Event objects.
	Data []Event `json:"data"`
	// Code used to verify that your server events are received correctly by Facebook. Use this code to test your server events in the Test Events feature in Events Manager. See Test Events Tool (https://developers.facebook.com/docs/marketing-api/conversions-api/using-the-api#testEvents) for an example.
	TestEventCode string `json:"test_event_code,omitempty"`
	// Partner agent string.
	PartnerAgent string `json:"partner_agent"`
}

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

type ResponseError struct {
	Error_ *ResponseErrorError `json:"error,omitempty"`
}

type ResponseErrorError struct {
	Code           string `json:"code,omitempty"`
	Messages       string `json:"messages,omitempty"`
	Type_          string `json:"type,omitempty"`
	FbtraceId      string `json:"fbtrace_id,omitempty"`
	ErrorSubcode   string `json:"error_subcode,omitempty"`
	IsTransient    string `json:"is_transient,omitempty"`
	ErrorUserTitle string `json:"error_user_title,omitempty"`
	ErrorUserMsg   string `json:"error_user_msg,omitempty"`
}

type ResponseSuccess struct {
	EventsReceived int32    `json:"events_received,omitempty"`
	Messages       []string `json:"messages,omitempty"`
	FbtraceId      string   `json:"fbtrace_id,omitempty"`
}

type UserData struct {
	// A hashed email address in lower case using SHA-256 algorithm.
	Em string `json:"em,omitempty"`
	// A hashed phone number using SHA-256 algorithm. Include only digits with country code, area code, and number.
	Ph string `json:"ph,omitempty"`
	// A hashed gender (f or m) using SHA-256 algorithm.
	Ge string `json:"ge,omitempty"`
	// A hashed date of birth given as year, month, and day using SHA-256 algorithm
	Db string `json:"db,omitempty"`
	// A hashed last name in lowercase using SHA-256 algorithm.
	Ln string `json:"ln,omitempty"`
	// A hashed first name in lowercase using SHA-256 algorithm.
	Fn string `json:"fn,omitempty"`
	// A hashed city in lower-case without spaces or punctuation using SHA-256 algorithm.
	Ct string `json:"ct,omitempty"`
	// A hashed two-letter country code in lowercase using SHA-256 algorithm.
	Country string `json:"country,omitempty"`
	// A hashed two-letter state code in lowercase using SHA-256 algorithm.
	St string `json:"st,omitempty"`
	// A hashed zip code using SHA-256 algorithm. If you are in the United States, this is a five-digit zip code. For other locations, follow each country's standards.
	Zp string `json:"zp,omitempty"`
	// Any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. If External ID is being sent via other channels, it should be sent in the same format via Conversions API. Hashing external_id using SHA-256 algorithm is optional.
	ExternalId string `json:"external_id,omitempty"`
	// The IP address of the browser corresponding to the event.
	ClientIpAddress string `json:"client_ip_address,omitempty"`
	// The user agent for the browser corresponding to the event.
	ClientUserAgent string `json:"client_user_agent,omitempty"`
	// The Facebook click ID value stored in the _fbc browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc), or generate this value from a fbclid query parameter.
	Fbc string `json:"fbc,omitempty"`
	// The Facebook browser ID value stored in the _fbp browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc).
	Fbp string `json:"fbp,omitempty"`
	// The subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
	SubscriptionId string `json:"subscription_id,omitempty"`
	// Do not hash. The ID issued by Facebook when a person first logs into an instance of an app. This is also known as App-Scoped ID.
	FbLoginId int64 `json:"fb_login_id,omitempty"`
}