pinterest_sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +70 -0
- data/README.md +319 -0
- data/Rakefile +10 -0
- data/bin/bundle +114 -0
- data/bin/byebug +27 -0
- data/bin/coderay +27 -0
- data/bin/htmldiff +27 -0
- data/bin/ldiff +27 -0
- data/bin/pry +27 -0
- data/bin/rake +27 -0
- data/bin/rspec +27 -0
- data/bin/rubocop +27 -0
- data/bin/ruby-parse +27 -0
- data/bin/ruby-rewrite +27 -0
- data/docs/Account.md +24 -0
- data/docs/ActionType.md +15 -0
- data/docs/AdAccount.md +26 -0
- data/docs/AdAccountOwner.md +18 -0
- data/docs/AdAccountsApi.md +929 -0
- data/docs/AdGroupResponse.md +62 -0
- data/docs/AdGroupResponseAllOf.md +48 -0
- data/docs/AdGroupResponseAllOf1.md +30 -0
- data/docs/AdGroupSummaryStatus.md +15 -0
- data/docs/AdResponse.md +70 -0
- data/docs/AdResponseAllOf.md +48 -0
- data/docs/AdResponseAllOf1.md +38 -0
- data/docs/AdsAnalyticsCreateAsyncRequest.md +62 -0
- data/docs/AdsAnalyticsCreateAsyncRequestAllOf.md +32 -0
- data/docs/AdsAnalyticsCreateAsyncRequestAllOf1.md +22 -0
- data/docs/AdsAnalyticsCreateAsyncResponse.md +22 -0
- data/docs/AdsAnalyticsFilterColumn.md +15 -0
- data/docs/AdsAnalyticsFilterOperator.md +15 -0
- data/docs/AdsAnalyticsGetAsyncResponse.md +22 -0
- data/docs/AdsAnalyticsMetricsFilter.md +22 -0
- data/docs/AdsAnalyticsTargetingType.md +15 -0
- data/docs/AnalyticsMetricsResponse.md +20 -0
- data/docs/AnalyticsMetricsResponseDailyMetrics.md +22 -0
- data/docs/AvailabilityFilter.md +18 -0
- data/docs/BatchOperation.md +15 -0
- data/docs/BatchOperationStatus.md +15 -0
- data/docs/Board.md +26 -0
- data/docs/BoardOwner.md +18 -0
- data/docs/BoardSection.md +20 -0
- data/docs/BoardUpdate.md +22 -0
- data/docs/BoardsApi.md +811 -0
- data/docs/BrandFilter.md +18 -0
- data/docs/CampaignCommon.md +34 -0
- data/docs/CampaignResponse.md +44 -0
- data/docs/CampaignResponseAllOf.md +18 -0
- data/docs/CampaignResponseAllOf1.md +24 -0
- data/docs/CampaignSummaryStatus.md +15 -0
- data/docs/CatalogsApi.md +939 -0
- data/docs/CatalogsDbItem.md +22 -0
- data/docs/CatalogsFeed.md +42 -0
- data/docs/CatalogsFeedCredentials.md +20 -0
- data/docs/CatalogsFeedIngestionDetails.md +20 -0
- data/docs/CatalogsFeedIngestionErrors.md +26 -0
- data/docs/CatalogsFeedIngestionInfo.md +22 -0
- data/docs/CatalogsFeedProcessingResult.md +30 -0
- data/docs/CatalogsFeedProcessingResultFields.md +24 -0
- data/docs/CatalogsFeedProcessingSchedule.md +20 -0
- data/docs/CatalogsFeedProcessingStatus.md +15 -0
- data/docs/CatalogsFeedProductCounts.md +18 -0
- data/docs/CatalogsFeedValidationDetails.md +20 -0
- data/docs/CatalogsFeedValidationErrors.md +84 -0
- data/docs/CatalogsFeedValidationWarnings.md +106 -0
- data/docs/CatalogsFeedsCreateRequest.md +34 -0
- data/docs/CatalogsFeedsUpdateRequest.md +32 -0
- data/docs/CatalogsFormat.md +15 -0
- data/docs/CatalogsItems.md +18 -0
- data/docs/CatalogsItemsBatch.md +26 -0
- data/docs/CatalogsItemsBatchRequest.md +24 -0
- data/docs/CatalogsProductGroup.md +34 -0
- data/docs/CatalogsProductGroupCreateRequest.md +24 -0
- data/docs/CatalogsProductGroupCurrencyCriteria.md +20 -0
- data/docs/CatalogsProductGroupFilterKeys.md +68 -0
- data/docs/CatalogsProductGroupFilters.md +20 -0
- data/docs/CatalogsProductGroupFiltersAllOf.md +18 -0
- data/docs/CatalogsProductGroupFiltersAnyOf.md +18 -0
- data/docs/CatalogsProductGroupMultipleStringCriteria.md +20 -0
- data/docs/CatalogsProductGroupMultipleStringListCriteria.md +20 -0
- data/docs/CatalogsProductGroupPricingCriteria.md +22 -0
- data/docs/CatalogsProductGroupStatus.md +15 -0
- data/docs/CatalogsProductGroupType.md +15 -0
- data/docs/CatalogsProductGroupUpdateRequest.md +24 -0
- data/docs/CatalogsStatus.md +15 -0
- data/docs/ConditionFilter.md +18 -0
- data/docs/ConversionAttributionWindowDays.md +15 -0
- data/docs/ConversionReportAttributionType.md +15 -0
- data/docs/ConversionReportTimeType.md +15 -0
- data/docs/Country.md +15 -0
- data/docs/Currency.md +15 -0
- data/docs/CurrencyFilter.md +18 -0
- data/docs/CustomLabel0Filter.md +18 -0
- data/docs/CustomLabel1Filter.md +18 -0
- data/docs/CustomLabel2Filter.md +18 -0
- data/docs/CustomLabel3Filter.md +18 -0
- data/docs/CustomLabel4Filter.md +18 -0
- data/docs/DataOutputFormat.md +15 -0
- data/docs/EntityStatus.md +15 -0
- data/docs/Error.md +20 -0
- data/docs/FeedFields.md +36 -0
- data/docs/GenderFilter.md +18 -0
- data/docs/GoogleProductCategory0Filter.md +18 -0
- data/docs/GoogleProductCategory1Filter.md +18 -0
- data/docs/GoogleProductCategory2Filter.md +18 -0
- data/docs/GoogleProductCategory3Filter.md +18 -0
- data/docs/GoogleProductCategory4Filter.md +18 -0
- data/docs/GoogleProductCategory5Filter.md +18 -0
- data/docs/GoogleProductCategory6Filter.md +18 -0
- data/docs/Granularity.md +15 -0
- data/docs/ImageDetails.md +22 -0
- data/docs/ItemAttributes.md +104 -0
- data/docs/ItemBatchRecord.md +20 -0
- data/docs/ItemGroupIdFilter.md +18 -0
- data/docs/ItemIdFilter.md +18 -0
- data/docs/ItemProcessingRecord.md +24 -0
- data/docs/ItemProcessingStatus.md +15 -0
- data/docs/ItemValidationEvent.md +22 -0
- data/docs/Language.md +15 -0
- data/docs/MaxPriceFilter.md +18 -0
- data/docs/MediaApi.md +221 -0
- data/docs/MediaUpload.md +24 -0
- data/docs/MediaUploadAllOf.md +24 -0
- data/docs/MediaUploadAllOfUploadParameters.md +32 -0
- data/docs/MediaUploadDetails.md +22 -0
- data/docs/MediaUploadRequest.md +18 -0
- data/docs/MediaUploadStatus.md +15 -0
- data/docs/MediaUploadType.md +15 -0
- data/docs/MetricsReportingLevel.md +15 -0
- data/docs/MinPriceFilter.md +18 -0
- data/docs/NonNullableCatalogsCurrency.md +15 -0
- data/docs/NullableCurrency.md +15 -0
- data/docs/OauthAccessTokenRequest.md +18 -0
- data/docs/OauthAccessTokenRequestCode.md +20 -0
- data/docs/OauthAccessTokenRequestCodeAllOf.md +20 -0
- data/docs/OauthAccessTokenRequestRefresh.md +20 -0
- data/docs/OauthAccessTokenRequestRefreshAllOf.md +20 -0
- data/docs/OauthAccessTokenResponse.md +26 -0
- data/docs/OauthAccessTokenResponseCode.md +20 -0
- data/docs/OauthAccessTokenResponseCodeAllOf.md +20 -0
- data/docs/OauthAccessTokenResponseRefresh.md +15 -0
- data/docs/OauthApi.md +72 -0
- data/docs/ObjectiveType.md +15 -0
- data/docs/PacingDeliveryType.md +15 -0
- data/docs/Paginated.md +20 -0
- data/docs/Pin.md +38 -0
- data/docs/PinMedia.md +18 -0
- data/docs/PinMediaSource.md +81 -0
- data/docs/PinMediaSourceImageBase64.md +22 -0
- data/docs/PinMediaSourceImageURL.md +20 -0
- data/docs/PinMediaSourceVideoID.md +22 -0
- data/docs/PinMediaWithImage.md +18 -0
- data/docs/PinMediaWithImageAllOf.md +18 -0
- data/docs/PinPromotionSummaryStatus.md +15 -0
- data/docs/PinsApi.md +304 -0
- data/docs/PlacementGroupType.md +15 -0
- data/docs/ProductAvailabilityType.md +15 -0
- data/docs/ProductGroupSummaryStatus.md +15 -0
- data/docs/ProductType0Filter.md +18 -0
- data/docs/ProductType1Filter.md +18 -0
- data/docs/ProductType2Filter.md +18 -0
- data/docs/ProductType3Filter.md +18 -0
- data/docs/ProductType4Filter.md +18 -0
- data/docs/ReportingColumnAsync.md +15 -0
- data/docs/TargetingTypeFilter.md +18 -0
- data/docs/TrackingUrls.md +26 -0
- data/docs/UserAccountApi.md +165 -0
- data/git_push.sh +57 -0
- data/lib/pinterest_sdk/api/ad_accounts_api.rb +1287 -0
- data/lib/pinterest_sdk/api/boards_api.rb +888 -0
- data/lib/pinterest_sdk/api/catalogs_api.rb +965 -0
- data/lib/pinterest_sdk/api/media_api.rb +229 -0
- data/lib/pinterest_sdk/api/oauth_api.rb +96 -0
- data/lib/pinterest_sdk/api/pins_api.rb +330 -0
- data/lib/pinterest_sdk/api/user_account_api.rb +201 -0
- data/lib/pinterest_sdk/api_client.rb +390 -0
- data/lib/pinterest_sdk/api_error.rb +57 -0
- data/lib/pinterest_sdk/configuration.rb +285 -0
- data/lib/pinterest_sdk/models/account.rb +280 -0
- data/lib/pinterest_sdk/models/action_type.rb +39 -0
- data/lib/pinterest_sdk/models/ad_account.rb +254 -0
- data/lib/pinterest_sdk/models/ad_account_owner.rb +219 -0
- data/lib/pinterest_sdk/models/ad_group_response.rb +555 -0
- data/lib/pinterest_sdk/models/ad_group_response_all_of.rb +427 -0
- data/lib/pinterest_sdk/models/ad_group_response_all_of1.rb +329 -0
- data/lib/pinterest_sdk/models/ad_group_summary_status.rb +41 -0
- data/lib/pinterest_sdk/models/ad_response.rb +640 -0
- data/lib/pinterest_sdk/models/ad_response_all_of.rb +455 -0
- data/lib/pinterest_sdk/models/ad_response_all_of1.rb +409 -0
- data/lib/pinterest_sdk/models/ads_analytics_create_async_request.rb +831 -0
- data/lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb +356 -0
- data/lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of1.rb +253 -0
- data/lib/pinterest_sdk/models/ads_analytics_create_async_response.rb +237 -0
- data/lib/pinterest_sdk/models/ads_analytics_filter_column.rb +37 -0
- data/lib/pinterest_sdk/models/ads_analytics_filter_operator.rb +37 -0
- data/lib/pinterest_sdk/models/ads_analytics_get_async_response.rb +238 -0
- data/lib/pinterest_sdk/models/ads_analytics_metrics_filter.rb +254 -0
- data/lib/pinterest_sdk/models/ads_analytics_targeting_type.rb +48 -0
- data/lib/pinterest_sdk/models/analytics_metrics_response.rb +233 -0
- data/lib/pinterest_sdk/models/analytics_metrics_response_daily_metrics.rb +275 -0
- data/lib/pinterest_sdk/models/availability_filter.rb +223 -0
- data/lib/pinterest_sdk/models/batch_operation.rb +38 -0
- data/lib/pinterest_sdk/models/batch_operation_status.rb +37 -0
- data/lib/pinterest_sdk/models/board.rb +301 -0
- data/lib/pinterest_sdk/models/board_owner.rb +218 -0
- data/lib/pinterest_sdk/models/board_section.rb +252 -0
- data/lib/pinterest_sdk/models/board_update.rb +272 -0
- data/lib/pinterest_sdk/models/brand_filter.rb +223 -0
- data/lib/pinterest_sdk/models/campaign_common.rb +352 -0
- data/lib/pinterest_sdk/models/campaign_response.rb +435 -0
- data/lib/pinterest_sdk/models/campaign_response_all_of.rb +245 -0
- data/lib/pinterest_sdk/models/campaign_response_all_of1.rb +248 -0
- data/lib/pinterest_sdk/models/campaign_summary_status.rb +41 -0
- data/lib/pinterest_sdk/models/catalogs_db_item.rb +236 -0
- data/lib/pinterest_sdk/models/catalogs_feed.rb +368 -0
- data/lib/pinterest_sdk/models/catalogs_feed_credentials.rb +240 -0
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_details.rb +237 -0
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_errors.rb +288 -0
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_info.rb +236 -0
- data/lib/pinterest_sdk/models/catalogs_feed_processing_result.rb +296 -0
- data/lib/pinterest_sdk/models/catalogs_feed_processing_result_fields.rb +261 -0
- data/lib/pinterest_sdk/models/catalogs_feed_processing_schedule.rb +291 -0
- data/lib/pinterest_sdk/models/catalogs_feed_processing_status.rb +43 -0
- data/lib/pinterest_sdk/models/catalogs_feed_product_counts.rb +220 -0
- data/lib/pinterest_sdk/models/catalogs_feed_validation_details.rb +237 -0
- data/lib/pinterest_sdk/models/catalogs_feed_validation_errors.rb +515 -0
- data/lib/pinterest_sdk/models/catalogs_feed_validation_warnings.rb +614 -0
- data/lib/pinterest_sdk/models/catalogs_feeds_create_request.rb +313 -0
- data/lib/pinterest_sdk/models/catalogs_feeds_update_request.rb +288 -0
- data/lib/pinterest_sdk/models/catalogs_format.rb +38 -0
- data/lib/pinterest_sdk/models/catalogs_items.rb +222 -0
- data/lib/pinterest_sdk/models/catalogs_items_batch.rb +262 -0
- data/lib/pinterest_sdk/models/catalogs_items_batch_request.rb +249 -0
- data/lib/pinterest_sdk/models/catalogs_product_group.rb +345 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_create_request.rb +284 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_currency_criteria.rb +237 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filter_keys.rb +617 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filters.rb +252 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_all_of.rb +220 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_any_of.rb +220 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_string_criteria.rb +239 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_string_list_criteria.rb +239 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_pricing_criteria.rb +251 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_status.rb +37 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_type.rb +42 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_update_request.rb +284 -0
- data/lib/pinterest_sdk/models/catalogs_status.rb +37 -0
- data/lib/pinterest_sdk/models/condition_filter.rb +223 -0
- data/lib/pinterest_sdk/models/conversion_attribution_window_days.rb +39 -0
- data/lib/pinterest_sdk/models/conversion_report_attribution_type.rb +37 -0
- data/lib/pinterest_sdk/models/conversion_report_time_type.rb +37 -0
- data/lib/pinterest_sdk/models/country.rb +282 -0
- data/lib/pinterest_sdk/models/currency.rb +60 -0
- data/lib/pinterest_sdk/models/currency_filter.rb +223 -0
- data/lib/pinterest_sdk/models/custom_label0_filter.rb +223 -0
- data/lib/pinterest_sdk/models/custom_label1_filter.rb +223 -0
- data/lib/pinterest_sdk/models/custom_label2_filter.rb +223 -0
- data/lib/pinterest_sdk/models/custom_label3_filter.rb +223 -0
- data/lib/pinterest_sdk/models/custom_label4_filter.rb +223 -0
- data/lib/pinterest_sdk/models/data_output_format.rb +37 -0
- data/lib/pinterest_sdk/models/entity_status.rb +38 -0
- data/lib/pinterest_sdk/models/error.rb +237 -0
- data/lib/pinterest_sdk/models/feed_fields.rb +332 -0
- data/lib/pinterest_sdk/models/gender_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category0_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category1_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category2_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category3_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category4_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category5_filter.rb +223 -0
- data/lib/pinterest_sdk/models/google_product_category6_filter.rb +223 -0
- data/lib/pinterest_sdk/models/granularity.rb +40 -0
- data/lib/pinterest_sdk/models/image_details.rb +281 -0
- data/lib/pinterest_sdk/models/item_attributes.rb +833 -0
- data/lib/pinterest_sdk/models/item_batch_record.rb +229 -0
- data/lib/pinterest_sdk/models/item_group_id_filter.rb +223 -0
- data/lib/pinterest_sdk/models/item_id_filter.rb +223 -0
- data/lib/pinterest_sdk/models/item_processing_record.rb +253 -0
- data/lib/pinterest_sdk/models/item_processing_status.rb +38 -0
- data/lib/pinterest_sdk/models/item_validation_event.rb +240 -0
- data/lib/pinterest_sdk/models/language.rb +96 -0
- data/lib/pinterest_sdk/models/max_price_filter.rb +223 -0
- data/lib/pinterest_sdk/models/media_upload.rb +255 -0
- data/lib/pinterest_sdk/models/media_upload_all_of.rb +247 -0
- data/lib/pinterest_sdk/models/media_upload_all_of_upload_parameters.rb +282 -0
- data/lib/pinterest_sdk/models/media_upload_details.rb +254 -0
- data/lib/pinterest_sdk/models/media_upload_request.rb +224 -0
- data/lib/pinterest_sdk/models/media_upload_status.rb +39 -0
- data/lib/pinterest_sdk/models/media_upload_type.rb +36 -0
- data/lib/pinterest_sdk/models/metrics_reporting_level.rb +47 -0
- data/lib/pinterest_sdk/models/min_price_filter.rb +223 -0
- data/lib/pinterest_sdk/models/non_nullable_catalogs_currency.rb +198 -0
- data/lib/pinterest_sdk/models/nullable_currency.rb +199 -0
- data/lib/pinterest_sdk/models/oauth_access_token_request_code.rb +272 -0
- data/lib/pinterest_sdk/models/oauth_access_token_request_code_all_of.rb +237 -0
- data/lib/pinterest_sdk/models/oauth_access_token_request_refresh.rb +267 -0
- data/lib/pinterest_sdk/models/oauth_access_token_request_refresh_all_of.rb +232 -0
- data/lib/pinterest_sdk/models/oauth_access_token_response.rb +316 -0
- data/lib/pinterest_sdk/models/oauth_access_token_response_code.rb +272 -0
- data/lib/pinterest_sdk/models/oauth_access_token_response_code_all_of.rb +237 -0
- data/lib/pinterest_sdk/models/oauth_access_token_response_refresh.rb +243 -0
- data/lib/pinterest_sdk/models/objective_type.rb +43 -0
- data/lib/pinterest_sdk/models/pacing_delivery_type.rb +37 -0
- data/lib/pinterest_sdk/models/paginated.rb +235 -0
- data/lib/pinterest_sdk/models/pin.rb +359 -0
- data/lib/pinterest_sdk/models/pin_media.rb +224 -0
- data/lib/pinterest_sdk/models/pin_media_source.rb +58 -0
- data/lib/pinterest_sdk/models/pin_media_source_image_base64.rb +319 -0
- data/lib/pinterest_sdk/models/pin_media_source_image_url.rb +272 -0
- data/lib/pinterest_sdk/models/pin_media_source_video_id.rb +307 -0
- data/lib/pinterest_sdk/models/pin_media_with_image.rb +233 -0
- data/lib/pinterest_sdk/models/pin_media_with_image_all_of.rb +220 -0
- data/lib/pinterest_sdk/models/pin_promotion_summary_status.rb +41 -0
- data/lib/pinterest_sdk/models/placement_group_type.rb +39 -0
- data/lib/pinterest_sdk/models/product_availability_type.rb +39 -0
- data/lib/pinterest_sdk/models/product_group_summary_status.rb +39 -0
- data/lib/pinterest_sdk/models/product_type0_filter.rb +223 -0
- data/lib/pinterest_sdk/models/product_type1_filter.rb +223 -0
- data/lib/pinterest_sdk/models/product_type2_filter.rb +223 -0
- data/lib/pinterest_sdk/models/product_type3_filter.rb +223 -0
- data/lib/pinterest_sdk/models/product_type4_filter.rb +223 -0
- data/lib/pinterest_sdk/models/reporting_column_async.rb +549 -0
- data/lib/pinterest_sdk/models/targeting_type_filter.rb +245 -0
- data/lib/pinterest_sdk/models/tracking_urls.rb +340 -0
- data/lib/pinterest_sdk/version.rb +15 -0
- data/lib/pinterest_sdk.rb +192 -0
- data/pinterest_sdk.gemspec +38 -0
- data/spec/api/ad_accounts_api_spec.rb +234 -0
- data/spec/api/boards_api_spec.rb +181 -0
- data/spec/api/catalogs_api_spec.rb +200 -0
- data/spec/api/media_api_spec.rb +72 -0
- data/spec/api/oauth_api_spec.rb +47 -0
- data/spec/api/pins_api_spec.rb +90 -0
- data/spec/api/user_account_api_spec.rb +66 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_spec.rb +56 -0
- data/spec/models/action_type_spec.rb +28 -0
- data/spec/models/ad_account_owner_spec.rb +34 -0
- data/spec/models/ad_account_spec.rb +58 -0
- data/spec/models/ad_group_response_all_of1_spec.rb +70 -0
- data/spec/models/ad_group_response_all_of_spec.rb +132 -0
- data/spec/models/ad_group_response_spec.rb +174 -0
- data/spec/models/ad_group_summary_status_spec.rb +28 -0
- data/spec/models/ad_response_all_of1_spec.rb +102 -0
- data/spec/models/ad_response_all_of_spec.rb +128 -0
- data/spec/models/ad_response_spec.rb +202 -0
- data/spec/models/ads_analytics_create_async_request_all_of1_spec.rb +46 -0
- data/spec/models/ads_analytics_create_async_request_all_of_spec.rb +76 -0
- data/spec/models/ads_analytics_create_async_request_spec.rb +166 -0
- data/spec/models/ads_analytics_create_async_response_spec.rb +46 -0
- data/spec/models/ads_analytics_filter_column_spec.rb +28 -0
- data/spec/models/ads_analytics_filter_operator_spec.rb +28 -0
- data/spec/models/ads_analytics_get_async_response_spec.rb +46 -0
- data/spec/models/ads_analytics_metrics_filter_spec.rb +46 -0
- data/spec/models/ads_analytics_targeting_type_spec.rb +28 -0
- data/spec/models/analytics_metrics_response_daily_metrics_spec.rb +50 -0
- data/spec/models/analytics_metrics_response_spec.rb +40 -0
- data/spec/models/availability_filter_spec.rb +34 -0
- data/spec/models/batch_operation_spec.rb +28 -0
- data/spec/models/batch_operation_status_spec.rb +28 -0
- data/spec/models/board_owner_spec.rb +34 -0
- data/spec/models/board_section_spec.rb +40 -0
- data/spec/models/board_spec.rb +62 -0
- data/spec/models/board_update_spec.rb +50 -0
- data/spec/models/brand_filter_spec.rb +34 -0
- data/spec/models/campaign_common_spec.rb +82 -0
- data/spec/models/campaign_response_all_of1_spec.rb +52 -0
- data/spec/models/campaign_response_all_of_spec.rb +34 -0
- data/spec/models/campaign_response_spec.rb +112 -0
- data/spec/models/campaign_summary_status_spec.rb +28 -0
- data/spec/models/catalogs_db_item_spec.rb +46 -0
- data/spec/models/catalogs_feed_credentials_spec.rb +40 -0
- data/spec/models/catalogs_feed_ingestion_details_spec.rb +40 -0
- data/spec/models/catalogs_feed_ingestion_errors_spec.rb +62 -0
- data/spec/models/catalogs_feed_ingestion_info_spec.rb +46 -0
- data/spec/models/catalogs_feed_processing_result_fields_spec.rb +52 -0
- data/spec/models/catalogs_feed_processing_result_spec.rb +70 -0
- data/spec/models/catalogs_feed_processing_schedule_spec.rb +44 -0
- data/spec/models/catalogs_feed_processing_status_spec.rb +28 -0
- data/spec/models/catalogs_feed_product_counts_spec.rb +34 -0
- data/spec/models/catalogs_feed_spec.rb +106 -0
- data/spec/models/catalogs_feed_validation_details_spec.rb +40 -0
- data/spec/models/catalogs_feed_validation_errors_spec.rb +232 -0
- data/spec/models/catalogs_feed_validation_warnings_spec.rb +298 -0
- data/spec/models/catalogs_feeds_create_request_spec.rb +82 -0
- data/spec/models/catalogs_feeds_update_request_spec.rb +76 -0
- data/spec/models/catalogs_format_spec.rb +28 -0
- data/spec/models/catalogs_items_batch_request_spec.rb +52 -0
- data/spec/models/catalogs_items_batch_spec.rb +58 -0
- data/spec/models/catalogs_items_spec.rb +34 -0
- data/spec/models/catalogs_product_group_create_request_spec.rb +52 -0
- data/spec/models/catalogs_product_group_currency_criteria_spec.rb +40 -0
- data/spec/models/catalogs_product_group_filter_keys_spec.rb +184 -0
- data/spec/models/catalogs_product_group_filters_all_of_spec.rb +34 -0
- data/spec/models/catalogs_product_group_filters_any_of_spec.rb +34 -0
- data/spec/models/catalogs_product_group_filters_spec.rb +40 -0
- data/spec/models/catalogs_product_group_multiple_string_criteria_spec.rb +40 -0
- data/spec/models/catalogs_product_group_multiple_string_list_criteria_spec.rb +40 -0
- data/spec/models/catalogs_product_group_pricing_criteria_spec.rb +46 -0
- data/spec/models/catalogs_product_group_spec.rb +82 -0
- data/spec/models/catalogs_product_group_status_spec.rb +28 -0
- data/spec/models/catalogs_product_group_type_spec.rb +28 -0
- data/spec/models/catalogs_product_group_update_request_spec.rb +52 -0
- data/spec/models/catalogs_status_spec.rb +28 -0
- data/spec/models/condition_filter_spec.rb +34 -0
- data/spec/models/conversion_attribution_window_days_spec.rb +28 -0
- data/spec/models/conversion_report_attribution_type_spec.rb +28 -0
- data/spec/models/conversion_report_time_type_spec.rb +28 -0
- data/spec/models/country_spec.rb +28 -0
- data/spec/models/currency_filter_spec.rb +34 -0
- data/spec/models/currency_spec.rb +28 -0
- data/spec/models/custom_label0_filter_spec.rb +34 -0
- data/spec/models/custom_label1_filter_spec.rb +34 -0
- data/spec/models/custom_label2_filter_spec.rb +34 -0
- data/spec/models/custom_label3_filter_spec.rb +34 -0
- data/spec/models/custom_label4_filter_spec.rb +34 -0
- data/spec/models/data_output_format_spec.rb +28 -0
- data/spec/models/entity_status_spec.rb +28 -0
- data/spec/models/error_spec.rb +40 -0
- data/spec/models/feed_fields_spec.rb +88 -0
- data/spec/models/gender_filter_spec.rb +34 -0
- data/spec/models/google_product_category0_filter_spec.rb +34 -0
- data/spec/models/google_product_category1_filter_spec.rb +34 -0
- data/spec/models/google_product_category2_filter_spec.rb +34 -0
- data/spec/models/google_product_category3_filter_spec.rb +34 -0
- data/spec/models/google_product_category4_filter_spec.rb +34 -0
- data/spec/models/google_product_category5_filter_spec.rb +34 -0
- data/spec/models/google_product_category6_filter_spec.rb +34 -0
- data/spec/models/granularity_spec.rb +28 -0
- data/spec/models/image_details_spec.rb +46 -0
- data/spec/models/item_attributes_spec.rb +292 -0
- data/spec/models/item_batch_record_spec.rb +40 -0
- data/spec/models/item_group_id_filter_spec.rb +34 -0
- data/spec/models/item_id_filter_spec.rb +34 -0
- data/spec/models/item_processing_record_spec.rb +52 -0
- data/spec/models/item_processing_status_spec.rb +28 -0
- data/spec/models/item_validation_event_spec.rb +46 -0
- data/spec/models/language_spec.rb +28 -0
- data/spec/models/max_price_filter_spec.rb +34 -0
- data/spec/models/media_upload_all_of_spec.rb +52 -0
- data/spec/models/media_upload_all_of_upload_parameters_spec.rb +76 -0
- data/spec/models/media_upload_details_spec.rb +46 -0
- data/spec/models/media_upload_request_spec.rb +34 -0
- data/spec/models/media_upload_spec.rb +52 -0
- data/spec/models/media_upload_status_spec.rb +28 -0
- data/spec/models/media_upload_type_spec.rb +28 -0
- data/spec/models/metrics_reporting_level_spec.rb +28 -0
- data/spec/models/min_price_filter_spec.rb +34 -0
- data/spec/models/non_nullable_catalogs_currency_spec.rb +28 -0
- data/spec/models/nullable_currency_spec.rb +28 -0
- data/spec/models/oauth_access_token_request_code_all_of_spec.rb +40 -0
- data/spec/models/oauth_access_token_request_code_spec.rb +40 -0
- data/spec/models/oauth_access_token_request_refresh_all_of_spec.rb +40 -0
- data/spec/models/oauth_access_token_request_refresh_spec.rb +40 -0
- data/spec/models/oauth_access_token_request_spec.rb +38 -0
- data/spec/models/oauth_access_token_response_code_all_of_spec.rb +40 -0
- data/spec/models/oauth_access_token_response_code_spec.rb +40 -0
- data/spec/models/oauth_access_token_response_refresh_spec.rb +28 -0
- data/spec/models/oauth_access_token_response_spec.rb +62 -0
- data/spec/models/objective_type_spec.rb +28 -0
- data/spec/models/pacing_delivery_type_spec.rb +28 -0
- data/spec/models/paginated_spec.rb +40 -0
- data/spec/models/pin_media_source_image_base64_spec.rb +54 -0
- data/spec/models/pin_media_source_image_url_spec.rb +44 -0
- data/spec/models/pin_media_source_spec.rb +43 -0
- data/spec/models/pin_media_source_video_id_spec.rb +50 -0
- data/spec/models/pin_media_spec.rb +34 -0
- data/spec/models/pin_media_with_image_all_of_spec.rb +34 -0
- data/spec/models/pin_media_with_image_spec.rb +34 -0
- data/spec/models/pin_promotion_summary_status_spec.rb +28 -0
- data/spec/models/pin_spec.rb +94 -0
- data/spec/models/placement_group_type_spec.rb +28 -0
- data/spec/models/product_availability_type_spec.rb +28 -0
- data/spec/models/product_group_summary_status_spec.rb +28 -0
- data/spec/models/product_type0_filter_spec.rb +34 -0
- data/spec/models/product_type1_filter_spec.rb +34 -0
- data/spec/models/product_type2_filter_spec.rb +34 -0
- data/spec/models/product_type3_filter_spec.rb +34 -0
- data/spec/models/product_type4_filter_spec.rb +34 -0
- data/spec/models/reporting_column_async_spec.rb +28 -0
- data/spec/models/targeting_type_filter_spec.rb +34 -0
- data/spec/models/tracking_urls_spec.rb +58 -0
- data/spec/spec_helper.rb +111 -0
- metadata +726 -0
data/docs/CatalogsApi.md
ADDED
|
@@ -0,0 +1,939 @@
|
|
|
1
|
+
# PinterestSdkClient::CatalogsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.pinterest.com/v5*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**catalogs_product_groups_create**](CatalogsApi.md#catalogs_product_groups_create) | **POST** /catalogs/product_groups | Create product group |
|
|
8
|
+
| [**catalogs_product_groups_delete**](CatalogsApi.md#catalogs_product_groups_delete) | **DELETE** /catalogs/product_groups/{product_group_id} | Delete product group |
|
|
9
|
+
| [**catalogs_product_groups_list**](CatalogsApi.md#catalogs_product_groups_list) | **GET** /catalogs/product_groups | Get product groups list |
|
|
10
|
+
| [**catalogs_product_groups_update**](CatalogsApi.md#catalogs_product_groups_update) | **PATCH** /catalogs/product_groups/{product_group_id} | Update product group |
|
|
11
|
+
| [**feed_processing_results_list**](CatalogsApi.md#feed_processing_results_list) | **GET** /catalogs/feeds/{feed_id}/processing_results | List processing results for a given feed |
|
|
12
|
+
| [**feeds_create**](CatalogsApi.md#feeds_create) | **POST** /catalogs/feeds | Create feed |
|
|
13
|
+
| [**feeds_delete**](CatalogsApi.md#feeds_delete) | **DELETE** /catalogs/feeds/{feed_id} | Delete feed |
|
|
14
|
+
| [**feeds_get**](CatalogsApi.md#feeds_get) | **GET** /catalogs/feeds/{feed_id} | Get feed |
|
|
15
|
+
| [**feeds_list**](CatalogsApi.md#feeds_list) | **GET** /catalogs/feeds | List feeds |
|
|
16
|
+
| [**feeds_update**](CatalogsApi.md#feeds_update) | **PATCH** /catalogs/feeds/{feed_id} | Update feed |
|
|
17
|
+
| [**items_batch_get**](CatalogsApi.md#items_batch_get) | **GET** /catalogs/items/batch/{batch_id} | Get catalogs items batch |
|
|
18
|
+
| [**items_batch_post**](CatalogsApi.md#items_batch_post) | **POST** /catalogs/items/batch | Perform an operation on an item batch |
|
|
19
|
+
| [**items_get**](CatalogsApi.md#items_get) | **GET** /catalogs/items | Get catalogs items |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## catalogs_product_groups_create
|
|
23
|
+
|
|
24
|
+
> Object catalogs_product_groups_create(catalogs_product_group_create_request)
|
|
25
|
+
|
|
26
|
+
Create product group
|
|
27
|
+
|
|
28
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Create product group to use in Catalogs.
|
|
29
|
+
|
|
30
|
+
### Examples
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'time'
|
|
34
|
+
require 'pinterest_sdk'
|
|
35
|
+
# setup authorization
|
|
36
|
+
PinterestSdkClient.configure do |config|
|
|
37
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
38
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
42
|
+
catalogs_product_group_create_request = PinterestSdkClient::CatalogsProductGroupCreateRequest.new({feed_id: '2680059592705', name: 'name_example', filters: PinterestSdkClient::CatalogsProductGroupFilters.new}) # CatalogsProductGroupCreateRequest | Request object used to created a catalogs product group.
|
|
43
|
+
|
|
44
|
+
begin
|
|
45
|
+
# Create product group
|
|
46
|
+
result = api_instance.catalogs_product_groups_create(catalogs_product_group_create_request)
|
|
47
|
+
p result
|
|
48
|
+
rescue PinterestSdkClient::ApiError => e
|
|
49
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_create: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
#### Using the catalogs_product_groups_create_with_http_info variant
|
|
54
|
+
|
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
|
56
|
+
|
|
57
|
+
> <Array(Object, Integer, Hash)> catalogs_product_groups_create_with_http_info(catalogs_product_group_create_request)
|
|
58
|
+
|
|
59
|
+
```ruby
|
|
60
|
+
begin
|
|
61
|
+
# Create product group
|
|
62
|
+
data, status_code, headers = api_instance.catalogs_product_groups_create_with_http_info(catalogs_product_group_create_request)
|
|
63
|
+
p status_code # => 2xx
|
|
64
|
+
p headers # => { ... }
|
|
65
|
+
p data # => Object
|
|
66
|
+
rescue PinterestSdkClient::ApiError => e
|
|
67
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_create_with_http_info: #{e}"
|
|
68
|
+
end
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
| Name | Type | Description | Notes |
|
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
|
75
|
+
| **catalogs_product_group_create_request** | [**CatalogsProductGroupCreateRequest**](CatalogsProductGroupCreateRequest.md) | Request object used to created a catalogs product group. | |
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
**Object**
|
|
80
|
+
|
|
81
|
+
### Authorization
|
|
82
|
+
|
|
83
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
84
|
+
|
|
85
|
+
### HTTP request headers
|
|
86
|
+
|
|
87
|
+
- **Content-Type**: application/json
|
|
88
|
+
- **Accept**: application/json
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
## catalogs_product_groups_delete
|
|
92
|
+
|
|
93
|
+
> catalogs_product_groups_delete(product_group_id)
|
|
94
|
+
|
|
95
|
+
Delete product group
|
|
96
|
+
|
|
97
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Delete a product group from being in use in Catalogs.
|
|
98
|
+
|
|
99
|
+
### Examples
|
|
100
|
+
|
|
101
|
+
```ruby
|
|
102
|
+
require 'time'
|
|
103
|
+
require 'pinterest_sdk'
|
|
104
|
+
# setup authorization
|
|
105
|
+
PinterestSdkClient.configure do |config|
|
|
106
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
107
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
111
|
+
product_group_id = 'product_group_id_example' # String | Unique identifier of a product group
|
|
112
|
+
|
|
113
|
+
begin
|
|
114
|
+
# Delete product group
|
|
115
|
+
api_instance.catalogs_product_groups_delete(product_group_id)
|
|
116
|
+
rescue PinterestSdkClient::ApiError => e
|
|
117
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_delete: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### Using the catalogs_product_groups_delete_with_http_info variant
|
|
122
|
+
|
|
123
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
124
|
+
|
|
125
|
+
> <Array(nil, Integer, Hash)> catalogs_product_groups_delete_with_http_info(product_group_id)
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
begin
|
|
129
|
+
# Delete product group
|
|
130
|
+
data, status_code, headers = api_instance.catalogs_product_groups_delete_with_http_info(product_group_id)
|
|
131
|
+
p status_code # => 2xx
|
|
132
|
+
p headers # => { ... }
|
|
133
|
+
p data # => nil
|
|
134
|
+
rescue PinterestSdkClient::ApiError => e
|
|
135
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_delete_with_http_info: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
| Name | Type | Description | Notes |
|
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
|
143
|
+
| **product_group_id** | **String** | Unique identifier of a product group | |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
nil (empty response body)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: Not defined
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
## catalogs_product_groups_list
|
|
160
|
+
|
|
161
|
+
> <Paginated> catalogs_product_groups_list(feed_id, opts)
|
|
162
|
+
|
|
163
|
+
Get product groups list
|
|
164
|
+
|
|
165
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Get a list of product groups for a given Catalogs Feed Id.
|
|
166
|
+
|
|
167
|
+
### Examples
|
|
168
|
+
|
|
169
|
+
```ruby
|
|
170
|
+
require 'time'
|
|
171
|
+
require 'pinterest_sdk'
|
|
172
|
+
# setup authorization
|
|
173
|
+
PinterestSdkClient.configure do |config|
|
|
174
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
175
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
179
|
+
feed_id = 'feed_id_example' # String | Unique identifier of a feed
|
|
180
|
+
opts = {
|
|
181
|
+
bookmark: 'bookmark_example', # String | Cursor used to fetch the next page of items
|
|
182
|
+
page_size: 56 # Integer | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
begin
|
|
186
|
+
# Get product groups list
|
|
187
|
+
result = api_instance.catalogs_product_groups_list(feed_id, opts)
|
|
188
|
+
p result
|
|
189
|
+
rescue PinterestSdkClient::ApiError => e
|
|
190
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_list: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
#### Using the catalogs_product_groups_list_with_http_info variant
|
|
195
|
+
|
|
196
|
+
This returns an Array which contains the response data, status code and headers.
|
|
197
|
+
|
|
198
|
+
> <Array(<Paginated>, Integer, Hash)> catalogs_product_groups_list_with_http_info(feed_id, opts)
|
|
199
|
+
|
|
200
|
+
```ruby
|
|
201
|
+
begin
|
|
202
|
+
# Get product groups list
|
|
203
|
+
data, status_code, headers = api_instance.catalogs_product_groups_list_with_http_info(feed_id, opts)
|
|
204
|
+
p status_code # => 2xx
|
|
205
|
+
p headers # => { ... }
|
|
206
|
+
p data # => <Paginated>
|
|
207
|
+
rescue PinterestSdkClient::ApiError => e
|
|
208
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_list_with_http_info: #{e}"
|
|
209
|
+
end
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
| Name | Type | Description | Notes |
|
|
215
|
+
| ---- | ---- | ----------- | ----- |
|
|
216
|
+
| **feed_id** | **String** | Unique identifier of a feed | |
|
|
217
|
+
| **bookmark** | **String** | Cursor used to fetch the next page of items | [optional] |
|
|
218
|
+
| **page_size** | **Integer** | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information. | [optional][default to 25] |
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
[**Paginated**](Paginated.md)
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: Not defined
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
## catalogs_product_groups_update
|
|
235
|
+
|
|
236
|
+
> <CatalogsProductGroup> catalogs_product_groups_update(product_group_id, catalogs_product_group_update_request)
|
|
237
|
+
|
|
238
|
+
Update product group
|
|
239
|
+
|
|
240
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Update product group to use in Catalogs.
|
|
241
|
+
|
|
242
|
+
### Examples
|
|
243
|
+
|
|
244
|
+
```ruby
|
|
245
|
+
require 'time'
|
|
246
|
+
require 'pinterest_sdk'
|
|
247
|
+
# setup authorization
|
|
248
|
+
PinterestSdkClient.configure do |config|
|
|
249
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
250
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
254
|
+
product_group_id = 'product_group_id_example' # String | Unique identifier of a product group
|
|
255
|
+
catalogs_product_group_update_request = PinterestSdkClient::CatalogsProductGroupUpdateRequest.new({feed_id: '2680059592705', name: 'name_example', filters: PinterestSdkClient::CatalogsProductGroupFilters.new}) # CatalogsProductGroupUpdateRequest | Request object used to Update a catalogs product group.
|
|
256
|
+
|
|
257
|
+
begin
|
|
258
|
+
# Update product group
|
|
259
|
+
result = api_instance.catalogs_product_groups_update(product_group_id, catalogs_product_group_update_request)
|
|
260
|
+
p result
|
|
261
|
+
rescue PinterestSdkClient::ApiError => e
|
|
262
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_update: #{e}"
|
|
263
|
+
end
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
#### Using the catalogs_product_groups_update_with_http_info variant
|
|
267
|
+
|
|
268
|
+
This returns an Array which contains the response data, status code and headers.
|
|
269
|
+
|
|
270
|
+
> <Array(<CatalogsProductGroup>, Integer, Hash)> catalogs_product_groups_update_with_http_info(product_group_id, catalogs_product_group_update_request)
|
|
271
|
+
|
|
272
|
+
```ruby
|
|
273
|
+
begin
|
|
274
|
+
# Update product group
|
|
275
|
+
data, status_code, headers = api_instance.catalogs_product_groups_update_with_http_info(product_group_id, catalogs_product_group_update_request)
|
|
276
|
+
p status_code # => 2xx
|
|
277
|
+
p headers # => { ... }
|
|
278
|
+
p data # => <CatalogsProductGroup>
|
|
279
|
+
rescue PinterestSdkClient::ApiError => e
|
|
280
|
+
puts "Error when calling CatalogsApi->catalogs_product_groups_update_with_http_info: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
| Name | Type | Description | Notes |
|
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
|
288
|
+
| **product_group_id** | **String** | Unique identifier of a product group | |
|
|
289
|
+
| **catalogs_product_group_update_request** | [**CatalogsProductGroupUpdateRequest**](CatalogsProductGroupUpdateRequest.md) | Request object used to Update a catalogs product group. | |
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
[**CatalogsProductGroup**](CatalogsProductGroup.md)
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: application/json
|
|
302
|
+
- **Accept**: application/json
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
## feed_processing_results_list
|
|
306
|
+
|
|
307
|
+
> <Paginated> feed_processing_results_list(feed_id, opts)
|
|
308
|
+
|
|
309
|
+
List processing results for a given feed
|
|
310
|
+
|
|
311
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Fetch a feed processing results owned by the owner user account.
|
|
312
|
+
|
|
313
|
+
### Examples
|
|
314
|
+
|
|
315
|
+
```ruby
|
|
316
|
+
require 'time'
|
|
317
|
+
require 'pinterest_sdk'
|
|
318
|
+
# setup authorization
|
|
319
|
+
PinterestSdkClient.configure do |config|
|
|
320
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
321
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
325
|
+
feed_id = 'feed_id_example' # String | Unique identifier of a feed
|
|
326
|
+
opts = {
|
|
327
|
+
bookmark: 'bookmark_example', # String | Cursor used to fetch the next page of items
|
|
328
|
+
page_size: 56 # Integer | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# List processing results for a given feed
|
|
333
|
+
result = api_instance.feed_processing_results_list(feed_id, opts)
|
|
334
|
+
p result
|
|
335
|
+
rescue PinterestSdkClient::ApiError => e
|
|
336
|
+
puts "Error when calling CatalogsApi->feed_processing_results_list: #{e}"
|
|
337
|
+
end
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
#### Using the feed_processing_results_list_with_http_info variant
|
|
341
|
+
|
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
|
343
|
+
|
|
344
|
+
> <Array(<Paginated>, Integer, Hash)> feed_processing_results_list_with_http_info(feed_id, opts)
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
begin
|
|
348
|
+
# List processing results for a given feed
|
|
349
|
+
data, status_code, headers = api_instance.feed_processing_results_list_with_http_info(feed_id, opts)
|
|
350
|
+
p status_code # => 2xx
|
|
351
|
+
p headers # => { ... }
|
|
352
|
+
p data # => <Paginated>
|
|
353
|
+
rescue PinterestSdkClient::ApiError => e
|
|
354
|
+
puts "Error when calling CatalogsApi->feed_processing_results_list_with_http_info: #{e}"
|
|
355
|
+
end
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Parameters
|
|
359
|
+
|
|
360
|
+
| Name | Type | Description | Notes |
|
|
361
|
+
| ---- | ---- | ----------- | ----- |
|
|
362
|
+
| **feed_id** | **String** | Unique identifier of a feed | |
|
|
363
|
+
| **bookmark** | **String** | Cursor used to fetch the next page of items | [optional] |
|
|
364
|
+
| **page_size** | **Integer** | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information. | [optional][default to 25] |
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
[**Paginated**](Paginated.md)
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: Not defined
|
|
377
|
+
- **Accept**: application/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
## feeds_create
|
|
381
|
+
|
|
382
|
+
> <CatalogsFeed> feeds_create(catalogs_feeds_create_request)
|
|
383
|
+
|
|
384
|
+
Create feed
|
|
385
|
+
|
|
386
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Create a new feed owned by the \"operating user_account\".
|
|
387
|
+
|
|
388
|
+
### Examples
|
|
389
|
+
|
|
390
|
+
```ruby
|
|
391
|
+
require 'time'
|
|
392
|
+
require 'pinterest_sdk'
|
|
393
|
+
# setup authorization
|
|
394
|
+
PinterestSdkClient.configure do |config|
|
|
395
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
396
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
400
|
+
catalogs_feeds_create_request = PinterestSdkClient::CatalogsFeedsCreateRequest.new({name: 'name_example', format: PinterestSdkClient::CatalogsFormat::TSV, location: 'location_example'}) # CatalogsFeedsCreateRequest | Request object used to created a feed.
|
|
401
|
+
|
|
402
|
+
begin
|
|
403
|
+
# Create feed
|
|
404
|
+
result = api_instance.feeds_create(catalogs_feeds_create_request)
|
|
405
|
+
p result
|
|
406
|
+
rescue PinterestSdkClient::ApiError => e
|
|
407
|
+
puts "Error when calling CatalogsApi->feeds_create: #{e}"
|
|
408
|
+
end
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
#### Using the feeds_create_with_http_info variant
|
|
412
|
+
|
|
413
|
+
This returns an Array which contains the response data, status code and headers.
|
|
414
|
+
|
|
415
|
+
> <Array(<CatalogsFeed>, Integer, Hash)> feeds_create_with_http_info(catalogs_feeds_create_request)
|
|
416
|
+
|
|
417
|
+
```ruby
|
|
418
|
+
begin
|
|
419
|
+
# Create feed
|
|
420
|
+
data, status_code, headers = api_instance.feeds_create_with_http_info(catalogs_feeds_create_request)
|
|
421
|
+
p status_code # => 2xx
|
|
422
|
+
p headers # => { ... }
|
|
423
|
+
p data # => <CatalogsFeed>
|
|
424
|
+
rescue PinterestSdkClient::ApiError => e
|
|
425
|
+
puts "Error when calling CatalogsApi->feeds_create_with_http_info: #{e}"
|
|
426
|
+
end
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
### Parameters
|
|
430
|
+
|
|
431
|
+
| Name | Type | Description | Notes |
|
|
432
|
+
| ---- | ---- | ----------- | ----- |
|
|
433
|
+
| **catalogs_feeds_create_request** | [**CatalogsFeedsCreateRequest**](CatalogsFeedsCreateRequest.md) | Request object used to created a feed. | |
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
[**CatalogsFeed**](CatalogsFeed.md)
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: application/json
|
|
446
|
+
- **Accept**: application/json
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
## feeds_delete
|
|
450
|
+
|
|
451
|
+
> feeds_delete(feed_id)
|
|
452
|
+
|
|
453
|
+
Delete feed
|
|
454
|
+
|
|
455
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Delete a feed owned by the \"operating user_account\".
|
|
456
|
+
|
|
457
|
+
### Examples
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
require 'time'
|
|
461
|
+
require 'pinterest_sdk'
|
|
462
|
+
# setup authorization
|
|
463
|
+
PinterestSdkClient.configure do |config|
|
|
464
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
465
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
469
|
+
feed_id = 'feed_id_example' # String | Unique identifier of a feed
|
|
470
|
+
|
|
471
|
+
begin
|
|
472
|
+
# Delete feed
|
|
473
|
+
api_instance.feeds_delete(feed_id)
|
|
474
|
+
rescue PinterestSdkClient::ApiError => e
|
|
475
|
+
puts "Error when calling CatalogsApi->feeds_delete: #{e}"
|
|
476
|
+
end
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
#### Using the feeds_delete_with_http_info variant
|
|
480
|
+
|
|
481
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
482
|
+
|
|
483
|
+
> <Array(nil, Integer, Hash)> feeds_delete_with_http_info(feed_id)
|
|
484
|
+
|
|
485
|
+
```ruby
|
|
486
|
+
begin
|
|
487
|
+
# Delete feed
|
|
488
|
+
data, status_code, headers = api_instance.feeds_delete_with_http_info(feed_id)
|
|
489
|
+
p status_code # => 2xx
|
|
490
|
+
p headers # => { ... }
|
|
491
|
+
p data # => nil
|
|
492
|
+
rescue PinterestSdkClient::ApiError => e
|
|
493
|
+
puts "Error when calling CatalogsApi->feeds_delete_with_http_info: #{e}"
|
|
494
|
+
end
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
### Parameters
|
|
498
|
+
|
|
499
|
+
| Name | Type | Description | Notes |
|
|
500
|
+
| ---- | ---- | ----------- | ----- |
|
|
501
|
+
| **feed_id** | **String** | Unique identifier of a feed | |
|
|
502
|
+
|
|
503
|
+
### Return type
|
|
504
|
+
|
|
505
|
+
nil (empty response body)
|
|
506
|
+
|
|
507
|
+
### Authorization
|
|
508
|
+
|
|
509
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
510
|
+
|
|
511
|
+
### HTTP request headers
|
|
512
|
+
|
|
513
|
+
- **Content-Type**: Not defined
|
|
514
|
+
- **Accept**: application/json
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
## feeds_get
|
|
518
|
+
|
|
519
|
+
> <CatalogsFeed> feeds_get(feed_id)
|
|
520
|
+
|
|
521
|
+
Get feed
|
|
522
|
+
|
|
523
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Get a single feed owned by the \"operating user_account\".
|
|
524
|
+
|
|
525
|
+
### Examples
|
|
526
|
+
|
|
527
|
+
```ruby
|
|
528
|
+
require 'time'
|
|
529
|
+
require 'pinterest_sdk'
|
|
530
|
+
# setup authorization
|
|
531
|
+
PinterestSdkClient.configure do |config|
|
|
532
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
533
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
534
|
+
end
|
|
535
|
+
|
|
536
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
537
|
+
feed_id = 'feed_id_example' # String | Unique identifier of a feed
|
|
538
|
+
|
|
539
|
+
begin
|
|
540
|
+
# Get feed
|
|
541
|
+
result = api_instance.feeds_get(feed_id)
|
|
542
|
+
p result
|
|
543
|
+
rescue PinterestSdkClient::ApiError => e
|
|
544
|
+
puts "Error when calling CatalogsApi->feeds_get: #{e}"
|
|
545
|
+
end
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
#### Using the feeds_get_with_http_info variant
|
|
549
|
+
|
|
550
|
+
This returns an Array which contains the response data, status code and headers.
|
|
551
|
+
|
|
552
|
+
> <Array(<CatalogsFeed>, Integer, Hash)> feeds_get_with_http_info(feed_id)
|
|
553
|
+
|
|
554
|
+
```ruby
|
|
555
|
+
begin
|
|
556
|
+
# Get feed
|
|
557
|
+
data, status_code, headers = api_instance.feeds_get_with_http_info(feed_id)
|
|
558
|
+
p status_code # => 2xx
|
|
559
|
+
p headers # => { ... }
|
|
560
|
+
p data # => <CatalogsFeed>
|
|
561
|
+
rescue PinterestSdkClient::ApiError => e
|
|
562
|
+
puts "Error when calling CatalogsApi->feeds_get_with_http_info: #{e}"
|
|
563
|
+
end
|
|
564
|
+
```
|
|
565
|
+
|
|
566
|
+
### Parameters
|
|
567
|
+
|
|
568
|
+
| Name | Type | Description | Notes |
|
|
569
|
+
| ---- | ---- | ----------- | ----- |
|
|
570
|
+
| **feed_id** | **String** | Unique identifier of a feed | |
|
|
571
|
+
|
|
572
|
+
### Return type
|
|
573
|
+
|
|
574
|
+
[**CatalogsFeed**](CatalogsFeed.md)
|
|
575
|
+
|
|
576
|
+
### Authorization
|
|
577
|
+
|
|
578
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
579
|
+
|
|
580
|
+
### HTTP request headers
|
|
581
|
+
|
|
582
|
+
- **Content-Type**: Not defined
|
|
583
|
+
- **Accept**: application/json
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
## feeds_list
|
|
587
|
+
|
|
588
|
+
> <Paginated> feeds_list(opts)
|
|
589
|
+
|
|
590
|
+
List feeds
|
|
591
|
+
|
|
592
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Fetch feeds owned by the \"operating user_account\".
|
|
593
|
+
|
|
594
|
+
### Examples
|
|
595
|
+
|
|
596
|
+
```ruby
|
|
597
|
+
require 'time'
|
|
598
|
+
require 'pinterest_sdk'
|
|
599
|
+
# setup authorization
|
|
600
|
+
PinterestSdkClient.configure do |config|
|
|
601
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
602
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
603
|
+
end
|
|
604
|
+
|
|
605
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
606
|
+
opts = {
|
|
607
|
+
bookmark: 'bookmark_example', # String | Cursor used to fetch the next page of items
|
|
608
|
+
page_size: 56 # Integer | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
begin
|
|
612
|
+
# List feeds
|
|
613
|
+
result = api_instance.feeds_list(opts)
|
|
614
|
+
p result
|
|
615
|
+
rescue PinterestSdkClient::ApiError => e
|
|
616
|
+
puts "Error when calling CatalogsApi->feeds_list: #{e}"
|
|
617
|
+
end
|
|
618
|
+
```
|
|
619
|
+
|
|
620
|
+
#### Using the feeds_list_with_http_info variant
|
|
621
|
+
|
|
622
|
+
This returns an Array which contains the response data, status code and headers.
|
|
623
|
+
|
|
624
|
+
> <Array(<Paginated>, Integer, Hash)> feeds_list_with_http_info(opts)
|
|
625
|
+
|
|
626
|
+
```ruby
|
|
627
|
+
begin
|
|
628
|
+
# List feeds
|
|
629
|
+
data, status_code, headers = api_instance.feeds_list_with_http_info(opts)
|
|
630
|
+
p status_code # => 2xx
|
|
631
|
+
p headers # => { ... }
|
|
632
|
+
p data # => <Paginated>
|
|
633
|
+
rescue PinterestSdkClient::ApiError => e
|
|
634
|
+
puts "Error when calling CatalogsApi->feeds_list_with_http_info: #{e}"
|
|
635
|
+
end
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
### Parameters
|
|
639
|
+
|
|
640
|
+
| Name | Type | Description | Notes |
|
|
641
|
+
| ---- | ---- | ----------- | ----- |
|
|
642
|
+
| **bookmark** | **String** | Cursor used to fetch the next page of items | [optional] |
|
|
643
|
+
| **page_size** | **Integer** | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information. | [optional][default to 25] |
|
|
644
|
+
|
|
645
|
+
### Return type
|
|
646
|
+
|
|
647
|
+
[**Paginated**](Paginated.md)
|
|
648
|
+
|
|
649
|
+
### Authorization
|
|
650
|
+
|
|
651
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
652
|
+
|
|
653
|
+
### HTTP request headers
|
|
654
|
+
|
|
655
|
+
- **Content-Type**: Not defined
|
|
656
|
+
- **Accept**: application/json
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
## feeds_update
|
|
660
|
+
|
|
661
|
+
> <CatalogsFeed> feeds_update(feed_id, catalogs_feeds_update_request)
|
|
662
|
+
|
|
663
|
+
Update feed
|
|
664
|
+
|
|
665
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Update a feed owned by the \"operating user_account\".
|
|
666
|
+
|
|
667
|
+
### Examples
|
|
668
|
+
|
|
669
|
+
```ruby
|
|
670
|
+
require 'time'
|
|
671
|
+
require 'pinterest_sdk'
|
|
672
|
+
# setup authorization
|
|
673
|
+
PinterestSdkClient.configure do |config|
|
|
674
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
675
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
676
|
+
end
|
|
677
|
+
|
|
678
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
679
|
+
feed_id = 'feed_id_example' # String | Unique identifier of a feed
|
|
680
|
+
catalogs_feeds_update_request = PinterestSdkClient::CatalogsFeedsUpdateRequest.new # CatalogsFeedsUpdateRequest | Request object used to update a feed.
|
|
681
|
+
|
|
682
|
+
begin
|
|
683
|
+
# Update feed
|
|
684
|
+
result = api_instance.feeds_update(feed_id, catalogs_feeds_update_request)
|
|
685
|
+
p result
|
|
686
|
+
rescue PinterestSdkClient::ApiError => e
|
|
687
|
+
puts "Error when calling CatalogsApi->feeds_update: #{e}"
|
|
688
|
+
end
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
#### Using the feeds_update_with_http_info variant
|
|
692
|
+
|
|
693
|
+
This returns an Array which contains the response data, status code and headers.
|
|
694
|
+
|
|
695
|
+
> <Array(<CatalogsFeed>, Integer, Hash)> feeds_update_with_http_info(feed_id, catalogs_feeds_update_request)
|
|
696
|
+
|
|
697
|
+
```ruby
|
|
698
|
+
begin
|
|
699
|
+
# Update feed
|
|
700
|
+
data, status_code, headers = api_instance.feeds_update_with_http_info(feed_id, catalogs_feeds_update_request)
|
|
701
|
+
p status_code # => 2xx
|
|
702
|
+
p headers # => { ... }
|
|
703
|
+
p data # => <CatalogsFeed>
|
|
704
|
+
rescue PinterestSdkClient::ApiError => e
|
|
705
|
+
puts "Error when calling CatalogsApi->feeds_update_with_http_info: #{e}"
|
|
706
|
+
end
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
### Parameters
|
|
710
|
+
|
|
711
|
+
| Name | Type | Description | Notes |
|
|
712
|
+
| ---- | ---- | ----------- | ----- |
|
|
713
|
+
| **feed_id** | **String** | Unique identifier of a feed | |
|
|
714
|
+
| **catalogs_feeds_update_request** | [**CatalogsFeedsUpdateRequest**](CatalogsFeedsUpdateRequest.md) | Request object used to update a feed. | |
|
|
715
|
+
|
|
716
|
+
### Return type
|
|
717
|
+
|
|
718
|
+
[**CatalogsFeed**](CatalogsFeed.md)
|
|
719
|
+
|
|
720
|
+
### Authorization
|
|
721
|
+
|
|
722
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
723
|
+
|
|
724
|
+
### HTTP request headers
|
|
725
|
+
|
|
726
|
+
- **Content-Type**: application/json
|
|
727
|
+
- **Accept**: application/json
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
## items_batch_get
|
|
731
|
+
|
|
732
|
+
> <CatalogsItemsBatch> items_batch_get(batch_id)
|
|
733
|
+
|
|
734
|
+
Get catalogs items batch
|
|
735
|
+
|
|
736
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> Get a single catalogs items batch created by the \"operating user_account\".
|
|
737
|
+
|
|
738
|
+
### Examples
|
|
739
|
+
|
|
740
|
+
```ruby
|
|
741
|
+
require 'time'
|
|
742
|
+
require 'pinterest_sdk'
|
|
743
|
+
# setup authorization
|
|
744
|
+
PinterestSdkClient.configure do |config|
|
|
745
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
746
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
747
|
+
end
|
|
748
|
+
|
|
749
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
750
|
+
batch_id = '595953100599279259-66753b9bb65c46c49bd8503b27fecf9e' # String | Id of a catalogs items batch to fetch
|
|
751
|
+
|
|
752
|
+
begin
|
|
753
|
+
# Get catalogs items batch
|
|
754
|
+
result = api_instance.items_batch_get(batch_id)
|
|
755
|
+
p result
|
|
756
|
+
rescue PinterestSdkClient::ApiError => e
|
|
757
|
+
puts "Error when calling CatalogsApi->items_batch_get: #{e}"
|
|
758
|
+
end
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
#### Using the items_batch_get_with_http_info variant
|
|
762
|
+
|
|
763
|
+
This returns an Array which contains the response data, status code and headers.
|
|
764
|
+
|
|
765
|
+
> <Array(<CatalogsItemsBatch>, Integer, Hash)> items_batch_get_with_http_info(batch_id)
|
|
766
|
+
|
|
767
|
+
```ruby
|
|
768
|
+
begin
|
|
769
|
+
# Get catalogs items batch
|
|
770
|
+
data, status_code, headers = api_instance.items_batch_get_with_http_info(batch_id)
|
|
771
|
+
p status_code # => 2xx
|
|
772
|
+
p headers # => { ... }
|
|
773
|
+
p data # => <CatalogsItemsBatch>
|
|
774
|
+
rescue PinterestSdkClient::ApiError => e
|
|
775
|
+
puts "Error when calling CatalogsApi->items_batch_get_with_http_info: #{e}"
|
|
776
|
+
end
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Parameters
|
|
780
|
+
|
|
781
|
+
| Name | Type | Description | Notes |
|
|
782
|
+
| ---- | ---- | ----------- | ----- |
|
|
783
|
+
| **batch_id** | **String** | Id of a catalogs items batch to fetch | |
|
|
784
|
+
|
|
785
|
+
### Return type
|
|
786
|
+
|
|
787
|
+
[**CatalogsItemsBatch**](CatalogsItemsBatch.md)
|
|
788
|
+
|
|
789
|
+
### Authorization
|
|
790
|
+
|
|
791
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
792
|
+
|
|
793
|
+
### HTTP request headers
|
|
794
|
+
|
|
795
|
+
- **Content-Type**: Not defined
|
|
796
|
+
- **Accept**: application/json
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
## items_batch_post
|
|
800
|
+
|
|
801
|
+
> <CatalogsItemsBatch> items_batch_post(catalogs_items_batch_request)
|
|
802
|
+
|
|
803
|
+
Perform an operation on an item batch
|
|
804
|
+
|
|
805
|
+
<strong>This endpoint is currently in beta and not available to all apps. <a href='/docs/api/v5/#tag/Understanding-catalog-management'>Learn more</a>.</strong> This endpoint supports multiple operations on a set of one or more catalog items.
|
|
806
|
+
|
|
807
|
+
### Examples
|
|
808
|
+
|
|
809
|
+
```ruby
|
|
810
|
+
require 'time'
|
|
811
|
+
require 'pinterest_sdk'
|
|
812
|
+
# setup authorization
|
|
813
|
+
PinterestSdkClient.configure do |config|
|
|
814
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
815
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
816
|
+
end
|
|
817
|
+
|
|
818
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
819
|
+
catalogs_items_batch_request = PinterestSdkClient::CatalogsItemsBatchRequest.new # CatalogsItemsBatchRequest | Request object used to create catalogs items in a batch
|
|
820
|
+
|
|
821
|
+
begin
|
|
822
|
+
# Perform an operation on an item batch
|
|
823
|
+
result = api_instance.items_batch_post(catalogs_items_batch_request)
|
|
824
|
+
p result
|
|
825
|
+
rescue PinterestSdkClient::ApiError => e
|
|
826
|
+
puts "Error when calling CatalogsApi->items_batch_post: #{e}"
|
|
827
|
+
end
|
|
828
|
+
```
|
|
829
|
+
|
|
830
|
+
#### Using the items_batch_post_with_http_info variant
|
|
831
|
+
|
|
832
|
+
This returns an Array which contains the response data, status code and headers.
|
|
833
|
+
|
|
834
|
+
> <Array(<CatalogsItemsBatch>, Integer, Hash)> items_batch_post_with_http_info(catalogs_items_batch_request)
|
|
835
|
+
|
|
836
|
+
```ruby
|
|
837
|
+
begin
|
|
838
|
+
# Perform an operation on an item batch
|
|
839
|
+
data, status_code, headers = api_instance.items_batch_post_with_http_info(catalogs_items_batch_request)
|
|
840
|
+
p status_code # => 2xx
|
|
841
|
+
p headers # => { ... }
|
|
842
|
+
p data # => <CatalogsItemsBatch>
|
|
843
|
+
rescue PinterestSdkClient::ApiError => e
|
|
844
|
+
puts "Error when calling CatalogsApi->items_batch_post_with_http_info: #{e}"
|
|
845
|
+
end
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
### Parameters
|
|
849
|
+
|
|
850
|
+
| Name | Type | Description | Notes |
|
|
851
|
+
| ---- | ---- | ----------- | ----- |
|
|
852
|
+
| **catalogs_items_batch_request** | [**CatalogsItemsBatchRequest**](CatalogsItemsBatchRequest.md) | Request object used to create catalogs items in a batch | |
|
|
853
|
+
|
|
854
|
+
### Return type
|
|
855
|
+
|
|
856
|
+
[**CatalogsItemsBatch**](CatalogsItemsBatch.md)
|
|
857
|
+
|
|
858
|
+
### Authorization
|
|
859
|
+
|
|
860
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
861
|
+
|
|
862
|
+
### HTTP request headers
|
|
863
|
+
|
|
864
|
+
- **Content-Type**: application/json
|
|
865
|
+
- **Accept**: application/json
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
## items_get
|
|
869
|
+
|
|
870
|
+
> <CatalogsItems> items_get(country, item_ids, language)
|
|
871
|
+
|
|
872
|
+
Get catalogs items
|
|
873
|
+
|
|
874
|
+
Get the items of the catalog created by the \"operating user_account\"
|
|
875
|
+
|
|
876
|
+
### Examples
|
|
877
|
+
|
|
878
|
+
```ruby
|
|
879
|
+
require 'time'
|
|
880
|
+
require 'pinterest_sdk'
|
|
881
|
+
# setup authorization
|
|
882
|
+
PinterestSdkClient.configure do |config|
|
|
883
|
+
# Configure OAuth2 access token for authorization: pinterest_oauth2
|
|
884
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
885
|
+
end
|
|
886
|
+
|
|
887
|
+
api_instance = PinterestSdkClient::CatalogsApi.new
|
|
888
|
+
country = 'US' # String | Country for the Catalogs Items
|
|
889
|
+
item_ids = ['inner_example'] # Array<String> | Catalos Item ids
|
|
890
|
+
language = 'EN' # String | Language for the Catalogs Items
|
|
891
|
+
|
|
892
|
+
begin
|
|
893
|
+
# Get catalogs items
|
|
894
|
+
result = api_instance.items_get(country, item_ids, language)
|
|
895
|
+
p result
|
|
896
|
+
rescue PinterestSdkClient::ApiError => e
|
|
897
|
+
puts "Error when calling CatalogsApi->items_get: #{e}"
|
|
898
|
+
end
|
|
899
|
+
```
|
|
900
|
+
|
|
901
|
+
#### Using the items_get_with_http_info variant
|
|
902
|
+
|
|
903
|
+
This returns an Array which contains the response data, status code and headers.
|
|
904
|
+
|
|
905
|
+
> <Array(<CatalogsItems>, Integer, Hash)> items_get_with_http_info(country, item_ids, language)
|
|
906
|
+
|
|
907
|
+
```ruby
|
|
908
|
+
begin
|
|
909
|
+
# Get catalogs items
|
|
910
|
+
data, status_code, headers = api_instance.items_get_with_http_info(country, item_ids, language)
|
|
911
|
+
p status_code # => 2xx
|
|
912
|
+
p headers # => { ... }
|
|
913
|
+
p data # => <CatalogsItems>
|
|
914
|
+
rescue PinterestSdkClient::ApiError => e
|
|
915
|
+
puts "Error when calling CatalogsApi->items_get_with_http_info: #{e}"
|
|
916
|
+
end
|
|
917
|
+
```
|
|
918
|
+
|
|
919
|
+
### Parameters
|
|
920
|
+
|
|
921
|
+
| Name | Type | Description | Notes |
|
|
922
|
+
| ---- | ---- | ----------- | ----- |
|
|
923
|
+
| **country** | **String** | Country for the Catalogs Items | |
|
|
924
|
+
| **item_ids** | [**Array<String>**](String.md) | Catalos Item ids | |
|
|
925
|
+
| **language** | **String** | Language for the Catalogs Items | |
|
|
926
|
+
|
|
927
|
+
### Return type
|
|
928
|
+
|
|
929
|
+
[**CatalogsItems**](CatalogsItems.md)
|
|
930
|
+
|
|
931
|
+
### Authorization
|
|
932
|
+
|
|
933
|
+
[pinterest_oauth2](../README.md#pinterest_oauth2)
|
|
934
|
+
|
|
935
|
+
### HTTP request headers
|
|
936
|
+
|
|
937
|
+
- **Content-Type**: Not defined
|
|
938
|
+
- **Accept**: application/json
|
|
939
|
+
|