printful_client 1.0.1

data/lib/printful_client/api/product_templates_api_client.rb

@@ -0,0 +1,211 @@
+=begin
+#API Documentation | Printful
+
+## About the Printful API  The Printful API is a RESTful API, that uses an HTTP protocol for communication. HTTP GET, POST, PUT and DELETE methods are used to access the API resources.  ## Requests and responses  ### Request endpoint All API requests have to be sent to this URL: ``` https://api.printful.com/ ``` If you are using a proxy, make sure that all requests have host header set to **api.printful.com**.  ### Request parameters Some mandatory parameters (like object identifiers) must be included in the request URL path ``` GET /orders/123 ``` Additional parameters can be passed as GET variables: ``` GET /orders?offset=10&limit=5 ``` For POST and PUT requests, a more complex data structure can be passed as JSON encoded data in the request body: ``` POST /orders  {\"recipient\":{...},\"items\":[...]} ```  ### Response body The response body is always a JSON object that contains a response status code (identical to the HTTP status code) and the result of the action. If the status code is 200, then the action was successful. ``` {    \"code\": 200, //Response status code    \"result\":{       //API method return data    //...    } } ```  Sometimes the response includes paging information to allow to browse larger result sets by adding offset and limit GET parameters to the request URL. ``` {    \"code\": 200, //Response status code    \"result\":[     {        //Item 11     },     {        //Item 12     }    ]    \"paging\": {       \"total\": 12,  //Total items available       \"offset\": 10, //Items skipped from the beginning       \"limit\": 20   //Number of items per page    } } ```  ## Error response If the API call is not successful, then the response code is not in the 2xx range and the `result` attribute contains an error description. ``` {     \"code\": 404,     \"result\": \"Not Found\",     \"error\": {         \"reason\": \"NotFound\",         \"message\": \"Not Found\"     } } ```  In general, response codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, etc.), and codes in the 5xx range indicate an error with Printful's servers.  ### Timestamps All timestamps from the API are returned as integers in UNIX timestamp format.  ### Rate Limits Printful API has a general rate limit of 120 API calls per minute. Additionally, endpoints that perform resource intensive operations (such as mockup generator) have a lower allowed request limit.  # Authentication  <!-- ReDoc-Inject: <security-definitions> -->
+
+The version of the OpenAPI document: 1.0
+Contact: devsupport@printful.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module Printful
+  class ProductTemplatesAPIClient
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete product template
+    # Delete product template by ID or External Product ID
+    # @param id [GetSyncProductByIdIdParameter] Template ID (integer) or External Product ID (if prefixed with @)
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteProductTemplate200Response]
+    def delete_product_template(id, opts = {})
+      data, _status_code, _headers = delete_product_template_with_http_info(id, opts)
+      data
+    end
+
+    # Delete product template
+    # Delete product template by ID or External Product ID
+    # @param id [GetSyncProductByIdIdParameter] Template ID (integer) or External Product ID (if prefixed with @)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteProductTemplate200Response, Integer, Hash)>] DeleteProductTemplate200Response data, response status code and response headers
+    def delete_product_template_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProductTemplatesAPIClient.delete_product_template ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProductTemplatesAPIClient.delete_product_template"
+      end
+      # resource path
+      local_var_path = '/product-templates/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteProductTemplate200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProductTemplatesAPIClient.delete_product_template",
+        :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: ProductTemplatesAPIClient#delete_product_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get product template
+    # Get information about a single product template
+    # @param id [GetSyncProductByIdIdParameter] Template ID (integer) or External Product ID (if prefixed with @)
+    # @param [Hash] opts the optional parameters
+    # @return [GetProductTemplateById200Response]
+    def get_product_template_by_id(id, opts = {})
+      data, _status_code, _headers = get_product_template_by_id_with_http_info(id, opts)
+      data
+    end
+
+    # Get product template
+    # Get information about a single product template
+    # @param id [GetSyncProductByIdIdParameter] Template ID (integer) or External Product ID (if prefixed with @)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetProductTemplateById200Response, Integer, Hash)>] GetProductTemplateById200Response data, response status code and response headers
+    def get_product_template_by_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProductTemplatesAPIClient.get_product_template_by_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProductTemplatesAPIClient.get_product_template_by_id"
+      end
+      # resource path
+      local_var_path = '/product-templates/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetProductTemplateById200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProductTemplatesAPIClient.get_product_template_by_id",
+        :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: ProductTemplatesAPIClient#get_product_template_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get product template list
+    # Returns a list of templates.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Result set offset
+    # @option opts [Integer] :limit Number of items per page (max 100)
+    # @return [GetProductTemplates200Response]
+    def get_product_templates(opts = {})
+      data, _status_code, _headers = get_product_templates_with_http_info(opts)
+      data
+    end
+
+    # Get product template list
+    # Returns a list of templates.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Result set offset
+    # @option opts [Integer] :limit Number of items per page (max 100)
+    # @return [Array<(GetProductTemplates200Response, Integer, Hash)>] GetProductTemplates200Response data, response status code and response headers
+    def get_product_templates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProductTemplatesAPIClient.get_product_templates ...'
+      end
+      # resource path
+      local_var_path = '/product-templates'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetProductTemplates200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProductTemplatesAPIClient.get_product_templates",
+        :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: ProductTemplatesAPIClient#get_product_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end