pinterest · dfana01 · Sep 15, 2025 · Jun 18, 2025 · Sep 12, 2025 · Sep 12, 2025
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Pinterest's REST API
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 5.14.0
-- Package version: 0.1.10
+- Package version: 0.1.11
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://developers.pinterest.com/](https://developers.pinterest.com/)
 

diff --git a/docs/AdGroupIdFilter.md b/docs/AdGroupIdFilter.md
@@ -0,0 +1,12 @@
+# AdGroupIdFilter
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ad_group_ids** | **[str]** | List of ad group ids | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AdPinAnalytics.md b/docs/AdPinAnalytics.md
@@ -0,0 +1,13 @@
+# AdPinAnalytics
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pin_id** | **str** | The ID of the pin that the metric belongs to. | 
+**date** | **date** | Current metrics date. Only returned when granularity is a time-based value (&#x60;DAY&#x60;, &#x60;HOUR&#x60;, &#x60;WEEK&#x60;, &#x60;MONTH&#x60;) | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AdPinsAnalyticsResponse.md b/docs/AdPinsAnalyticsResponse.md
@@ -0,0 +1,11 @@
+# AdPinsAnalyticsResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**[AdPinAnalytics]**](AdPinAnalytics.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AdPreviewShopping.md b/docs/AdPreviewShopping.md
@@ -0,0 +1,21 @@
+# AdPreviewShopping
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalog_product_group_id** | **str** | Catalog Product Group Id. | 
+**creative_type** | **str** | Ad format of the shopping ad preview. | 
+**customizable_cta_type** | [**CustomizableCtaType**](CustomizableCtaType.md) |  | [optional] 
+**image_tag** | **str** | Multi image template tag. | [optional] 
+**video_tag** | **str** | Multi video template tag, image_tag and video_tag are mutual exclusive. | [optional] 
+**preferred_media_type** | **str** | Preferred media type. | [optional] 
+**hero_pin_id** | **str** | Pin id for the hero image. When creative type is COLLECTION, either hero_pin_id or (hero_image_url, hero_image_title) is required. | [optional] 
+**hero_image_url** | **str** | Hero image URL. | [optional] 
+**hero_image_title** | **str** | Title displayed below ad. | [optional] 
+**item_id** | **str** | Item id for product to preview standard shopping ads, optional and only applicable when creative type is SHOPPING. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AdsAnalyticsAdGroupTargetingType.md b/docs/AdsAnalyticsAdGroupTargetingType.md
@@ -0,0 +1,12 @@
+# AdsAnalyticsAdGroupTargetingType
+
+Reporting targeting type for ad groups
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | Reporting targeting type for ad groups |  must be one of ["KEYWORD", "APPTYPE", "GENDER", "LOCATION", "PLACEMENT", "COUNTRY", "TARGETED_INTEREST", "PINNER_INTEREST", "AUDIENCE_INCLUDE", "GEO", "AGE_BUCKET", "REGION", "AGE_BUCKET_AND_GENDER", "CREATIVE_ENHANCEMENTS", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AllOf.md b/docs/AllOf.md
@@ -0,0 +1,12 @@
+# AllOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**all_of** | [**[CatalogsProductGroupFilterKeys]**](CatalogsProductGroupFilterKeys.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AnyOf.md b/docs/AnyOf.md
@@ -0,0 +1,12 @@
+# AnyOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**any_of** | [**[CatalogsProductGroupFilterKeys]**](CatalogsProductGroupFilterKeys.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AudienceDefinitionScope.md b/docs/AudienceDefinitionScope.md
@@ -0,0 +1,13 @@
+# AudienceDefinitionScope
+
+Generated audience scope to request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scope** | **str** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/AudienceDefinitionType.md b/docs/AudienceDefinitionType.md
@@ -0,0 +1,13 @@
+# AudienceDefinitionType
+
+Generated audience type to request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scope** | **str** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/BillingInvoiceDownloadResponse.md b/docs/BillingInvoiceDownloadResponse.md
@@ -0,0 +1,13 @@
+# BillingInvoiceDownloadResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | The billing invoice id | [optional] 
+**download_url** | **str** | The download url for the billing invoice | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/BillingInvoiceResponse.md b/docs/BillingInvoiceResponse.md
@@ -0,0 +1,26 @@
+# BillingInvoiceResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Unique identifier for the billing invoice | [optional] 
+**ad_account_id** | **str** | The ID of the ad account this invoice belongs to | [optional] 
+**ad_account_name** | **str** | The name of the ad account this invoice belongs to | [optional] 
+**document_type** | **str** | The type of the document | [optional] 
+**amount_billed_micro_currency** | **int** | The amount billed in this invoice. Denoted in micro currency | [optional] 
+**amount_tax_micro_currency** | **int, none_type** | The tax in this invoice. Denoted in micro currency | [optional] 
+**amount_net_micro_currency** | **int, none_type** | The net amount in this invoice. Denoted in micro currency | [optional] 
+**amount_discount_micro_currency** | **int, none_type** | The discount in this invoice. Denoted in micro currency | [optional] 
+**currency** | [**Currency**](Currency.md) |  | [optional] 
+**billing_period_start_date** | **date** | The start date of the billing period. Format: YYYY-MM-DD | [optional] 
+**billing_period_end_date** | **date** | The end date of the billing period. Format: YYYY-MM-DD | [optional] 
+**invoice_due_date** | **date** | The date the invoice is due. Format: YYYY-MM-DD | [optional] 
+**status** | **str** | The status of the invoice | [optional] 
+**payment_terms** | **str** | The payment terms of the invoice | [optional] 
+**bill_to_country** | **str** | The country of the bill to address | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignAudienceMultipliers.md b/docs/CampaignAudienceMultipliers.md
@@ -0,0 +1,13 @@
+# CampaignAudienceMultipliers
+
+This represents a mapping from Audience ID to a bid price adjustment.  Multiplier values must be between 0 and 10. A value of 10 represents a 900% increase in bid price (from $1 to $10 for example). A value of 0 will stop distribution for this item on the specified audience in `MAX_BID` ad groups in `CATALOG_SALES` campaigns. All audience multipliers must be set at the same time. If a multiplier is not provided it is assumed to be 1 (no bid adjustment).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audience_id** | **str** |  | [optional] 
+**any string name** | **float** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignBidOptions.md b/docs/CampaignBidOptions.md
@@ -0,0 +1,15 @@
+# CampaignBidOptions
+
+Object describing the campaign level bid multipliers.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audience_multipliers** | [**CampaignAudienceMultipliers**](CampaignAudienceMultipliers.md) |  | [optional] 
+**app_type_multipliers** | [**AppTypeMultipliers**](AppTypeMultipliers.md) |  | [optional] 
+**placement_multipliers** | [**PlacementMultipliers**](PlacementMultipliers.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignBidOptionsCreate.md b/docs/CampaignBidOptionsCreate.md
@@ -0,0 +1,15 @@
+# CampaignBidOptionsCreate
+
+Object describing the campaign level bid multipliers.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audience_multipliers** | [**CampaignAudienceMultipliers**](CampaignAudienceMultipliers.md) |  | [optional] 
+**app_type_multipliers** | [**AppTypeMultipliers**](AppTypeMultipliers.md) |  | [optional] 
+**placement_multipliers** | [**PlacementMultipliers**](PlacementMultipliers.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignBidOptionsUpdate.md b/docs/CampaignBidOptionsUpdate.md
@@ -0,0 +1,16 @@
+# CampaignBidOptionsUpdate
+
+Object describing an update to the campaign level bid multipliers.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**update_mask** | **[str]** | List of fields to update, only the fields in the list will be updated. | 
+**audience_multipliers** | [**CampaignAudienceMultipliers**](CampaignAudienceMultipliers.md) |  | [optional] 
+**app_type_multipliers** | [**AppTypeMultipliers**](AppTypeMultipliers.md) |  | [optional] 
+**placement_multipliers** | [**PlacementMultipliers**](PlacementMultipliers.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignBidOptionsUpdateAllOf.md b/docs/CampaignBidOptionsUpdateAllOf.md
@@ -0,0 +1,12 @@
+# CampaignBidOptionsUpdateAllOf
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**update_mask** | **[str]** | List of fields to update, only the fields in the list will be updated. | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignIdFilter.md b/docs/CampaignIdFilter.md
@@ -0,0 +1,12 @@
+# CampaignIdFilter
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_ids** | **[str]** | List of campaign ids | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CampaignObjectivesFilter.md b/docs/CampaignObjectivesFilter.md
@@ -0,0 +1,12 @@
+# CampaignObjectivesFilter
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_objective_types** | [**[ObjectiveType]**](ObjectiveType.md) | List of values for filtering. [\&quot;WEB_SESSIONS\&quot;] in BETA. | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsAvailableFilterValues.md b/docs/CatalogsAvailableFilterValues.md
@@ -0,0 +1,14 @@
+# CatalogsAvailableFilterValues
+
+Object holding available filter values for each filter key
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalog_type** | **str** |  | defaults to "CREATIVE_ASSETS"
+**filter_values** | [**CatalogsCreativeAssetsFilterValuesMap**](CatalogsCreativeAssetsFilterValuesMap.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsCreativeAssetsAvailableFilterValues.md b/docs/CatalogsCreativeAssetsAvailableFilterValues.md
@@ -0,0 +1,13 @@
+# CatalogsCreativeAssetsAvailableFilterValues
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter_values** | [**CatalogsCreativeAssetsFilterValuesMap**](CatalogsCreativeAssetsFilterValuesMap.md) |  | 
+**catalog_type** | **str** |  | defaults to "CREATIVE_ASSETS"
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsCreativeAssetsFilterValuesMap.md b/docs/CatalogsCreativeAssetsFilterValuesMap.md
@@ -0,0 +1,25 @@
+# CatalogsCreativeAssetsFilterValuesMap
+
+A map of filter attributes to their available values.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**custom_label_0** | **[str]** |  | [optional] 
+**custom_label_1** | **[str]** |  | [optional] 
+**custom_label_2** | **[str]** |  | [optional] 
+**custom_label_3** | **[str]** |  | [optional] 
+**custom_label_4** | **[str]** |  | [optional] 
+**google_product_category_0** | **[str]** |  | [optional] 
+**google_product_category_1** | **[str]** |  | [optional] 
+**google_product_category_2** | **[str]** |  | [optional] 
+**google_product_category_3** | **[str]** |  | [optional] 
+**google_product_category_4** | **[str]** |  | [optional] 
+**google_product_category_5** | **[str]** |  | [optional] 
+**google_product_category_6** | **[str]** |  | [optional] 
+**media_type** | **[str]** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsHotelAvailableFilterValues.md b/docs/CatalogsHotelAvailableFilterValues.md
@@ -0,0 +1,13 @@
+# CatalogsHotelAvailableFilterValues
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter_values** | [**CatalogsHotelFilterValuesMap**](CatalogsHotelFilterValuesMap.md) |  | 
+**catalog_type** | **str** |  | defaults to "HOTEL"
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsHotelFilterValuesMap.md b/docs/CatalogsHotelFilterValuesMap.md
@@ -0,0 +1,18 @@
+# CatalogsHotelFilterValuesMap
+
+A map of filter attributes to their available values.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**brand** | **[str]** |  | [optional] 
+**custom_label_0** | **[str]** |  | [optional] 
+**custom_label_1** | **[str]** |  | [optional] 
+**custom_label_2** | **[str]** |  | [optional] 
+**custom_label_3** | **[str]** |  | [optional] 
+**custom_label_4** | **[str]** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsHotelProductGroupType.md b/docs/CatalogsHotelProductGroupType.md
@@ -0,0 +1,12 @@
+# CatalogsHotelProductGroupType
+
+<p>Catalog hotel product group type</p> <p>MERCHANT_CREATED: Product groups created by merchants. <br>ALL_LISTINGS: Includes every hotel item in your catalog.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | &lt;p&gt;Catalog hotel product group type&lt;/p&gt; &lt;p&gt;MERCHANT_CREATED: Product groups created by merchants. &lt;br&gt;ALL_LISTINGS: Includes every hotel item in your catalog. |  must be one of ["MERCHANT_CREATED", "ALL_LISTINGS", ]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/CatalogsHotelReportStatsParameters.md b/docs/CatalogsHotelReportStatsParameters.md
@@ -0,0 +1,14 @@
+# CatalogsHotelReportStatsParameters
+
+Parameters for hotel report
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** |  | 
+**catalog_type** | **str** |  | defaults to "HOTEL"
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+