Class: Io::Flow::V0::Clients::Webhooks

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Webhooks

Returns a new instance of Webhooks.



3133
3134
3135
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3133

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_by_id(organization, id) ⇒ Object

Delete a webhook with the specified id



3177
3178
3179
3180
3181
3182
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3177

def delete_by_id(organization, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/webhooks/#{CGI.escape(id)}").delete
  nil
end

#get(organization, incoming = {}) ⇒ Object

Returns webhooks for an organization



3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3138

def get(organization, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/#{CGI.escape(organization)}/webhooks").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Webhook.new(x) }
end

#get_by_id(organization, id) ⇒ Object

Returns information about a specific webhook



3160
3161
3162
3163
3164
3165
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3160

def get_by_id(organization, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/webhooks/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::Webhook.new(r)
end

#get_settings(organization) ⇒ Object

Returns the webhook settings for an organization



3185
3186
3187
3188
3189
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3185

def get_settings(organization)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  r = @client.request("/#{CGI.escape(organization)}/webhooks/settings").get
  ::Io::Flow::V0::Models::WebhookSettings.new(r)
end

#post(organization, webhook_form) ⇒ Object

Create a new webhook



3152
3153
3154
3155
3156
3157
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3152

def post(organization, webhook_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('webhook_form', webhook_form, ::Io::Flow::V0::Models::WebhookForm)
  r = @client.request("/#{CGI.escape(organization)}/webhooks").with_json(webhook_form.to_json).post
  ::Io::Flow::V0::Models::Webhook.new(r)
end

#put_by_id(organization, id, webhook_form) ⇒ Object

Update an existing webhook



3168
3169
3170
3171
3172
3173
3174
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3168

def put_by_id(organization, id, webhook_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  HttpClient::Preconditions.assert_class('webhook_form', webhook_form, ::Io::Flow::V0::Models::WebhookForm)
  r = @client.request("/#{CGI.escape(organization)}/webhooks/#{CGI.escape(id)}").with_json(webhook_form.to_json).put
  ::Io::Flow::V0::Models::Webhook.new(r)
end

#put_settings(organization, webhook_settings) ⇒ Object

Updates the webhook settings for an organization



3192
3193
3194
3195
3196
3197
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3192

def put_settings(organization, webhook_settings)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('webhook_settings', webhook_settings, ::Io::Flow::V0::Models::WebhookSettings)
  r = @client.request("/#{CGI.escape(organization)}/webhooks/settings").with_json(webhook_settings.to_json).put
  ::Io::Flow::V0::Models::WebhookSettings.new(r)
end