docs/WebhookApi.md in ultracart_api-3.0.76 vs docs/WebhookApi.md in ultracart_api-3.1.0

- old
+ new

@@ -23,22 +23,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook_oid = 56 # Integer | The webhook oid to delete. begin @@ -79,22 +72,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook = UltracartClient::Webhook.new # Webhook | Webhook to delete begin @@ -136,22 +122,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook_oid = 56 # Integer | The webhook oid that owns the log. request_id = 'request_id_example' # String | The request id associated with the log to view. @@ -196,22 +175,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for. opts = { _limit: 100, # Integer | The maximum number of records to return on this one API call. @@ -261,22 +233,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new opts = { _limit: 100, # Integer | The maximum number of records to return on this one API call. _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index. _sort: '_sort_example', # String | The sort order of the webhooks. See documentation for examples @@ -325,22 +290,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook = UltracartClient::Webhook.new # Webhook | Webhook to create opts = { _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. @@ -386,22 +344,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook_oid = 56 # Integer | The webhook oid that is receiving the reflowed events. event_name = 'event_name_example' # String | The event to reflow. @@ -446,21 +397,14 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::WebhookApi.new webhook = UltracartClient::Webhook.new # Webhook | Webhook to update webhook_oid = 56 # Integer | The webhook oid to update.