Class: Printful::ProductTemplatesAPIClient

Inherits:
Object
  • Object
show all
Defined in:
lib/printful_client/api/product_templates_api_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductTemplatesAPIClient

Returns a new instance of ProductTemplatesAPIClient.



19
20
21
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_product_template(id, opts = {}) ⇒ DeleteProductTemplate200Response

Delete product template Delete product template by ID or External Product ID

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Template ID (integer) or External Product ID (if prefixed with @)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 27

def delete_product_template(id, opts = {})
  data, _status_code, _headers = delete_product_template_with_http_info(id, opts)
  data
end

#delete_product_template_with_http_info(id, opts = {}) ⇒ Array<(DeleteProductTemplate200Response, Integer, Hash)>

Delete product template Delete product template by ID or External Product ID

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Template ID (integer) or External Product ID (if prefixed with @)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 37

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_by_id(id, opts = {}) ⇒ GetProductTemplateById200Response

Get product template Get information about a single product template

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Template ID (integer) or External Product ID (if prefixed with @)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 90

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_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetProductTemplateById200Response, Integer, Hash)>

Get product template Get information about a single product template

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Template ID (integer) or External Product ID (if prefixed with @)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 100

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_templates(opts = {}) ⇒ GetProductTemplates200Response

Get product template list Returns a list of templates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Result set offset

  • :limit (Integer) —

    Number of items per page (max 100)

Returns:



154
155
156
157
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 154

def get_product_templates(opts = {})
  data, _status_code, _headers = get_product_templates_with_http_info(opts)
  data
end

#get_product_templates_with_http_info(opts = {}) ⇒ Array<(GetProductTemplates200Response, Integer, Hash)>

Get product template list Returns a list of templates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Result set offset

  • :limit (Integer) —

    Number of items per page (max 100)

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/printful_client/api/product_templates_api_client.rb', line 165

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