docs/WebhookApi.md in ultracart_api-4.0.32.rc vs docs/WebhookApi.md in ultracart_api-4.0.33.rc
- old
+ new
@@ -25,22 +25,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
webhook_oid = 56 # Integer | The webhook oid to delete.
begin
# Delete a webhook
api_instance.delete_webhook(webhook_oid)
@@ -98,22 +95,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
webhook = UltracartClient::Webhook.new # Webhook | Webhook to delete
begin
# Delete a webhook by URL
result = api_instance.delete_webhook_by_url(webhook)
@@ -172,22 +166,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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.
begin
# Retrieve an individual log
@@ -248,22 +239,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
opts = {
_limit: 56, # Integer | The maximum number of records to return on this one API call.
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
_since: '_since_example' # String | Fetch log summaries that have been delivered since this date/time.
@@ -330,22 +318,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
_limit: 56, # Integer | The maximum number of records to return on this one API call.
_offset: 56, # 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
_placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
@@ -412,22 +397,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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.
}
@@ -490,22 +472,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
webhook_oid = 56 # Integer | The webhook oid that is receiving the reflowed events.
event_name = 'event_name_example' # String | The event to reflow.
begin
# Resend events to the webhook endpoint.
@@ -566,21 +545,18 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::WebhookApi.new
+api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
webhook_oid = 56 # Integer | The webhook oid to update.
webhook = UltracartClient::Webhook.new # Webhook | Webhook to update
opts = {
_placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
}