pinterest_sdk 1.0.0

data/docs/AdGroupResponse.md

@@ -0,0 +1,62 @@
+# PinterestSdkClient::AdGroupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Ad group name. | [optional] |
+| **status** | [**EntityStatus**](EntityStatus.md) | Ad group/entity status. | [optional] |
+| **budget_in_micro_currency** | **Integer** | Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns.  A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups. | [optional] |
+| **bid_in_micro_currency** | **Integer** | Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC. | [optional] |
+| **budget_type** | **String** | Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the end_time parameter is **REQUIRED**, and the ad group spend is spread evenly between the ad group `start_time` and `end_time` range. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. | [optional] |
+| **start_time** | **Integer** | Ad group start time. Unix timestamp in seconds. Defaults to current time. | [optional] |
+| **end_time** | **Integer** | Ad group end time. Unix timestamp in seconds. | [optional] |
+| **targeting_spec** | **Hash<String, Array<String>>** | Ad group targeting specification defining the ad group target audience. For example, '{\"APPTYPE\":[\"iphone\"], \"GENDER\":[\"male\"], \"LOCALE\":[\"en-US\"], \"LOCATION\":[\"501\"], \"AGE_BUCKET\":[\"25-34\"]}' | [optional] |
+| **lifetime_frequency_cap** | **Integer** | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions))  ad groups. A CPM ad group has an IMPRESSION <a href=\\\"/docs/redoc/#section/Billable-event\\\">billable_event</a> value. This field **REQUIRES** the `end_time` field. | [optional] |
+| **tracking_urls** | [**TrackingUrls**](TrackingUrls.md) | Third-party tracking URLs.<br> JSON object with the format: {\"<a href=\"https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\">Tracking event enum</a>\":[URL string array],...}<br> For example: {\"impression\": [\"URL1\", \"URL2\"], \"click\": [\"URL1\", \"URL2\", \"URL3\"]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=\"https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=\"_blank\">Third-party and dynamic tracking</a>. | [optional] |
+| **auto_targeting_enabled** | **Boolean** | Enable auto-targeting for ad group. Also known as <a href=\"https://help.pinterest.com/en/business/article/expanded-targeting\" target=\"_blank\">\"expanded targeting\"</a>. | [optional] |
+| **placement_group** | [**PlacementGroupType**](PlacementGroupType.md) | <a href=\\\"/docs/redoc/#section/Placement-group\\\">Placement group</a>. | [optional] |
+| **pacing_delivery_type** | [**PacingDeliveryType**](PacingDeliveryType.md) | Pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day. | [optional] |
+| **conversion_learning_mode_type** | **String** | oCPM learn mode | [optional] |
+| **summary_status** | [**AdGroupSummaryStatus**](AdGroupSummaryStatus.md) | Ad group summary status. | [optional] |
+| **feed_profile_id** | **String** | Feed Profile ID associated to the adgroup. | [optional] |
+| **campaign_id** | **String** | Campaign ID of the ad group. | [optional] |
+| **billable_event** | [**ActionType**](ActionType.md) |  | [optional] |
+| **id** | **String** | Ad group ID. | [optional] |
+| **type** | **String** | Always \"adgroup\". | [optional] |
+| **ad_account_id** | **String** | Advertiser ID. | [optional] |
+| **created_time** | **Integer** | Ad group creation time. Unix timestamp in seconds. | [optional] |
+| **updated_time** | **Integer** | Ad group last update time. Unix timestamp in seconds. | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdGroupResponse.new(
+  name: Ad Group For Pin: 687195905986,
+  status: null,
+  budget_in_micro_currency: 5000000,
+  bid_in_micro_currency: 5000000,
+  budget_type: null,
+  start_time: 5686848000,
+  end_time: 5705424000,
+  targeting_spec: null,
+  lifetime_frequency_cap: 100,
+  tracking_urls: null,
+  auto_targeting_enabled: true,
+  placement_group: null,
+  pacing_delivery_type: null,
+  conversion_learning_mode_type: ACTIVE,
+  summary_status: null,
+  feed_profile_id: 626736533506,
+  campaign_id: 626736533506,
+  billable_event: null,
+  id: 2680060704746,
+  type: null,
+  ad_account_id: 549755885175,
+  created_time: 1476477189,
+  updated_time: 1476477189
+)
+```
+

data/docs/AdGroupResponseAllOf.md

@@ -0,0 +1,48 @@
+# PinterestSdkClient::AdGroupResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Ad group name. | [optional] |
+| **status** | [**EntityStatus**](EntityStatus.md) | Ad group/entity status. | [optional] |
+| **budget_in_micro_currency** | **Integer** | Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns.  A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups. | [optional] |
+| **bid_in_micro_currency** | **Integer** | Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC. | [optional] |
+| **budget_type** | **String** | Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the end_time parameter is **REQUIRED**, and the ad group spend is spread evenly between the ad group `start_time` and `end_time` range. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. | [optional] |
+| **start_time** | **Integer** | Ad group start time. Unix timestamp in seconds. Defaults to current time. | [optional] |
+| **end_time** | **Integer** | Ad group end time. Unix timestamp in seconds. | [optional] |
+| **targeting_spec** | **Hash<String, Array<String>>** | Ad group targeting specification defining the ad group target audience. For example, '{\"APPTYPE\":[\"iphone\"], \"GENDER\":[\"male\"], \"LOCALE\":[\"en-US\"], \"LOCATION\":[\"501\"], \"AGE_BUCKET\":[\"25-34\"]}' | [optional] |
+| **lifetime_frequency_cap** | **Integer** | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions))  ad groups. A CPM ad group has an IMPRESSION <a href=\\\"/docs/redoc/#section/Billable-event\\\">billable_event</a> value. This field **REQUIRES** the `end_time` field. | [optional] |
+| **tracking_urls** | [**TrackingUrls**](TrackingUrls.md) | Third-party tracking URLs.<br> JSON object with the format: {\"<a href=\"https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\">Tracking event enum</a>\":[URL string array],...}<br> For example: {\"impression\": [\"URL1\", \"URL2\"], \"click\": [\"URL1\", \"URL2\", \"URL3\"]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=\"https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=\"_blank\">Third-party and dynamic tracking</a>. | [optional] |
+| **auto_targeting_enabled** | **Boolean** | Enable auto-targeting for ad group. Also known as <a href=\"https://help.pinterest.com/en/business/article/expanded-targeting\" target=\"_blank\">\"expanded targeting\"</a>. | [optional] |
+| **placement_group** | [**PlacementGroupType**](PlacementGroupType.md) | <a href=\\\"/docs/redoc/#section/Placement-group\\\">Placement group</a>. | [optional] |
+| **pacing_delivery_type** | [**PacingDeliveryType**](PacingDeliveryType.md) | Pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day. | [optional] |
+| **conversion_learning_mode_type** | **String** | oCPM learn mode | [optional] |
+| **summary_status** | [**AdGroupSummaryStatus**](AdGroupSummaryStatus.md) | Ad group summary status. | [optional] |
+| **feed_profile_id** | **String** | Feed Profile ID associated to the adgroup. | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdGroupResponseAllOf.new(
+  name: Ad Group For Pin: 687195905986,
+  status: null,
+  budget_in_micro_currency: 5000000,
+  bid_in_micro_currency: 5000000,
+  budget_type: null,
+  start_time: 5686848000,
+  end_time: 5705424000,
+  targeting_spec: null,
+  lifetime_frequency_cap: 100,
+  tracking_urls: null,
+  auto_targeting_enabled: true,
+  placement_group: null,
+  pacing_delivery_type: null,
+  conversion_learning_mode_type: ACTIVE,
+  summary_status: null,
+  feed_profile_id: 626736533506
+)
+```
+

data/docs/AdGroupResponseAllOf1.md

@@ -0,0 +1,30 @@
+# PinterestSdkClient::AdGroupResponseAllOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign_id** | **String** | Campaign ID of the ad group. | [optional] |
+| **billable_event** | [**ActionType**](ActionType.md) |  | [optional] |
+| **id** | **String** | Ad group ID. | [optional] |
+| **type** | **String** | Always \"adgroup\". | [optional] |
+| **ad_account_id** | **String** | Advertiser ID. | [optional] |
+| **created_time** | **Integer** | Ad group creation time. Unix timestamp in seconds. | [optional] |
+| **updated_time** | **Integer** | Ad group last update time. Unix timestamp in seconds. | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdGroupResponseAllOf1.new(
+  campaign_id: 626736533506,
+  billable_event: null,
+  id: 2680060704746,
+  type: null,
+  ad_account_id: 549755885175,
+  created_time: 1476477189,
+  updated_time: 1476477189
+)
+```
+

data/docs/AdGroupSummaryStatus.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::AdGroupSummaryStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdGroupSummaryStatus.new()
+```
+

data/docs/AdResponse.md

@@ -0,0 +1,70 @@
+# PinterestSdkClient::AdResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_group_id** | **String** | ID of the ad group that contains the ad. | [optional] |
+| **android_deep_link** | **String** | Deep link URL for Android devices. Not currently available. Using this field will generate an error. | [optional] |
+| **carousel_android_deep_links** | **Array<String>** | Comma-separated deep links for the carousel pin on Android. | [optional] |
+| **carousel_destination_urls** | **Array<String>** | Comma-separated destination URLs for the carousel pin to promote. | [optional] |
+| **carousel_ios_deep_links** | **Array<String>** | Comma-separated deep links for the carousel pin on iOS. | [optional] |
+| **click_tracking_url** | **String** | Tracking url for the ad clicks. | [optional] |
+| **creative_type** | **String** | Ad creative type enum | [optional] |
+| **destination_url** | **String** | Destination URL. | [optional] |
+| **ios_deep_link** | **String** | Deep link URL for iOS devices. Not currently available. Using this field will generate an error. | [optional] |
+| **is_pin_deleted** | **Boolean** | Is original pin deleted? | [optional] |
+| **is_removable** | **Boolean** | Is pin repinnable? | [optional] |
+| **name** | **String** | Name of the ad - 255 chars max. | [optional] |
+| **pin_id** | **String** | Pin ID. | [optional] |
+| **status** | [**EntityStatus**](EntityStatus.md) |  | [optional] |
+| **tracking_urls** | [**TrackingUrls**](TrackingUrls.md) |  | [optional] |
+| **view_tracking_url** | **String** | Tracking URL for ad impressions. | [optional] |
+| **ad_account_id** | **String** | The ID of the advertiser that this ad belongs to. | [optional] |
+| **campaign_id** | **String** | ID of the ad campaign that contains this ad. | [optional] |
+| **collection_items_destination_url_template** | **String** | Destination URL template for all items within a collections drawer. | [optional] |
+| **created_time** | **Integer** | Pin creation time. Unix timestamp in seconds. | [optional] |
+| **id** | **String** | The ID of this ad. | [optional] |
+| **rejected_reasons** | **Array<String>** | Enum reason why the pin was rejected. Returned if <code>review_status</code> is \"REJECTED\". | [optional] |
+| **rejection_labels** | **Array<String>** | Text reason why the pin was rejected. Returned if <code>review_status</code> is \"REJECTED\". | [optional] |
+| **review_status** | **String** | Ad review status | [optional] |
+| **type** | **String** | Always \"ad\". | [optional] |
+| **updated_time** | **Integer** | Last update time. Unix timestamp in seconds. | [optional] |
+| **summary_status** | [**PinPromotionSummaryStatus**](PinPromotionSummaryStatus.md) | Ad summary status | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdResponse.new(
+  ad_group_id: 2680059592705,
+  android_deep_link: null,
+  carousel_android_deep_links: null,
+  carousel_destination_urls: null,
+  carousel_ios_deep_links: null,
+  click_tracking_url: null,
+  creative_type: REGULAR,
+  destination_url: null,
+  ios_deep_link: null,
+  is_pin_deleted: false,
+  is_removable: false,
+  name: null,
+  pin_id: 394205773611545468,
+  status: null,
+  tracking_urls: null,
+  view_tracking_url: null,
+  ad_account_id: 549755885175,
+  campaign_id: 626735565838,
+  collection_items_destination_url_template: null,
+  created_time: 1451431341,
+  id: 687195134316,
+  rejected_reasons: null,
+  rejection_labels: null,
+  review_status: PENDING,
+  type: pinpromotion,
+  updated_time: 1451431341,
+  summary_status: null
+)
+```
+

data/docs/AdResponseAllOf.md

@@ -0,0 +1,48 @@
+# PinterestSdkClient::AdResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_group_id** | **String** | ID of the ad group that contains the ad. | [optional] |
+| **android_deep_link** | **String** | Deep link URL for Android devices. Not currently available. Using this field will generate an error. | [optional] |
+| **carousel_android_deep_links** | **Array<String>** | Comma-separated deep links for the carousel pin on Android. | [optional] |
+| **carousel_destination_urls** | **Array<String>** | Comma-separated destination URLs for the carousel pin to promote. | [optional] |
+| **carousel_ios_deep_links** | **Array<String>** | Comma-separated deep links for the carousel pin on iOS. | [optional] |
+| **click_tracking_url** | **String** | Tracking url for the ad clicks. | [optional] |
+| **creative_type** | **String** | Ad creative type enum | [optional] |
+| **destination_url** | **String** | Destination URL. | [optional] |
+| **ios_deep_link** | **String** | Deep link URL for iOS devices. Not currently available. Using this field will generate an error. | [optional] |
+| **is_pin_deleted** | **Boolean** | Is original pin deleted? | [optional] |
+| **is_removable** | **Boolean** | Is pin repinnable? | [optional] |
+| **name** | **String** | Name of the ad - 255 chars max. | [optional] |
+| **pin_id** | **String** | Pin ID. | [optional] |
+| **status** | [**EntityStatus**](EntityStatus.md) |  | [optional] |
+| **tracking_urls** | [**TrackingUrls**](TrackingUrls.md) |  | [optional] |
+| **view_tracking_url** | **String** | Tracking URL for ad impressions. | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdResponseAllOf.new(
+  ad_group_id: 2680059592705,
+  android_deep_link: null,
+  carousel_android_deep_links: null,
+  carousel_destination_urls: null,
+  carousel_ios_deep_links: null,
+  click_tracking_url: null,
+  creative_type: REGULAR,
+  destination_url: null,
+  ios_deep_link: null,
+  is_pin_deleted: false,
+  is_removable: false,
+  name: null,
+  pin_id: 394205773611545468,
+  status: null,
+  tracking_urls: null,
+  view_tracking_url: null
+)
+```
+

data/docs/AdResponseAllOf1.md

@@ -0,0 +1,38 @@
+# PinterestSdkClient::AdResponseAllOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** | The ID of the advertiser that this ad belongs to. | [optional] |
+| **campaign_id** | **String** | ID of the ad campaign that contains this ad. | [optional] |
+| **collection_items_destination_url_template** | **String** | Destination URL template for all items within a collections drawer. | [optional] |
+| **created_time** | **Integer** | Pin creation time. Unix timestamp in seconds. | [optional] |
+| **id** | **String** | The ID of this ad. | [optional] |
+| **rejected_reasons** | **Array<String>** | Enum reason why the pin was rejected. Returned if <code>review_status</code> is \"REJECTED\". | [optional] |
+| **rejection_labels** | **Array<String>** | Text reason why the pin was rejected. Returned if <code>review_status</code> is \"REJECTED\". | [optional] |
+| **review_status** | **String** | Ad review status | [optional] |
+| **type** | **String** | Always \"ad\". | [optional] |
+| **updated_time** | **Integer** | Last update time. Unix timestamp in seconds. | [optional] |
+| **summary_status** | [**PinPromotionSummaryStatus**](PinPromotionSummaryStatus.md) | Ad summary status | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdResponseAllOf1.new(
+  ad_account_id: 549755885175,
+  campaign_id: 626735565838,
+  collection_items_destination_url_template: null,
+  created_time: 1451431341,
+  id: 687195134316,
+  rejected_reasons: null,
+  rejection_labels: null,
+  review_status: PENDING,
+  type: pinpromotion,
+  updated_time: 1451431341,
+  summary_status: null
+)
+```
+

data/docs/AdsAnalyticsCreateAsyncRequest.md

@@ -0,0 +1,62 @@
+# PinterestSdkClient::AdsAnalyticsCreateAsyncRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **String** | Metric report start date (UTC). Format: YYYY-MM-DD |  |
+| **end_date** | **String** | Metric report end date (UTC). Format: YYYY-MM-DD |  |
+| **granularity** | [**Granularity**](Granularity.md) | TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly |  |
+| **click_window_days** | [**ConversionAttributionWindowDays**](ConversionAttributionWindowDays.md) | Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. | [optional][default to 30] |
+| **engagement_window_days** | [**ConversionAttributionWindowDays**](ConversionAttributionWindowDays.md) | Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. | [optional][default to 30] |
+| **view_window_days** | [**ConversionAttributionWindowDays**](ConversionAttributionWindowDays.md) | Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. | [optional][default to 1] |
+| **conversion_report_time** | [**ConversionReportTimeType**](ConversionReportTimeType.md) | The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. | [optional][default to 'TIME_OF_AD_ACTION'] |
+| **attribution_types** | [**Array<ConversionReportAttributionType>**](ConversionReportAttributionType.md) | List of types of attribution for the conversion report | [optional] |
+| **columns** | [**Array<ReportingColumnAsync>**](ReportingColumnAsync.md) | Metric and entity columns |  |
+| **level** | [**MetricsReportingLevel**](MetricsReportingLevel.md) | Level of the report |  |
+| **report_format** | [**DataOutputFormat**](DataOutputFormat.md) | Specification for formatting report data | [optional][default to 'JSON'] |
+| **campaign_ids** | **Array<String>** | List of campaign ids | [optional] |
+| **campaign_statuses** | [**Array<CampaignSummaryStatus>**](CampaignSummaryStatus.md) | List of status values for filtering | [optional] |
+| **campaign_objective_types** | [**Array<ObjectiveType>**](ObjectiveType.md) | List of values for filtering | [optional] |
+| **ad_group_ids** | **Array<String>** | List of ad group ids | [optional] |
+| **ad_group_statuses** | [**Array<AdGroupSummaryStatus>**](AdGroupSummaryStatus.md) | List of values for filtering | [optional] |
+| **ad_ids** | **Array<String>** | List of ad ids | [optional] |
+| **ad_statuses** | [**Array<PinPromotionSummaryStatus>**](PinPromotionSummaryStatus.md) | List of values for filtering | [optional] |
+| **product_group_ids** | **Array<String>** | List of product group ids | [optional] |
+| **product_group_statuses** | [**Array<ProductGroupSummaryStatus>**](ProductGroupSummaryStatus.md) | List of values for filtering | [optional] |
+| **product_item_ids** | **Array<String>** | List of product item ids | [optional] |
+| **targeting_types** | [**Array<AdsAnalyticsTargetingType>**](AdsAnalyticsTargetingType.md) | List of targeting types | [optional] |
+| **metrics_filters** | [**Array<AdsAnalyticsMetricsFilter>**](AdsAnalyticsMetricsFilter.md) | List of metrics filters | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsCreateAsyncRequest.new(
+  start_date: 2020-12-20,
+  end_date: 2020-12-20,
+  granularity: null,
+  click_window_days: null,
+  engagement_window_days: null,
+  view_window_days: null,
+  conversion_report_time: null,
+  attribution_types: null,
+  columns: null,
+  level: CAMPAIGN,
+  report_format: null,
+  campaign_ids: ["12345678"],
+  campaign_statuses: ["RUNNING","PAUSED"],
+  campaign_objective_types: ["AWARENESS","VIDEO_VIEW"],
+  ad_group_ids: ["12345678"],
+  ad_group_statuses: ["RUNNING","PAUSED"],
+  ad_ids: ["12345678"],
+  ad_statuses: ["APPROVED","PAUSED"],
+  product_group_ids: ["12345678"],
+  product_group_statuses: ["RUNNING","PAUSED"],
+  product_item_ids: ["12345678"],
+  targeting_types: null,
+  metrics_filters: null
+)
+```
+

data/docs/AdsAnalyticsCreateAsyncRequestAllOf.md

@@ -0,0 +1,32 @@
+# PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **String** | Metric report start date (UTC). Format: YYYY-MM-DD |  |
+| **end_date** | **String** | Metric report end date (UTC). Format: YYYY-MM-DD |  |
+| **granularity** | [**Granularity**](Granularity.md) | TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly |  |
+| **click_window_days** | [**ConversionAttributionWindowDays**](ConversionAttributionWindowDays.md) | Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. | [optional][default to 30] |
+| **engagement_window_days** | [**ConversionAttributionWindowDays**](ConversionAttributionWindowDays.md) | Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. | [optional][default to 30] |
+| **view_window_days** | [**ConversionAttributionWindowDays**](ConversionAttributionWindowDays.md) | Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. | [optional][default to 1] |
+| **conversion_report_time** | [**ConversionReportTimeType**](ConversionReportTimeType.md) | The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. | [optional][default to 'TIME_OF_AD_ACTION'] |
+| **attribution_types** | [**Array<ConversionReportAttributionType>**](ConversionReportAttributionType.md) | List of types of attribution for the conversion report | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf.new(
+  start_date: 2020-12-20,
+  end_date: 2020-12-20,
+  granularity: null,
+  click_window_days: null,
+  engagement_window_days: null,
+  view_window_days: null,
+  conversion_report_time: null,
+  attribution_types: null
+)
+```
+

data/docs/AdsAnalyticsCreateAsyncRequestAllOf1.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **columns** | [**Array<ReportingColumnAsync>**](ReportingColumnAsync.md) | Metric and entity columns |  |
+| **level** | [**MetricsReportingLevel**](MetricsReportingLevel.md) | Level of the report |  |
+| **report_format** | [**DataOutputFormat**](DataOutputFormat.md) | Specification for formatting report data | [optional][default to 'JSON'] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf1.new(
+  columns: null,
+  level: CAMPAIGN,
+  report_format: null
+)
+```
+

data/docs/AdsAnalyticsCreateAsyncResponse.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::AdsAnalyticsCreateAsyncResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_status** | **String** |  | [optional] |
+| **token** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsCreateAsyncResponse.new(
+  report_status: null,
+  token: null,
+  message: null
+)
+```
+

data/docs/AdsAnalyticsFilterColumn.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::AdsAnalyticsFilterColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsFilterColumn.new()
+```
+

data/docs/AdsAnalyticsFilterOperator.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::AdsAnalyticsFilterOperator
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsFilterOperator.new()
+```
+

data/docs/AdsAnalyticsGetAsyncResponse.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::AdsAnalyticsGetAsyncResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_status** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **size** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsGetAsyncResponse.new(
+  report_status: null,
+  url: null,
+  size: null
+)
+```
+

data/docs/AdsAnalyticsMetricsFilter.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::AdsAnalyticsMetricsFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**AdsAnalyticsFilterColumn**](AdsAnalyticsFilterColumn.md) |  | [optional] |
+| **operator** | [**AdsAnalyticsFilterOperator**](AdsAnalyticsFilterOperator.md) |  | [optional] |
+| **values** | **Array<Float>** | List of values for filtering | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsMetricsFilter.new(
+  field: null,
+  operator: null,
+  values: null
+)
+```
+

data/docs/AdsAnalyticsTargetingType.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::AdsAnalyticsTargetingType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AdsAnalyticsTargetingType.new()
+```
+

