pinterest_sdk 1.1.0 → 2.1.0

data/lib/pinterest_sdk/api/catalog_feeds_api.rb

@@ -0,0 +1,718 @@
+=begin
+#Pinterest REST API
+
+#Pinterest's REST API
+
+The version of the OpenAPI document: 5.28.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module PinterestSdkClient
+  class CatalogFeedsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List feed processing results
+    # Fetch a feed processing results owned by the \"operation user_account\". Please note that for now the bookmark parameter is not functional and only the first page will be available until it is implemented in some release in the near future. - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  [Learn more](/docs/api-features/shopping-overview/)
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @return [FeedProcessingResultsList200Response]
+    def feed_processing_results_list(feed_id, opts = {})
+      data, _status_code, _headers = feed_processing_results_list_with_http_info(feed_id, opts)
+      data
+    end
+
+    # List feed processing results
+    # Fetch a feed processing results owned by the \"operation user_account\". Please note that for now the bookmark parameter is not functional and only the first page will be available until it is implemented in some release in the near future. - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  [Learn more](/docs/api-features/shopping-overview/)
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @return [Array<(FeedProcessingResultsList200Response, Integer, Hash)>] FeedProcessingResultsList200Response data, response status code and response headers
+    def feed_processing_results_list_with_http_info(feed_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feed_processing_results_list ...'
+      end
+      # verify the required parameter 'feed_id' is set
+      if @api_client.config.client_side_validation && feed_id.nil?
+        fail ArgumentError, "Missing the required parameter 'feed_id' when calling CatalogFeedsApi.feed_processing_results_list"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && feed_id !~ pattern
+        fail ArgumentError, "invalid value for 'feed_id' when calling CatalogFeedsApi.feed_processing_results_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feed_processing_results_list, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feed_processing_results_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogFeedsApi.feed_processing_results_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogFeedsApi.feed_processing_results_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds/{feed_id}/processing_results'.sub('{feed_id}', CGI.escape(feed_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+      query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FeedProcessingResultsList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feed_processing_results_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feed_processing_results_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create feed
+    # Create a new feed owned by the \"operation user_account\". - By default, the \"operation user_account\" is the token user_account.  Please, be aware that \"default_country\" and \"default_locale\" are not required in the spec for forward compatibility but for now the API will not accept requests without those fields.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).  Note: Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager.
+    # @param catalogs_feed_create_request_schema [CatalogsFeedCreateRequestSchema] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [CatalogsFeed]
+    def feeds_create(catalogs_feed_create_request_schema, opts = {})
+      data, _status_code, _headers = feeds_create_with_http_info(catalogs_feed_create_request_schema, opts)
+      data
+    end
+
+    # Create feed
+    # Create a new feed owned by the \&quot;operation user_account\&quot;. - By default, the \&quot;operation user_account\&quot; is the token user_account.  Please, be aware that \&quot;default_country\&quot; and \&quot;default_locale\&quot; are not required in the spec for forward compatibility but for now the API will not accept requests without those fields.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).  Note: Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager.
+    # @param catalogs_feed_create_request_schema [CatalogsFeedCreateRequestSchema] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [Array<(CatalogsFeed, Integer, Hash)>] CatalogsFeed data, response status code and response headers
+    def feeds_create_with_http_info(catalogs_feed_create_request_schema, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feeds_create ...'
+      end
+      # verify the required parameter 'catalogs_feed_create_request_schema' is set
+      if @api_client.config.client_side_validation && catalogs_feed_create_request_schema.nil?
+        fail ArgumentError, "Missing the required parameter 'catalogs_feed_create_request_schema' when calling CatalogFeedsApi.feeds_create"
+      end
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feeds_create, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feeds_create, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(catalogs_feed_create_request_schema)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogsFeed'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feeds_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feeds_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete feed
+    # Delete a feed owned by the \"operation user_account\". - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [CatalogsFeed]
+    def feeds_delete(feed_id, opts = {})
+      data, _status_code, _headers = feeds_delete_with_http_info(feed_id, opts)
+      data
+    end
+
+    # Delete feed
+    # Delete a feed owned by the \&quot;operation user_account\&quot;. - By default, the \&quot;operation user_account\&quot; is the token user_account.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [Array<(CatalogsFeed, Integer, Hash)>] CatalogsFeed data, response status code and response headers
+    def feeds_delete_with_http_info(feed_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feeds_delete ...'
+      end
+      # verify the required parameter 'feed_id' is set
+      if @api_client.config.client_side_validation && feed_id.nil?
+        fail ArgumentError, "Missing the required parameter 'feed_id' when calling CatalogFeedsApi.feeds_delete"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && feed_id !~ pattern
+        fail ArgumentError, "invalid value for 'feed_id' when calling CatalogFeedsApi.feeds_delete, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feeds_delete, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feeds_delete, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds/{feed_id}'.sub('{feed_id}', CGI.escape(feed_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogsFeed'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feeds_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feeds_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get feed
+    # Get a single feed owned by the \"operation user_account\". - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [CatalogsFeed]
+    def feeds_get(feed_id, opts = {})
+      data, _status_code, _headers = feeds_get_with_http_info(feed_id, opts)
+      data
+    end
+
+    # Get feed
+    # Get a single feed owned by the \&quot;operation user_account\&quot;. - By default, the \&quot;operation user_account\&quot; is the token user_account.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [Array<(CatalogsFeed, Integer, Hash)>] CatalogsFeed data, response status code and response headers
+    def feeds_get_with_http_info(feed_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feeds_get ...'
+      end
+      # verify the required parameter 'feed_id' is set
+      if @api_client.config.client_side_validation && feed_id.nil?
+        fail ArgumentError, "Missing the required parameter 'feed_id' when calling CatalogFeedsApi.feeds_get"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && feed_id !~ pattern
+        fail ArgumentError, "invalid value for 'feed_id' when calling CatalogFeedsApi.feeds_get, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feeds_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feeds_get, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds/{feed_id}'.sub('{feed_id}', CGI.escape(feed_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogsFeed'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feeds_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feeds_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Ingest feed items
+    # Ingest items for a given feed owned by the \"operation user_account\".  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  [Learn more](/docs/api-features/shopping-overview/)  Note: This endpoint is restricted to a specific group of users. If you require access, please reach out to your partner manager.
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [CatalogsFeedIngestion]
+    def feeds_ingest(feed_id, opts = {})
+      data, _status_code, _headers = feeds_ingest_with_http_info(feed_id, opts)
+      data
+    end
+
+    # Ingest feed items
+    # Ingest items for a given feed owned by the \&quot;operation user_account\&quot;.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  [Learn more](/docs/api-features/shopping-overview/)  Note: This endpoint is restricted to a specific group of users. If you require access, please reach out to your partner manager.
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [Array<(CatalogsFeedIngestion, Integer, Hash)>] CatalogsFeedIngestion data, response status code and response headers
+    def feeds_ingest_with_http_info(feed_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feeds_ingest ...'
+      end
+      # verify the required parameter 'feed_id' is set
+      if @api_client.config.client_side_validation && feed_id.nil?
+        fail ArgumentError, "Missing the required parameter 'feed_id' when calling CatalogFeedsApi.feeds_ingest"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && feed_id !~ pattern
+        fail ArgumentError, "invalid value for 'feed_id' when calling CatalogFeedsApi.feeds_ingest, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feeds_ingest, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feeds_ingest, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds/{feed_id}/ingest'.sub('{feed_id}', CGI.escape(feed_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogsFeedIngestion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feeds_ingest",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feeds_ingest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List feeds
+    # Fetch feeds owned by the \"operation user_account\". - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :catalog_id Filter entities for a given catalog_id. If not given, all catalogs are considered.
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @return [FeedsList200Response]
+    def feeds_list(opts = {})
+      data, _status_code, _headers = feeds_list_with_http_info(opts)
+      data
+    end
+
+    # List feeds
+    # Fetch feeds owned by the \&quot;operation user_account\&quot;. - By default, the \&quot;operation user_account\&quot; is the token user_account.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :catalog_id Filter entities for a given catalog_id. If not given, all catalogs are considered.
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @return [Array<(FeedsList200Response, Integer, Hash)>] FeedsList200Response data, response status code and response headers
+    def feeds_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feeds_list ...'
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'catalog_id'].nil? && opts[:'catalog_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"catalog_id\"]' when calling CatalogFeedsApi.feeds_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feeds_list, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feeds_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogFeedsApi.feeds_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogFeedsApi.feeds_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'catalog_id'] = opts[:'catalog_id'] if !opts[:'catalog_id'].nil?
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+      query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FeedsList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feeds_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feeds_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update feed
+    # Update a feed owned by the \"operation user_account\". - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).  Note: Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager.
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param catalogs_feed_update_request_schema [CatalogsFeedUpdateRequestSchema] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [CatalogsFeed]
+    def feeds_update(feed_id, catalogs_feed_update_request_schema, opts = {})
+      data, _status_code, _headers = feeds_update_with_http_info(feed_id, catalogs_feed_update_request_schema, opts)
+      data
+    end
+
+    # Update feed
+    # Update a feed owned by the \&quot;operation user_account\&quot;. - By default, the \&quot;operation user_account\&quot; is the token user_account.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  For Retail partners, refer to [Before you get started with Catalogs](https://help.pinterest.com/en/business/article/before-you-get-started-with-catalogs). For Hotel partners, refer to [Pinterest API for shopping](/docs/api-features/shopping-overview/).  Note: Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager.
+    # @param feed_id [String] Unique identifier of a feed.
+    # @param catalogs_feed_update_request_schema [CatalogsFeedUpdateRequestSchema] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @return [Array<(CatalogsFeed, Integer, Hash)>] CatalogsFeed data, response status code and response headers
+    def feeds_update_with_http_info(feed_id, catalogs_feed_update_request_schema, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.feeds_update ...'
+      end
+      # verify the required parameter 'feed_id' is set
+      if @api_client.config.client_side_validation && feed_id.nil?
+        fail ArgumentError, "Missing the required parameter 'feed_id' when calling CatalogFeedsApi.feeds_update"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && feed_id !~ pattern
+        fail ArgumentError, "invalid value for 'feed_id' when calling CatalogFeedsApi.feeds_update, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'catalogs_feed_update_request_schema' is set
+      if @api_client.config.client_side_validation && catalogs_feed_update_request_schema.nil?
+        fail ArgumentError, "Missing the required parameter 'catalogs_feed_update_request_schema' when calling CatalogFeedsApi.feeds_update"
+      end
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.feeds_update, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.feeds_update, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/catalogs/feeds/{feed_id}'.sub('{feed_id}', CGI.escape(feed_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(catalogs_feed_update_request_schema)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogsFeed'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.feeds_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#feeds_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List item issues
+    # List item validation issues for a given feed processing result owned by the \"operation user_account\". Up to 20 random samples of affected items are returned for each error and warning code. Please note that for now query parameters 'item_numbers' and 'item_validation_issue' cannot be used simultaneously until it is implemented in some release in the future. - By default, the \"operation user_account\" is the token user_account.  Optional: Business Access: Specify an `ad_account_id` (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  Note: To get a list of all affected items instead of sampled issues, please refer to [Build catalogs report](/docs/api/v5/#operation/reports/create) and [Get catalogs report](/docs/api/v5/#operation/reports/get) endpoints. Moreover, they support multiple types of catalogs.  [Learn more](/docs/api-features/shopping-overview/)
+    # @param processing_result_id [String] Unique identifier of a feed processing result. It can be acquired from the \&quot;id\&quot; field of the \&quot;items\&quot; array within the response of the [List processing results for a given feed](/docs/api/v5/#operation/feed_processing_results/list).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Integer>] :item_numbers Item number based on order of appearance in the Catalogs Feed. For example, &#39;0&#39; refers to first item found in a feed that was downloaded from a &#39;location&#39; specified during feed creation.
+    # @option opts [CatalogsItemValidationIssue] :item_validation_issue Filter item validation issues that have a given type of item validation issue.
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @return [ItemsIssuesList200Response]
+    def items_issues_list(processing_result_id, opts = {})
+      data, _status_code, _headers = items_issues_list_with_http_info(processing_result_id, opts)
+      data
+    end
+
+    # List item issues
+    # List item validation issues for a given feed processing result owned by the \&quot;operation user_account\&quot;. Up to 20 random samples of affected items are returned for each error and warning code. Please note that for now query parameters &#39;item_numbers&#39; and &#39;item_validation_issue&#39; cannot be used simultaneously until it is implemented in some release in the future. - By default, the \&quot;operation user_account\&quot; is the token user_account.  Optional: Business Access: Specify an &#x60;ad_account_id&#x60; (obtained via [List ad accounts](/docs/api/v5/#operation/ad_accounts/list)) to use the owner of that ad_account as the \&quot;operation user_account\&quot;. In order to do this, the token user_account must have one of the following [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts) roles on the ad_account: Owner, Admin, Catalogs Manager.  Note: To get a list of all affected items instead of sampled issues, please refer to [Build catalogs report](/docs/api/v5/#operation/reports/create) and [Get catalogs report](/docs/api/v5/#operation/reports/get) endpoints. Moreover, they support multiple types of catalogs.  [Learn more](/docs/api-features/shopping-overview/)
+    # @param processing_result_id [String] Unique identifier of a feed processing result. It can be acquired from the \&quot;id\&quot; field of the \&quot;items\&quot; array within the response of the [List processing results for a given feed](/docs/api/v5/#operation/feed_processing_results/list).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Integer>] :item_numbers Item number based on order of appearance in the Catalogs Feed. For example, &#39;0&#39; refers to first item found in a feed that was downloaded from a &#39;location&#39; specified during feed creation.
+    # @option opts [CatalogsItemValidationIssue] :item_validation_issue Filter item validation issues that have a given type of item validation issue.
+    # @option opts [String] :ad_account_id Unique identifier of an ad account.
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @return [Array<(ItemsIssuesList200Response, Integer, Hash)>] ItemsIssuesList200Response data, response status code and response headers
+    def items_issues_list_with_http_info(processing_result_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogFeedsApi.items_issues_list ...'
+      end
+      # verify the required parameter 'processing_result_id' is set
+      if @api_client.config.client_side_validation && processing_result_id.nil?
+        fail ArgumentError, "Missing the required parameter 'processing_result_id' when calling CatalogFeedsApi.items_issues_list"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && processing_result_id !~ pattern
+        fail ArgumentError, "invalid value for 'processing_result_id' when calling CatalogFeedsApi.items_issues_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
+        fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling CatalogFeedsApi.items_issues_list, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling CatalogFeedsApi.items_issues_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogFeedsApi.items_issues_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CatalogFeedsApi.items_issues_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/catalogs/processing_results/{processing_result_id}/item_issues'.sub('{processing_result_id}', CGI.escape(processing_result_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'item_numbers'] = @api_client.build_collection_param(opts[:'item_numbers'], :multi) if !opts[:'item_numbers'].nil?
+      query_params[:'item_validation_issue'] = opts[:'item_validation_issue'] if !opts[:'item_validation_issue'].nil?
+      query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
+      query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ItemsIssuesList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"CatalogFeedsApi.items_issues_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogFeedsApi#items_issues_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end