Class: Printful::WebhookAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhookAPIClient

Returns a new instance of WebhookAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#create_webhook(create_webhook_request, opts = {}) ⇒ GetWebhooks200Response

Set up webhook configuration Use this endpoint to enable a webhook URL for a store and select webhook event types that will be sent to this URL. Note that only one webhook URL can be active for a store, so calling this method disables all existing webhook configuration. Setting up the [Stock updated](#operation/stockUpdated) webhook requires passing IDs for products that need to be monitored for changes. Stock update webhook will only include information for specified products. These product IDs need to be set up using the params property.

Parameters:

  • create_webhook_request (CreateWebhookRequest) —

    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:



28
29
30
31
 
# File 'lib/printful_client/api/webhook_api_client.rb', line 28

def create_webhook(create_webhook_request, opts = {})
  data, _status_code, _headers = create_webhook_with_http_info(create_webhook_request, opts)
  data
end

#create_webhook_with_http_info(create_webhook_request, opts = {}) ⇒ Array<(GetWebhooks200Response, Integer, Hash)>

Set up webhook configuration Use this endpoint to enable a webhook URL for a store and select webhook event types that will be sent to this URL. Note that only one webhook URL can be active for a store, so calling this method disables all existing webhook configuration. Setting up the [Stock updated](#operation/stockUpdated) webhook requires passing IDs for products that need to be monitored for changes. Stock update webhook will only include information for specified products. These product IDs need to be set up using the params property.

Parameters:

  • create_webhook_request (CreateWebhookRequest) —

    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<(GetWebhooks200Response, Integer, Hash)>) —

    GetWebhooks200Response data, response status code and response headers



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
84
85
86
87
88
89
90
91
 
# File 'lib/printful_client/api/webhook_api_client.rb', line 39

def create_webhook_with_http_info(create_webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookAPIClient.create_webhook ...'
  end
  # verify the required parameter 'create_webhook_request' is set
  if @api_client.config.client_side_validation && create_webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_webhook_request' when calling WebhookAPIClient.create_webhook"
  end
  # resource path
  local_var_path = '/webhooks'

  # 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'])
  # 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(create_webhook_request)

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

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

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

#disable_webhook(opts = {}) ⇒ GetWebhooks200Response

Disable webhook support Removes the webhook URL and all event types from the store.

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:



98
99
100
101
 
# File 'lib/printful_client/api/webhook_api_client.rb', line 98

def disable_webhook(opts = {})
  data, _status_code, _headers = disable_webhook_with_http_info(opts)
  data
end

#disable_webhook_with_http_info(opts = {}) ⇒ Array<(GetWebhooks200Response, Integer, Hash)>

Disable webhook support Removes the webhook URL and all event types from the store.

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:

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

    GetWebhooks200Response data, response status code and response headers



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
147
148
149
150
151
 
# File 'lib/printful_client/api/webhook_api_client.rb', line 108

def disable_webhook_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookAPIClient.disable_webhook ...'
  end
  # resource path
  local_var_path = '/webhooks'

  # 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] || 'GetWebhooks200Response'

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

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

#get_webhooks(opts = {}) ⇒ GetWebhooks200Response

Get webhook configuration Returns configured webhook URL and list of webhook event types enabled for the store

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:



158
159
160
161
 
# File 'lib/printful_client/api/webhook_api_client.rb', line 158

def get_webhooks(opts = {})
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
  data
end

#get_webhooks_with_http_info(opts = {}) ⇒ Array<(GetWebhooks200Response, Integer, Hash)>

Get webhook configuration Returns configured webhook URL and list of webhook event types enabled for the store

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:

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

    GetWebhooks200Response data, response status code and response headers



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
210
211
 
# File 'lib/printful_client/api/webhook_api_client.rb', line 168

def get_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookAPIClient.get_webhooks ...'
  end
  # resource path
  local_var_path = '/webhooks'

  # 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] || 'GetWebhooks200Response'

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

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