data/docs/AnalyticsMetricsResponse.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::AnalyticsMetricsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **daily_metrics** | [**Array<AnalyticsMetricsResponseDailyMetrics>**](AnalyticsMetricsResponseDailyMetrics.md) | Array with the requested daily metric records | [optional] |
+| **summary_metrics** | **Hash<String, Float>** | The metric name and value over the requested period for each requested metric | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AnalyticsMetricsResponse.new(
+  daily_metrics: null,
+  summary_metrics: {"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}
+)
+```
+

data/docs/AnalyticsMetricsResponseDailyMetrics.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::AnalyticsMetricsResponseDailyMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_status** | **String** | Metrics availablity, e.g., \"READY\". | [optional] |
+| **date** | **String** | Metrics date (UTC): YYYY-MM-DD. | [optional] |
+| **metrics** | **Hash<String, Float>** | The metric name and daily value for each requested metric | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AnalyticsMetricsResponseDailyMetrics.new(
+  data_status: READY,
+  date: 2019-12-01,
+  metrics: {"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}
+)
+```
+

data/docs/AvailabilityFilter.md

@@ -0,0 +1,18 @@
+# PinterestSdkClient::AvailabilityFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **availability** | [**CatalogsProductGroupMultipleStringCriteria**](.md) |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::AvailabilityFilter.new(
+  availability: null
+)
+```
+

data/docs/BatchOperation.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::BatchOperation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::BatchOperation.new()
+```
+