Class: Printful::ApprovalSheetsAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApprovalSheetsAPIClient

Returns a new instance of ApprovalSheetsAPIClient.



19
20
21
 
# File 'lib/printful_client/api/approval_sheets_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/approval_sheets_api_client.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#approve_design(confirm_hash, approval_sheet, opts = {}) ⇒ ApproveDesign200Response

Approve a design Uses the confirm hash of an approval sheet to approve a design and remove the hold on an order

Parameters:

  • confirm_hash (String) —

    The confirm hash for the approval sheet you would like to approve.

  • approval_sheet (ApprovalSheet) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



29
30
31
32
 
# File 'lib/printful_client/api/approval_sheets_api_client.rb', line 29

def approve_design(confirm_hash, approval_sheet, opts = {})
  data, _status_code, _headers = approve_design_with_http_info(confirm_hash, approval_sheet, opts)
  data
end

#approve_design_with_http_info(confirm_hash, approval_sheet, opts = {}) ⇒ Array<(ApproveDesign200Response, Integer, Hash)>

Approve a design Uses the confirm hash of an approval sheet to approve a design and remove the hold on an order

Parameters:

  • confirm_hash (String) —

    The confirm hash for the approval sheet you would like to approve.

  • approval_sheet (ApprovalSheet) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:

  • (Array<(ApproveDesign200Response, Integer, Hash)>) —

    ApproveDesign200Response data, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/printful_client/api/approval_sheets_api_client.rb', line 41

def approve_design_with_http_info(confirm_hash, approval_sheet, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalSheetsAPIClient.approve_design ...'
  end
  # verify the required parameter 'confirm_hash' is set
  if @api_client.config.client_side_validation && confirm_hash.nil?
    fail ArgumentError, "Missing the required parameter 'confirm_hash' when calling ApprovalSheetsAPIClient.approve_design"
  end
  # verify the required parameter 'approval_sheet' is set
  if @api_client.config.client_side_validation && approval_sheet.nil?
    fail ArgumentError, "Missing the required parameter 'approval_sheet' when calling ApprovalSheetsAPIClient.approve_design"
  end
  # resource path
  local_var_path = '/approval-sheets'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'confirm_hash'] = confirm_hash

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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
  header_params[:'X-PF-Store-Id'] = opts[:'x_pf_store_id'] if !opts[:'x_pf_store_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(approval_sheet)

  # return_type
  return_type = opts[:debug_return_type] || 'ApproveDesign200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"ApprovalSheetsAPIClient.approve_design",
    :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: ApprovalSheetsAPIClient#approve_design\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_approval_sheets(opts = {}) ⇒ GetApprovalSheets200Response

Retrieve a list of approval sheets Retrieve a list of approval sheets confirming suggested changes to files of on hold orders.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



105
106
107
108
 
# File 'lib/printful_client/api/approval_sheets_api_client.rb', line 105

def get_approval_sheets(opts = {})
  data, _status_code, _headers = get_approval_sheets_with_http_info(opts)
  data
end

#get_approval_sheets_with_http_info(opts = {}) ⇒ Array<(GetApprovalSheets200Response, Integer, Hash)>

Retrieve a list of approval sheets Retrieve a list of approval sheets confirming suggested changes to files of on hold orders.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



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
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/printful_client/api/approval_sheets_api_client.rb', line 115

def get_approval_sheets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalSheetsAPIClient.get_approval_sheets ...'
  end
  # resource path
  local_var_path = '/approval-sheets'

  # 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'])
  header_params[:'X-PF-Store-Id'] = opts[:'x_pf_store_id'] if !opts[:'x_pf_store_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetApprovalSheets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"ApprovalSheetsAPIClient.get_approval_sheets",
    :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: ApprovalSheetsAPIClient#get_approval_sheets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#submit_approval_sheet_changes(confirm_hash, approval_sheet_changes, opts = {}) ⇒ SubmitApprovalSheetChanges200Response

Submit changes to an approval sheet Use this to submit alternative changes to a design that has an approval sheet

Parameters:

  • confirm_hash (String) —

    The confirm hash for the approval sheet you would like to approve.

  • approval_sheet_changes (ApprovalSheetChanges) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



167
168
169
170
 
# File 'lib/printful_client/api/approval_sheets_api_client.rb', line 167

def submit_approval_sheet_changes(confirm_hash, approval_sheet_changes, opts = {})
  data, _status_code, _headers = submit_approval_sheet_changes_with_http_info(confirm_hash, approval_sheet_changes, opts)
  data
end

#submit_approval_sheet_changes_with_http_info(confirm_hash, approval_sheet_changes, opts = {}) ⇒ Array<(SubmitApprovalSheetChanges200Response, Integer, Hash)>

Submit changes to an approval sheet Use this to submit alternative changes to a design that has an approval sheet

Parameters:

  • confirm_hash (String) —

    The confirm hash for the approval sheet you would like to approve.

  • approval_sheet_changes (ApprovalSheetChanges) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/printful_client/api/approval_sheets_api_client.rb', line 179

def submit_approval_sheet_changes_with_http_info(confirm_hash, approval_sheet_changes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalSheetsAPIClient.submit_approval_sheet_changes ...'
  end
  # verify the required parameter 'confirm_hash' is set
  if @api_client.config.client_side_validation && confirm_hash.nil?
    fail ArgumentError, "Missing the required parameter 'confirm_hash' when calling ApprovalSheetsAPIClient.submit_approval_sheet_changes"
  end
  # verify the required parameter 'approval_sheet_changes' is set
  if @api_client.config.client_side_validation && approval_sheet_changes.nil?
    fail ArgumentError, "Missing the required parameter 'approval_sheet_changes' when calling ApprovalSheetsAPIClient.submit_approval_sheet_changes"
  end
  # resource path
  local_var_path = '/approval-sheets/changes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'confirm_hash'] = confirm_hash

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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
  header_params[:'X-PF-Store-Id'] = opts[:'x_pf_store_id'] if !opts[:'x_pf_store_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(approval_sheet_changes)

  # return_type
  return_type = opts[:debug_return_type] || 'SubmitApprovalSheetChanges200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"ApprovalSheetsAPIClient.submit_approval_sheet_changes",
    :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: ApprovalSheetsAPIClient#submit_approval_sheet_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end