ultracart_api 3.0.76 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -13
- data/docs/AffiliateApi.md +8 -22
- data/docs/AutoOrderApi.md +32 -88
- data/docs/ChargebackApi.md +20 -55
- data/docs/CheckoutApi.md +77 -294
- data/docs/CouponApi.md +78 -209
- data/docs/CustomerApi.md +42 -110
- data/docs/FulfillmentApi.md +21 -55
- data/docs/ItemApi.md +36 -99
- data/docs/OauthApi.md +8 -32
- data/docs/OrderApi.md +81 -220
- data/docs/StorefrontApi.md +429 -2077
- data/docs/TaxApi.md +121 -308
- data/docs/UserApi.md +46 -121
- data/docs/WebhookApi.md +32 -88
- data/lib/ultracart_api/api/affiliate_api.rb +13 -0
- data/lib/ultracart_api/api/auto_order_api.rb +13 -0
- data/lib/ultracart_api/api/chargeback_api.rb +13 -0
- data/lib/ultracart_api/api/checkout_api.rb +13 -0
- data/lib/ultracart_api/api/coupon_api.rb +13 -0
- data/lib/ultracart_api/api/customer_api.rb +13 -0
- data/lib/ultracart_api/api/fulfillment_api.rb +13 -0
- data/lib/ultracart_api/api/item_api.rb +13 -0
- data/lib/ultracart_api/api/oauth_api.rb +13 -0
- data/lib/ultracart_api/api/order_api.rb +13 -0
- data/lib/ultracart_api/api/storefront_api.rb +13 -0
- data/lib/ultracart_api/api/tax_api.rb +13 -0
- data/lib/ultracart_api/api/user_api.rb +13 -0
- data/lib/ultracart_api/api/webhook_api.rb +13 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
data/docs/UserApi.md
CHANGED
|
@@ -28,18 +28,11 @@ Delete a group on the UltraCart account.
|
|
|
28
28
|
```ruby
|
|
29
29
|
# load the gem
|
|
30
30
|
require 'ultracart_api'
|
|
31
|
-
# setup authorization
|
|
32
|
-
UltracartClient.configure do |config|
|
|
33
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
34
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
35
|
-
|
|
36
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
37
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
38
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
39
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
40
|
-
end
|
|
41
31
|
|
|
42
|
-
|
|
32
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
33
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
34
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
35
|
+
|
|
43
36
|
|
|
44
37
|
group_oid = 56 # Integer | The group_oid to delete.
|
|
45
38
|
|
|
@@ -84,18 +77,11 @@ Delete a user on the UltraCart account.
|
|
|
84
77
|
```ruby
|
|
85
78
|
# load the gem
|
|
86
79
|
require 'ultracart_api'
|
|
87
|
-
# setup authorization
|
|
88
|
-
UltracartClient.configure do |config|
|
|
89
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
90
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
91
|
-
|
|
92
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
93
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
94
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
95
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
96
|
-
end
|
|
97
80
|
|
|
98
|
-
|
|
81
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
82
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
83
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
84
|
+
|
|
99
85
|
|
|
100
86
|
user_id = 56 # Integer | The user_id to delete.
|
|
101
87
|
|
|
@@ -140,18 +126,11 @@ Retrieves a single group using the specified group id.
|
|
|
140
126
|
```ruby
|
|
141
127
|
# load the gem
|
|
142
128
|
require 'ultracart_api'
|
|
143
|
-
# setup authorization
|
|
144
|
-
UltracartClient.configure do |config|
|
|
145
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
146
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
147
|
-
|
|
148
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
149
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
150
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
151
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
152
|
-
end
|
|
153
129
|
|
|
154
|
-
|
|
130
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
131
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
132
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
133
|
+
|
|
155
134
|
|
|
156
135
|
group_oid = 56 # Integer | The group id to retrieve.
|
|
157
136
|
|
|
@@ -194,18 +173,12 @@ Get groups
|
|
|
194
173
|
```ruby
|
|
195
174
|
# load the gem
|
|
196
175
|
require 'ultracart_api'
|
|
197
|
-
# setup authorization
|
|
198
|
-
UltracartClient.configure do |config|
|
|
199
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
200
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
201
|
-
|
|
202
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
203
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
204
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
205
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
206
|
-
end
|
|
207
176
|
|
|
208
|
-
|
|
177
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
178
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
179
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
180
|
+
|
|
181
|
+
|
|
209
182
|
|
|
210
183
|
begin
|
|
211
184
|
#Get groups
|
|
@@ -245,18 +218,11 @@ Retrieves a single user using the specified user id.
|
|
|
245
218
|
```ruby
|
|
246
219
|
# load the gem
|
|
247
220
|
require 'ultracart_api'
|
|
248
|
-
# setup authorization
|
|
249
|
-
UltracartClient.configure do |config|
|
|
250
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
251
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
252
|
-
|
|
253
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
254
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
255
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
256
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
257
|
-
end
|
|
258
221
|
|
|
259
|
-
|
|
222
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
223
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
224
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
225
|
+
|
|
260
226
|
|
|
261
227
|
user_id = 56 # Integer | The user id to retrieve.
|
|
262
228
|
|
|
@@ -302,18 +268,11 @@ Retrieves logins for a single user using the specified user id.
|
|
|
302
268
|
```ruby
|
|
303
269
|
# load the gem
|
|
304
270
|
require 'ultracart_api'
|
|
305
|
-
# setup authorization
|
|
306
|
-
UltracartClient.configure do |config|
|
|
307
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
308
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
309
|
-
|
|
310
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
311
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
312
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
313
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
314
|
-
end
|
|
315
271
|
|
|
316
|
-
|
|
272
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
273
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
274
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
275
|
+
|
|
317
276
|
|
|
318
277
|
user_id = 56 # Integer | The user id to retrieve.
|
|
319
278
|
|
|
@@ -357,18 +316,12 @@ Get users
|
|
|
357
316
|
```ruby
|
|
358
317
|
# load the gem
|
|
359
318
|
require 'ultracart_api'
|
|
360
|
-
# setup authorization
|
|
361
|
-
UltracartClient.configure do |config|
|
|
362
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
363
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
364
|
-
|
|
365
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
366
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
367
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
368
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
369
|
-
end
|
|
370
319
|
|
|
371
|
-
|
|
320
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
321
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
322
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
323
|
+
|
|
324
|
+
|
|
372
325
|
|
|
373
326
|
begin
|
|
374
327
|
#Get users
|
|
@@ -408,18 +361,11 @@ Insert a group on the UltraCart account.
|
|
|
408
361
|
```ruby
|
|
409
362
|
# load the gem
|
|
410
363
|
require 'ultracart_api'
|
|
411
|
-
# setup authorization
|
|
412
|
-
UltracartClient.configure do |config|
|
|
413
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
414
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
415
|
-
|
|
416
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
417
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
418
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
419
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
420
|
-
end
|
|
421
364
|
|
|
422
|
-
|
|
365
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
366
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
367
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
368
|
+
|
|
423
369
|
|
|
424
370
|
group = UltracartClient::Group.new # Group | Group to insert
|
|
425
371
|
|
|
@@ -465,18 +411,11 @@ Insert a user on the UltraCart account.
|
|
|
465
411
|
```ruby
|
|
466
412
|
# load the gem
|
|
467
413
|
require 'ultracart_api'
|
|
468
|
-
# setup authorization
|
|
469
|
-
UltracartClient.configure do |config|
|
|
470
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
471
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
472
|
-
|
|
473
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
474
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
475
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
476
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
477
|
-
end
|
|
478
414
|
|
|
479
|
-
|
|
415
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
416
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
417
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
418
|
+
|
|
480
419
|
|
|
481
420
|
user = UltracartClient::User.new # User | User to insert
|
|
482
421
|
|
|
@@ -522,18 +461,11 @@ Update a group on the UltraCart account.
|
|
|
522
461
|
```ruby
|
|
523
462
|
# load the gem
|
|
524
463
|
require 'ultracart_api'
|
|
525
|
-
# setup authorization
|
|
526
|
-
UltracartClient.configure do |config|
|
|
527
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
528
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
529
|
-
|
|
530
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
531
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
532
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
533
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
534
|
-
end
|
|
535
464
|
|
|
536
|
-
|
|
465
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
466
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
467
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
468
|
+
|
|
537
469
|
|
|
538
470
|
group = UltracartClient::Group.new # Group | Group to update
|
|
539
471
|
|
|
@@ -582,18 +514,11 @@ Update a user on the UltraCart account.
|
|
|
582
514
|
```ruby
|
|
583
515
|
# load the gem
|
|
584
516
|
require 'ultracart_api'
|
|
585
|
-
# setup authorization
|
|
586
|
-
UltracartClient.configure do |config|
|
|
587
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
588
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
589
|
-
|
|
590
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
591
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
592
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
593
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
594
|
-
end
|
|
595
517
|
|
|
596
|
-
|
|
518
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
519
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
520
|
+
api_instance = UltracartClient::UserApi.new_using_api_key(simple_key, false, false)
|
|
521
|
+
|
|
597
522
|
|
|
598
523
|
user = UltracartClient::User.new # User | User to update
|
|
599
524
|
|
data/docs/WebhookApi.md
CHANGED
|
@@ -25,18 +25,11 @@ Delete a webhook on the UltraCart account.
|
|
|
25
25
|
```ruby
|
|
26
26
|
# load the gem
|
|
27
27
|
require 'ultracart_api'
|
|
28
|
-
# setup authorization
|
|
29
|
-
UltracartClient.configure do |config|
|
|
30
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
31
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
32
|
-
|
|
33
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
34
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
35
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
36
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
37
|
-
end
|
|
38
28
|
|
|
39
|
-
|
|
29
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
30
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
31
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
32
|
+
|
|
40
33
|
|
|
41
34
|
webhook_oid = 56 # Integer | The webhook oid to delete.
|
|
42
35
|
|
|
@@ -81,18 +74,11 @@ Delete a webhook based upon the URL on the webhook_url matching an existing webh
|
|
|
81
74
|
```ruby
|
|
82
75
|
# load the gem
|
|
83
76
|
require 'ultracart_api'
|
|
84
|
-
# setup authorization
|
|
85
|
-
UltracartClient.configure do |config|
|
|
86
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
87
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
88
|
-
|
|
89
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
90
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
91
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
92
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
93
|
-
end
|
|
94
77
|
|
|
95
|
-
|
|
78
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
79
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
80
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
81
|
+
|
|
96
82
|
|
|
97
83
|
webhook = UltracartClient::Webhook.new # Webhook | Webhook to delete
|
|
98
84
|
|
|
@@ -138,18 +124,11 @@ Retrieves an individual log for a webhook given the webhook oid the request id.
|
|
|
138
124
|
```ruby
|
|
139
125
|
# load the gem
|
|
140
126
|
require 'ultracart_api'
|
|
141
|
-
# setup authorization
|
|
142
|
-
UltracartClient.configure do |config|
|
|
143
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
144
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
145
|
-
|
|
146
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
147
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
148
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
149
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
150
|
-
end
|
|
151
127
|
|
|
152
|
-
|
|
128
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
129
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
130
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
131
|
+
|
|
153
132
|
|
|
154
133
|
webhook_oid = 56 # Integer | The webhook oid that owns the log.
|
|
155
134
|
|
|
@@ -198,18 +177,11 @@ Retrieves the log summary information for a given webhook. This is useful for d
|
|
|
198
177
|
```ruby
|
|
199
178
|
# load the gem
|
|
200
179
|
require 'ultracart_api'
|
|
201
|
-
# setup authorization
|
|
202
|
-
UltracartClient.configure do |config|
|
|
203
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
204
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
205
|
-
|
|
206
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
207
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
208
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
209
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
210
|
-
end
|
|
211
180
|
|
|
212
|
-
|
|
181
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
182
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
183
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
184
|
+
|
|
213
185
|
|
|
214
186
|
webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
|
|
215
187
|
|
|
@@ -263,18 +235,11 @@ Retrieves the webhooks associated with this application.
|
|
|
263
235
|
```ruby
|
|
264
236
|
# load the gem
|
|
265
237
|
require 'ultracart_api'
|
|
266
|
-
# setup authorization
|
|
267
|
-
UltracartClient.configure do |config|
|
|
268
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
269
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
270
|
-
|
|
271
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
272
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
273
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
274
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
275
|
-
end
|
|
276
238
|
|
|
277
|
-
|
|
239
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
240
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
241
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
242
|
+
|
|
278
243
|
|
|
279
244
|
opts = {
|
|
280
245
|
_limit: 100, # Integer | The maximum number of records to return on this one API call.
|
|
@@ -327,18 +292,11 @@ Adds a new webhook on the account. If you add a new webhook with the authentica
|
|
|
327
292
|
```ruby
|
|
328
293
|
# load the gem
|
|
329
294
|
require 'ultracart_api'
|
|
330
|
-
# setup authorization
|
|
331
|
-
UltracartClient.configure do |config|
|
|
332
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
333
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
334
|
-
|
|
335
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
336
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
337
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
338
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
339
|
-
end
|
|
340
295
|
|
|
341
|
-
|
|
296
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
297
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
298
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
299
|
+
|
|
342
300
|
|
|
343
301
|
webhook = UltracartClient::Webhook.new # Webhook | Webhook to create
|
|
344
302
|
|
|
@@ -388,18 +346,11 @@ This method will resend events to the webhook endpoint. This method can be used
|
|
|
388
346
|
```ruby
|
|
389
347
|
# load the gem
|
|
390
348
|
require 'ultracart_api'
|
|
391
|
-
# setup authorization
|
|
392
|
-
UltracartClient.configure do |config|
|
|
393
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
394
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
395
|
-
|
|
396
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
397
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
398
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
399
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
400
|
-
end
|
|
401
349
|
|
|
402
|
-
|
|
350
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
351
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
352
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
353
|
+
|
|
403
354
|
|
|
404
355
|
webhook_oid = 56 # Integer | The webhook oid that is receiving the reflowed events.
|
|
405
356
|
|
|
@@ -448,18 +399,11 @@ Update a webhook on the account
|
|
|
448
399
|
```ruby
|
|
449
400
|
# load the gem
|
|
450
401
|
require 'ultracart_api'
|
|
451
|
-
# setup authorization
|
|
452
|
-
UltracartClient.configure do |config|
|
|
453
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
454
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
455
|
-
|
|
456
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
457
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
458
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
459
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
460
|
-
end
|
|
461
402
|
|
|
462
|
-
|
|
403
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
404
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
405
|
+
api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false, false)
|
|
406
|
+
|
|
463
407
|
|
|
464
408
|
webhook = UltracartClient::Webhook.new # Webhook | Webhook to update
|
|
465
409
|
|
|
@@ -19,6 +19,19 @@ module UltracartClient
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
+
|
|
23
|
+
def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
|
|
24
|
+
api_config = Configuration.new
|
|
25
|
+
api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
|
|
26
|
+
api_config.api_version = '2017-03-01'
|
|
27
|
+
api_config.verify_ssl = verify_ssl
|
|
28
|
+
|
|
29
|
+
api_client = ApiClient.new(api_config)
|
|
30
|
+
api_client.config.debugging = debugging
|
|
31
|
+
|
|
32
|
+
UltracartClient::AffiliateApi.new(api_client)
|
|
33
|
+
end
|
|
34
|
+
|
|
22
35
|
# Retrieve clicks
|
|
23
36
|
# Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
24
37
|
# @param click_query Click query
|