# pinterest_sdk

PinterestSdkClient - the Ruby gem for the Pinterest REST API

Pinterest's REST API

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 5.3.0
- Package version: 1.1.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
For more information, please visit [https://github.com/cliffano/pinterest-sdk](https://github.com/cliffano/pinterest-sdk)

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build pinterest_sdk.gemspec
```

Then either install the gem locally:

```shell
gem install ./pinterest_sdk-1.1.0.gem
```

(for development, run `gem install --dev ./pinterest_sdk-1.1.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'pinterest_sdk', '~> 1.1.0'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

    gem 'pinterest_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby
# Load the gem
require 'pinterest_sdk'

# Setup authorization
PinterestSdkClient.configure do |config|
  # Configure OAuth2 access token for authorization: pinterest_oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = PinterestSdkClient::AdAccountsApi.new
ad_account_id = 'ad_account_id_example' # String | Unique identifier of an ad account.
start_date = Date.parse('2013-10-20') # Date | Metric report start date (UTC). Format: YYYY-MM-DD
end_date = Date.parse('2013-10-20') # Date | Metric report end date (UTC). Format: YYYY-MM-DD
columns = ['AD_ACCOUNT_ID'] # Array<String> | Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
granularity = PinterestSdkClient::Granularity::TOTAL # Granularity | Granularity
opts = {
  click_window_days: 1, # Integer | 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.
  engagement_window_days: 1, # Integer | 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.
  view_window_days: 1, # Integer | 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.
  conversion_report_time: 'TIME_OF_AD_ACTION' # String | 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.
}

begin
  #Get ad account analytics
  result = api_instance.ad_account_analytics(ad_account_id, start_date, end_date, columns, granularity, opts)
  p result
rescue PinterestSdkClient::ApiError => e
  puts "Exception when calling AdAccountsApi->ad_account_analytics: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *https://api.pinterest.com/v5*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PinterestSdkClient::AdAccountsApi* | [**ad_account_analytics**](docs/AdAccountsApi.md#ad_account_analytics) | **GET** /ad_accounts/{ad_account_id}/analytics | Get ad account analytics
*PinterestSdkClient::AdAccountsApi* | [**ad_accounts_list**](docs/AdAccountsApi.md#ad_accounts_list) | **GET** /ad_accounts | List ad accounts
*PinterestSdkClient::AdAccountsApi* | [**ad_groups_analytics**](docs/AdAccountsApi.md#ad_groups_analytics) | **GET** /ad_accounts/{ad_account_id}/ad_groups/analytics | Get ad group analytics
*PinterestSdkClient::AdAccountsApi* | [**ad_groups_list**](docs/AdAccountsApi.md#ad_groups_list) | **GET** /ad_accounts/{ad_account_id}/ad_groups | List ad groups
*PinterestSdkClient::AdAccountsApi* | [**ads_analytics**](docs/AdAccountsApi.md#ads_analytics) | **GET** /ad_accounts/{ad_account_id}/ads/analytics | Get ad analytics
*PinterestSdkClient::AdAccountsApi* | [**ads_list**](docs/AdAccountsApi.md#ads_list) | **GET** /ad_accounts/{ad_account_id}/ads | List ads
*PinterestSdkClient::AdAccountsApi* | [**analytics_create_report**](docs/AdAccountsApi.md#analytics_create_report) | **POST** /ad_accounts/{ad_account_id}/reports | Create async request for an account analytics report
*PinterestSdkClient::AdAccountsApi* | [**analytics_get_report**](docs/AdAccountsApi.md#analytics_get_report) | **GET** /ad_accounts/{ad_account_id}/reports | Get the account analytics report created by the async call
*PinterestSdkClient::AdAccountsApi* | [**campaigns_analytics**](docs/AdAccountsApi.md#campaigns_analytics) | **GET** /ad_accounts/{ad_account_id}/campaigns/analytics | Get campaign analytics
*PinterestSdkClient::AdAccountsApi* | [**campaigns_list**](docs/AdAccountsApi.md#campaigns_list) | **GET** /ad_accounts/{ad_account_id}/campaigns | List campaigns
*PinterestSdkClient::AdAccountsApi* | [**product_groups_analytics**](docs/AdAccountsApi.md#product_groups_analytics) | **GET** /ad_accounts/{ad_account_id}/product_groups/analytics | Get product group analytics
*PinterestSdkClient::BoardsApi* | [**board_sections_create**](docs/BoardsApi.md#board_sections_create) | **POST** /boards/{board_id}/sections | Create board section
*PinterestSdkClient::BoardsApi* | [**board_sections_delete**](docs/BoardsApi.md#board_sections_delete) | **DELETE** /boards/{board_id}/sections/{section_id} | Delete board section
*PinterestSdkClient::BoardsApi* | [**board_sections_list**](docs/BoardsApi.md#board_sections_list) | **GET** /boards/{board_id}/sections | List board sections
*PinterestSdkClient::BoardsApi* | [**board_sections_list_pins**](docs/BoardsApi.md#board_sections_list_pins) | **GET** /boards/{board_id}/sections/{section_id}/pins | List Pins on board section
*PinterestSdkClient::BoardsApi* | [**board_sections_update**](docs/BoardsApi.md#board_sections_update) | **PATCH** /boards/{board_id}/sections/{section_id} | Update board section
*PinterestSdkClient::BoardsApi* | [**boards_create**](docs/BoardsApi.md#boards_create) | **POST** /boards | Create board
*PinterestSdkClient::BoardsApi* | [**boards_delete**](docs/BoardsApi.md#boards_delete) | **DELETE** /boards/{board_id} | Delete board
*PinterestSdkClient::BoardsApi* | [**boards_get**](docs/BoardsApi.md#boards_get) | **GET** /boards/{board_id} | Get board
*PinterestSdkClient::BoardsApi* | [**boards_list**](docs/BoardsApi.md#boards_list) | **GET** /boards | List boards
*PinterestSdkClient::BoardsApi* | [**boards_list_pins**](docs/BoardsApi.md#boards_list_pins) | **GET** /boards/{board_id}/pins | List Pins on board
*PinterestSdkClient::BoardsApi* | [**boards_update**](docs/BoardsApi.md#boards_update) | **PATCH** /boards/{board_id} | Update board
*PinterestSdkClient::CatalogsApi* | [**catalogs_product_groups_create**](docs/CatalogsApi.md#catalogs_product_groups_create) | **POST** /catalogs/product_groups | Create product group
*PinterestSdkClient::CatalogsApi* | [**catalogs_product_groups_delete**](docs/CatalogsApi.md#catalogs_product_groups_delete) | **DELETE** /catalogs/product_groups/{product_group_id} | Delete product group
*PinterestSdkClient::CatalogsApi* | [**catalogs_product_groups_list**](docs/CatalogsApi.md#catalogs_product_groups_list) | **GET** /catalogs/product_groups | Get product groups list
*PinterestSdkClient::CatalogsApi* | [**catalogs_product_groups_update**](docs/CatalogsApi.md#catalogs_product_groups_update) | **PATCH** /catalogs/product_groups/{product_group_id} | Update product group
*PinterestSdkClient::CatalogsApi* | [**feed_processing_results_list**](docs/CatalogsApi.md#feed_processing_results_list) | **GET** /catalogs/feeds/{feed_id}/processing_results | List processing results for a given feed
*PinterestSdkClient::CatalogsApi* | [**feeds_create**](docs/CatalogsApi.md#feeds_create) | **POST** /catalogs/feeds | Create feed
*PinterestSdkClient::CatalogsApi* | [**feeds_delete**](docs/CatalogsApi.md#feeds_delete) | **DELETE** /catalogs/feeds/{feed_id} | Delete feed
*PinterestSdkClient::CatalogsApi* | [**feeds_get**](docs/CatalogsApi.md#feeds_get) | **GET** /catalogs/feeds/{feed_id} | Get feed
*PinterestSdkClient::CatalogsApi* | [**feeds_list**](docs/CatalogsApi.md#feeds_list) | **GET** /catalogs/feeds | List feeds
*PinterestSdkClient::CatalogsApi* | [**feeds_update**](docs/CatalogsApi.md#feeds_update) | **PATCH** /catalogs/feeds/{feed_id} | Update feed
*PinterestSdkClient::CatalogsApi* | [**items_batch_get**](docs/CatalogsApi.md#items_batch_get) | **GET** /catalogs/items/batch/{batch_id} | Get catalogs items batch
*PinterestSdkClient::CatalogsApi* | [**items_batch_post**](docs/CatalogsApi.md#items_batch_post) | **POST** /catalogs/items/batch | Perform an operation on an item batch
*PinterestSdkClient::CatalogsApi* | [**items_get**](docs/CatalogsApi.md#items_get) | **GET** /catalogs/items | Get catalogs items
*PinterestSdkClient::MediaApi* | [**media_create**](docs/MediaApi.md#media_create) | **POST** /media | Register media upload
*PinterestSdkClient::MediaApi* | [**media_get**](docs/MediaApi.md#media_get) | **GET** /media/{media_id} | Get media upload details
*PinterestSdkClient::MediaApi* | [**media_list**](docs/MediaApi.md#media_list) | **GET** /media | List media uploads
*PinterestSdkClient::OauthApi* | [**oauth_token**](docs/OauthApi.md#oauth_token) | **POST** /oauth/token | Generate OAuth access token
*PinterestSdkClient::PinsApi* | [**pins_analytics**](docs/PinsApi.md#pins_analytics) | **GET** /pins/{pin_id}/analytics | Get Pin analytics
*PinterestSdkClient::PinsApi* | [**pins_create**](docs/PinsApi.md#pins_create) | **POST** /pins | Create Pin
*PinterestSdkClient::PinsApi* | [**pins_delete**](docs/PinsApi.md#pins_delete) | **DELETE** /pins/{pin_id} | Delete Pin
*PinterestSdkClient::PinsApi* | [**pins_get**](docs/PinsApi.md#pins_get) | **GET** /pins/{pin_id} | Get Pin
*PinterestSdkClient::UserAccountApi* | [**user_account_analytics**](docs/UserAccountApi.md#user_account_analytics) | **GET** /user_account/analytics | Get user account analytics
*PinterestSdkClient::UserAccountApi* | [**user_account_get**](docs/UserAccountApi.md#user_account_get) | **GET** /user_account | Get user account


## Documentation for Models

 - [PinterestSdkClient::Account](docs/Account.md)
 - [PinterestSdkClient::ActionType](docs/ActionType.md)
 - [PinterestSdkClient::AdAccount](docs/AdAccount.md)
 - [PinterestSdkClient::AdAccountOwner](docs/AdAccountOwner.md)
 - [PinterestSdkClient::AdGroupResponse](docs/AdGroupResponse.md)
 - [PinterestSdkClient::AdGroupResponseAllOf](docs/AdGroupResponseAllOf.md)
 - [PinterestSdkClient::AdGroupResponseAllOf1](docs/AdGroupResponseAllOf1.md)
 - [PinterestSdkClient::AdGroupSummaryStatus](docs/AdGroupSummaryStatus.md)
 - [PinterestSdkClient::AdResponse](docs/AdResponse.md)
 - [PinterestSdkClient::AdResponseAllOf](docs/AdResponseAllOf.md)
 - [PinterestSdkClient::AdResponseAllOf1](docs/AdResponseAllOf1.md)
 - [PinterestSdkClient::AdsAnalyticsCreateAsyncRequest](docs/AdsAnalyticsCreateAsyncRequest.md)
 - [PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf](docs/AdsAnalyticsCreateAsyncRequestAllOf.md)
 - [PinterestSdkClient::AdsAnalyticsCreateAsyncRequestAllOf1](docs/AdsAnalyticsCreateAsyncRequestAllOf1.md)
 - [PinterestSdkClient::AdsAnalyticsCreateAsyncResponse](docs/AdsAnalyticsCreateAsyncResponse.md)
 - [PinterestSdkClient::AdsAnalyticsFilterColumn](docs/AdsAnalyticsFilterColumn.md)
 - [PinterestSdkClient::AdsAnalyticsFilterOperator](docs/AdsAnalyticsFilterOperator.md)
 - [PinterestSdkClient::AdsAnalyticsGetAsyncResponse](docs/AdsAnalyticsGetAsyncResponse.md)
 - [PinterestSdkClient::AdsAnalyticsMetricsFilter](docs/AdsAnalyticsMetricsFilter.md)
 - [PinterestSdkClient::AdsAnalyticsTargetingType](docs/AdsAnalyticsTargetingType.md)
 - [PinterestSdkClient::AnalyticsMetricsResponse](docs/AnalyticsMetricsResponse.md)
 - [PinterestSdkClient::AnalyticsMetricsResponseDailyMetrics](docs/AnalyticsMetricsResponseDailyMetrics.md)
 - [PinterestSdkClient::AvailabilityFilter](docs/AvailabilityFilter.md)
 - [PinterestSdkClient::BatchOperation](docs/BatchOperation.md)
 - [PinterestSdkClient::BatchOperationStatus](docs/BatchOperationStatus.md)
 - [PinterestSdkClient::Board](docs/Board.md)
 - [PinterestSdkClient::BoardOwner](docs/BoardOwner.md)
 - [PinterestSdkClient::BoardSection](docs/BoardSection.md)
 - [PinterestSdkClient::BoardUpdate](docs/BoardUpdate.md)
 - [PinterestSdkClient::BrandFilter](docs/BrandFilter.md)
 - [PinterestSdkClient::CampaignCommon](docs/CampaignCommon.md)
 - [PinterestSdkClient::CampaignResponse](docs/CampaignResponse.md)
 - [PinterestSdkClient::CampaignResponseAllOf](docs/CampaignResponseAllOf.md)
 - [PinterestSdkClient::CampaignResponseAllOf1](docs/CampaignResponseAllOf1.md)
 - [PinterestSdkClient::CampaignSummaryStatus](docs/CampaignSummaryStatus.md)
 - [PinterestSdkClient::CatalogsDbItem](docs/CatalogsDbItem.md)
 - [PinterestSdkClient::CatalogsFeed](docs/CatalogsFeed.md)
 - [PinterestSdkClient::CatalogsFeedCredentials](docs/CatalogsFeedCredentials.md)
 - [PinterestSdkClient::CatalogsFeedIngestionDetails](docs/CatalogsFeedIngestionDetails.md)
 - [PinterestSdkClient::CatalogsFeedIngestionErrors](docs/CatalogsFeedIngestionErrors.md)
 - [PinterestSdkClient::CatalogsFeedIngestionInfo](docs/CatalogsFeedIngestionInfo.md)
 - [PinterestSdkClient::CatalogsFeedProcessingResult](docs/CatalogsFeedProcessingResult.md)
 - [PinterestSdkClient::CatalogsFeedProcessingResultFields](docs/CatalogsFeedProcessingResultFields.md)
 - [PinterestSdkClient::CatalogsFeedProcessingSchedule](docs/CatalogsFeedProcessingSchedule.md)
 - [PinterestSdkClient::CatalogsFeedProcessingStatus](docs/CatalogsFeedProcessingStatus.md)
 - [PinterestSdkClient::CatalogsFeedProductCounts](docs/CatalogsFeedProductCounts.md)
 - [PinterestSdkClient::CatalogsFeedValidationDetails](docs/CatalogsFeedValidationDetails.md)
 - [PinterestSdkClient::CatalogsFeedValidationErrors](docs/CatalogsFeedValidationErrors.md)
 - [PinterestSdkClient::CatalogsFeedValidationWarnings](docs/CatalogsFeedValidationWarnings.md)
 - [PinterestSdkClient::CatalogsFeedsCreateRequest](docs/CatalogsFeedsCreateRequest.md)
 - [PinterestSdkClient::CatalogsFeedsUpdateRequest](docs/CatalogsFeedsUpdateRequest.md)
 - [PinterestSdkClient::CatalogsFormat](docs/CatalogsFormat.md)
 - [PinterestSdkClient::CatalogsItems](docs/CatalogsItems.md)
 - [PinterestSdkClient::CatalogsItemsBatch](docs/CatalogsItemsBatch.md)
 - [PinterestSdkClient::CatalogsItemsBatchRequest](docs/CatalogsItemsBatchRequest.md)
 - [PinterestSdkClient::CatalogsProductGroup](docs/CatalogsProductGroup.md)
 - [PinterestSdkClient::CatalogsProductGroupCreateRequest](docs/CatalogsProductGroupCreateRequest.md)
 - [PinterestSdkClient::CatalogsProductGroupCurrencyCriteria](docs/CatalogsProductGroupCurrencyCriteria.md)
 - [PinterestSdkClient::CatalogsProductGroupFilterKeys](docs/CatalogsProductGroupFilterKeys.md)
 - [PinterestSdkClient::CatalogsProductGroupFilters](docs/CatalogsProductGroupFilters.md)
 - [PinterestSdkClient::CatalogsProductGroupFiltersAllOf](docs/CatalogsProductGroupFiltersAllOf.md)
 - [PinterestSdkClient::CatalogsProductGroupFiltersAnyOf](docs/CatalogsProductGroupFiltersAnyOf.md)
 - [PinterestSdkClient::CatalogsProductGroupMultipleStringCriteria](docs/CatalogsProductGroupMultipleStringCriteria.md)
 - [PinterestSdkClient::CatalogsProductGroupMultipleStringListCriteria](docs/CatalogsProductGroupMultipleStringListCriteria.md)
 - [PinterestSdkClient::CatalogsProductGroupPricingCriteria](docs/CatalogsProductGroupPricingCriteria.md)
 - [PinterestSdkClient::CatalogsProductGroupStatus](docs/CatalogsProductGroupStatus.md)
 - [PinterestSdkClient::CatalogsProductGroupType](docs/CatalogsProductGroupType.md)
 - [PinterestSdkClient::CatalogsProductGroupUpdateRequest](docs/CatalogsProductGroupUpdateRequest.md)
 - [PinterestSdkClient::CatalogsStatus](docs/CatalogsStatus.md)
 - [PinterestSdkClient::ConditionFilter](docs/ConditionFilter.md)
 - [PinterestSdkClient::ConversionAttributionWindowDays](docs/ConversionAttributionWindowDays.md)
 - [PinterestSdkClient::ConversionReportAttributionType](docs/ConversionReportAttributionType.md)
 - [PinterestSdkClient::ConversionReportTimeType](docs/ConversionReportTimeType.md)
 - [PinterestSdkClient::Country](docs/Country.md)
 - [PinterestSdkClient::Currency](docs/Currency.md)
 - [PinterestSdkClient::CurrencyFilter](docs/CurrencyFilter.md)
 - [PinterestSdkClient::CustomLabel0Filter](docs/CustomLabel0Filter.md)
 - [PinterestSdkClient::CustomLabel1Filter](docs/CustomLabel1Filter.md)
 - [PinterestSdkClient::CustomLabel2Filter](docs/CustomLabel2Filter.md)
 - [PinterestSdkClient::CustomLabel3Filter](docs/CustomLabel3Filter.md)
 - [PinterestSdkClient::CustomLabel4Filter](docs/CustomLabel4Filter.md)
 - [PinterestSdkClient::DataOutputFormat](docs/DataOutputFormat.md)
 - [PinterestSdkClient::EntityStatus](docs/EntityStatus.md)
 - [PinterestSdkClient::Error](docs/Error.md)
 - [PinterestSdkClient::FeedFields](docs/FeedFields.md)
 - [PinterestSdkClient::GenderFilter](docs/GenderFilter.md)
 - [PinterestSdkClient::GoogleProductCategory0Filter](docs/GoogleProductCategory0Filter.md)
 - [PinterestSdkClient::GoogleProductCategory1Filter](docs/GoogleProductCategory1Filter.md)
 - [PinterestSdkClient::GoogleProductCategory2Filter](docs/GoogleProductCategory2Filter.md)
 - [PinterestSdkClient::GoogleProductCategory3Filter](docs/GoogleProductCategory3Filter.md)
 - [PinterestSdkClient::GoogleProductCategory4Filter](docs/GoogleProductCategory4Filter.md)
 - [PinterestSdkClient::GoogleProductCategory5Filter](docs/GoogleProductCategory5Filter.md)
 - [PinterestSdkClient::GoogleProductCategory6Filter](docs/GoogleProductCategory6Filter.md)
 - [PinterestSdkClient::Granularity](docs/Granularity.md)
 - [PinterestSdkClient::ImageDetails](docs/ImageDetails.md)
 - [PinterestSdkClient::ItemAttributes](docs/ItemAttributes.md)
 - [PinterestSdkClient::ItemBatchRecord](docs/ItemBatchRecord.md)
 - [PinterestSdkClient::ItemGroupIdFilter](docs/ItemGroupIdFilter.md)
 - [PinterestSdkClient::ItemIdFilter](docs/ItemIdFilter.md)
 - [PinterestSdkClient::ItemProcessingRecord](docs/ItemProcessingRecord.md)
 - [PinterestSdkClient::ItemProcessingStatus](docs/ItemProcessingStatus.md)
 - [PinterestSdkClient::ItemValidationEvent](docs/ItemValidationEvent.md)
 - [PinterestSdkClient::Language](docs/Language.md)
 - [PinterestSdkClient::MaxPriceFilter](docs/MaxPriceFilter.md)
 - [PinterestSdkClient::MediaUpload](docs/MediaUpload.md)
 - [PinterestSdkClient::MediaUploadAllOf](docs/MediaUploadAllOf.md)
 - [PinterestSdkClient::MediaUploadAllOfUploadParameters](docs/MediaUploadAllOfUploadParameters.md)
 - [PinterestSdkClient::MediaUploadDetails](docs/MediaUploadDetails.md)
 - [PinterestSdkClient::MediaUploadRequest](docs/MediaUploadRequest.md)
 - [PinterestSdkClient::MediaUploadStatus](docs/MediaUploadStatus.md)
 - [PinterestSdkClient::MediaUploadType](docs/MediaUploadType.md)
 - [PinterestSdkClient::MetricsReportingLevel](docs/MetricsReportingLevel.md)
 - [PinterestSdkClient::MinPriceFilter](docs/MinPriceFilter.md)
 - [PinterestSdkClient::NonNullableCatalogsCurrency](docs/NonNullableCatalogsCurrency.md)
 - [PinterestSdkClient::NullableCurrency](docs/NullableCurrency.md)
 - [PinterestSdkClient::OauthAccessTokenRequestCode](docs/OauthAccessTokenRequestCode.md)
 - [PinterestSdkClient::OauthAccessTokenRequestCodeAllOf](docs/OauthAccessTokenRequestCodeAllOf.md)
 - [PinterestSdkClient::OauthAccessTokenRequestRefresh](docs/OauthAccessTokenRequestRefresh.md)
 - [PinterestSdkClient::OauthAccessTokenRequestRefreshAllOf](docs/OauthAccessTokenRequestRefreshAllOf.md)
 - [PinterestSdkClient::OauthAccessTokenResponse](docs/OauthAccessTokenResponse.md)
 - [PinterestSdkClient::OauthAccessTokenResponseCode](docs/OauthAccessTokenResponseCode.md)
 - [PinterestSdkClient::OauthAccessTokenResponseCodeAllOf](docs/OauthAccessTokenResponseCodeAllOf.md)
 - [PinterestSdkClient::OauthAccessTokenResponseRefresh](docs/OauthAccessTokenResponseRefresh.md)
 - [PinterestSdkClient::ObjectiveType](docs/ObjectiveType.md)
 - [PinterestSdkClient::PacingDeliveryType](docs/PacingDeliveryType.md)
 - [PinterestSdkClient::Paginated](docs/Paginated.md)
 - [PinterestSdkClient::Pin](docs/Pin.md)
 - [PinterestSdkClient::PinMedia](docs/PinMedia.md)
 - [PinterestSdkClient::PinMediaSource](docs/PinMediaSource.md)
 - [PinterestSdkClient::PinMediaSourceImageBase64](docs/PinMediaSourceImageBase64.md)
 - [PinterestSdkClient::PinMediaSourceImageURL](docs/PinMediaSourceImageURL.md)
 - [PinterestSdkClient::PinMediaSourceVideoID](docs/PinMediaSourceVideoID.md)
 - [PinterestSdkClient::PinMediaWithImage](docs/PinMediaWithImage.md)
 - [PinterestSdkClient::PinMediaWithImageAllOf](docs/PinMediaWithImageAllOf.md)
 - [PinterestSdkClient::PinPromotionSummaryStatus](docs/PinPromotionSummaryStatus.md)
 - [PinterestSdkClient::PlacementGroupType](docs/PlacementGroupType.md)
 - [PinterestSdkClient::ProductAvailabilityType](docs/ProductAvailabilityType.md)
 - [PinterestSdkClient::ProductGroupSummaryStatus](docs/ProductGroupSummaryStatus.md)
 - [PinterestSdkClient::ProductType0Filter](docs/ProductType0Filter.md)
 - [PinterestSdkClient::ProductType1Filter](docs/ProductType1Filter.md)
 - [PinterestSdkClient::ProductType2Filter](docs/ProductType2Filter.md)
 - [PinterestSdkClient::ProductType3Filter](docs/ProductType3Filter.md)
 - [PinterestSdkClient::ProductType4Filter](docs/ProductType4Filter.md)
 - [PinterestSdkClient::ReportingColumnAsync](docs/ReportingColumnAsync.md)
 - [PinterestSdkClient::TargetingTypeFilter](docs/TargetingTypeFilter.md)
 - [PinterestSdkClient::TrackingUrls](docs/TrackingUrls.md)


## Documentation for Authorization


### basic

- **Type**: HTTP basic authentication

### pinterest_oauth2


- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://www.pinterest.com/oauth/
- **Scopes**: 
  - ads:read: See all of your advertising data, including ads, ad groups, campaigns etc.
  - ads:write: Create, update, or delete ads, ad groups, campaigns etc.
  - boards:read: See your public boards, including group boards you join
  - boards:read_secret: See your secret boards
  - boards:write: Create, update, or delete your public boards
  - boards:write_secret: Create, update, or delete your secret boards
  - catalogs:read: See all of your catalogs data
  - catalogs:write: Create, update, or delete your catalogs data
  - pins:read: See your public Pins
  - pins:read_secret: See your secret Pins
  - pins:write: Create, update, or delete your public Pins
  - pins:write_secret: Create, update, or delete your secret Pins
  - user_accounts:read: See your user accounts