order_cloud 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (303) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +39 -14
  4. data/Rakefile +1 -1
  5. data/docs/AdminUserGroupApi.md +482 -0
  6. data/docs/CategoryApi.md +4 -3
  7. data/docs/ListMessageCCListenerAssignment.md +9 -0
  8. data/docs/{ListApiClient.md → ListMessageConfig.md} +2 -2
  9. data/docs/{ListDevAccessibleCompany.md → ListMessageSender.md} +2 -2
  10. data/docs/ListMessageSenderAssignment.md +9 -0
  11. data/docs/MessageCCListenerAssignment.md +13 -0
  12. data/docs/MessageConfig.md +11 -0
  13. data/docs/MessageSender.md +10 -0
  14. data/docs/MessageSenderAssignment.md +12 -0
  15. data/docs/MessageSendersApi.md +398 -0
  16. data/docs/Product.md +4 -0
  17. data/docs/ProductApi.md +4 -3
  18. data/docs/ProductAssignment.md +2 -2
  19. data/docs/SecurityProfileApi.md +5 -5
  20. data/docs/User.md +1 -0
  21. data/docs/UserApi.md +4 -3
  22. data/docs/UserGroupApi.md +4 -3
  23. data/git_push.sh +0 -0
  24. data/lib/order_cloud.rb +11 -4
  25. data/lib/order_cloud/api/address_api.rb +1 -1
  26. data/lib/order_cloud/api/admin_address_api.rb +1 -1
  27. data/lib/order_cloud/api/admin_user_api.rb +1 -1
  28. data/lib/order_cloud/api/admin_user_group_api.rb +578 -0
  29. data/lib/order_cloud/api/approval_rule_api.rb +1 -1
  30. data/lib/order_cloud/api/buyer_api.rb +1 -1
  31. data/lib/order_cloud/api/category_api.rb +7 -6
  32. data/lib/order_cloud/api/cost_center_api.rb +1 -1
  33. data/lib/order_cloud/api/credit_card_api.rb +1 -1
  34. data/lib/order_cloud/api/email_template_api.rb +1 -1
  35. data/lib/order_cloud/api/line_item_api.rb +1 -1
  36. data/lib/order_cloud/api/me_api.rb +1 -1
  37. data/lib/order_cloud/api/message_senders_api.rb +484 -0
  38. data/lib/order_cloud/api/order_api.rb +1 -1
  39. data/lib/order_cloud/api/password_reset_api.rb +1 -1
  40. data/lib/order_cloud/api/payment_api.rb +1 -1
  41. data/lib/order_cloud/api/price_schedule_api.rb +1 -1
  42. data/lib/order_cloud/api/product_api.rb +7 -6
  43. data/lib/order_cloud/api/promotion_api.rb +1 -1
  44. data/lib/order_cloud/api/security_profile_api.rb +6 -6
  45. data/lib/order_cloud/api/shipment_api.rb +1 -1
  46. data/lib/order_cloud/api/spec_api.rb +1 -1
  47. data/lib/order_cloud/api/spending_account_api.rb +1 -1
  48. data/lib/order_cloud/api/user_api.rb +7 -6
  49. data/lib/order_cloud/api/user_group_api.rb +7 -6
  50. data/lib/order_cloud/api_auth.rb +1 -1
  51. data/lib/order_cloud/api_client.rb +1 -1
  52. data/lib/order_cloud/api_error.rb +1 -1
  53. data/lib/order_cloud/configuration.rb +1 -1
  54. data/lib/order_cloud/models/access_token.rb +1 -1
  55. data/lib/order_cloud/models/address.rb +1 -1
  56. data/lib/order_cloud/models/address_assignment.rb +1 -1
  57. data/lib/order_cloud/models/admin_company.rb +1 -1
  58. data/lib/order_cloud/models/admin_model_on_view.rb +1 -1
  59. data/lib/order_cloud/models/approval_rule.rb +1 -1
  60. data/lib/order_cloud/models/base_spec.rb +1 -1
  61. data/lib/order_cloud/models/buyer.rb +1 -1
  62. data/lib/order_cloud/models/buyer_address.rb +1 -1
  63. data/lib/order_cloud/models/buyer_credit_card.rb +1 -1
  64. data/lib/order_cloud/models/buyer_product.rb +1 -1
  65. data/lib/order_cloud/models/buyer_spec.rb +1 -1
  66. data/lib/order_cloud/models/category.rb +1 -1
  67. data/lib/order_cloud/models/category_assignment.rb +1 -1
  68. data/lib/order_cloud/models/category_product_assignment.rb +1 -1
  69. data/lib/order_cloud/models/cost_center.rb +1 -1
  70. data/lib/order_cloud/models/cost_center_assignment.rb +1 -1
  71. data/lib/order_cloud/models/credit_card.rb +1 -1
  72. data/lib/order_cloud/models/credit_card_assignment.rb +1 -1
  73. data/lib/order_cloud/models/email_template.rb +1 -1
  74. data/lib/order_cloud/models/file.rb +1 -1
  75. data/lib/order_cloud/models/impersonate_token_request.rb +1 -1
  76. data/lib/order_cloud/models/inventory.rb +1 -1
  77. data/lib/order_cloud/models/line_item.rb +1 -1
  78. data/lib/order_cloud/models/line_item_spec.rb +1 -1
  79. data/lib/order_cloud/models/list_address.rb +1 -1
  80. data/lib/order_cloud/models/list_address_assignment.rb +1 -1
  81. data/lib/order_cloud/models/list_admin_company.rb +1 -1
  82. data/lib/order_cloud/models/list_approval_rule.rb +1 -1
  83. data/lib/order_cloud/models/list_buyer.rb +1 -1
  84. data/lib/order_cloud/models/list_buyer_address.rb +1 -1
  85. data/lib/order_cloud/models/list_buyer_credit_card.rb +1 -1
  86. data/lib/order_cloud/models/list_buyer_product.rb +1 -1
  87. data/lib/order_cloud/models/list_buyer_spec.rb +1 -1
  88. data/lib/order_cloud/models/list_category.rb +1 -1
  89. data/lib/order_cloud/models/list_category_assignment.rb +1 -1
  90. data/lib/order_cloud/models/list_category_product_assignment.rb +1 -1
  91. data/lib/order_cloud/models/list_cost_center.rb +1 -1
  92. data/lib/order_cloud/models/list_cost_center_assignment.rb +1 -1
  93. data/lib/order_cloud/models/list_credit_card.rb +1 -1
  94. data/lib/order_cloud/models/list_credit_card_assignment.rb +1 -1
  95. data/lib/order_cloud/models/list_file.rb +1 -1
  96. data/lib/order_cloud/models/list_inventory.rb +1 -1
  97. data/lib/order_cloud/models/list_line_item.rb +1 -1
  98. data/lib/order_cloud/models/list_message_cc_listener_assignment.rb +210 -0
  99. data/lib/order_cloud/models/{list_api_client.rb → list_message_config.rb} +3 -3
  100. data/lib/order_cloud/models/{list_dev_accessible_company.rb → list_message_sender.rb} +3 -3
  101. data/lib/order_cloud/models/list_message_sender_assignment.rb +210 -0
  102. data/lib/order_cloud/models/list_order.rb +1 -1
  103. data/lib/order_cloud/models/list_order_approval.rb +1 -1
  104. data/lib/order_cloud/models/list_order_promotion.rb +1 -1
  105. data/lib/order_cloud/models/list_payment.rb +1 -1
  106. data/lib/order_cloud/models/list_price_schedule.rb +1 -1
  107. data/lib/order_cloud/models/list_product.rb +1 -1
  108. data/lib/order_cloud/models/list_product_assignment.rb +1 -1
  109. data/lib/order_cloud/models/list_promotion.rb +1 -1
  110. data/lib/order_cloud/models/list_promotion_assignment.rb +1 -1
  111. data/lib/order_cloud/models/list_security_profile.rb +1 -1
  112. data/lib/order_cloud/models/list_security_profile_assignment.rb +1 -1
  113. data/lib/order_cloud/models/list_shipment.rb +1 -1
  114. data/lib/order_cloud/models/list_spec.rb +1 -1
  115. data/lib/order_cloud/models/list_spec_option.rb +1 -1
  116. data/lib/order_cloud/models/list_spec_product_assignment.rb +1 -1
  117. data/lib/order_cloud/models/list_spending_account.rb +1 -1
  118. data/lib/order_cloud/models/list_spending_account_assignment.rb +1 -1
  119. data/lib/order_cloud/models/list_user.rb +1 -1
  120. data/lib/order_cloud/models/list_user_group.rb +1 -1
  121. data/lib/order_cloud/models/list_user_group_assignment.rb +1 -1
  122. data/lib/order_cloud/models/list_variant.rb +1 -1
  123. data/lib/order_cloud/models/list_web_hook.rb +1 -1
  124. data/lib/order_cloud/models/list_web_hook_route.rb +1 -1
  125. data/lib/order_cloud/models/list_xp_index.rb +1 -1
  126. data/lib/order_cloud/models/message_cc_listener_assignment.rb +244 -0
  127. data/lib/order_cloud/models/message_config.rb +226 -0
  128. data/lib/order_cloud/models/message_sender.rb +217 -0
  129. data/lib/order_cloud/models/message_sender_assignment.rb +235 -0
  130. data/lib/order_cloud/models/meta.rb +1 -1
  131. data/lib/order_cloud/models/order.rb +1 -1
  132. data/lib/order_cloud/models/order_approval.rb +1 -1
  133. data/lib/order_cloud/models/order_promotion.rb +1 -1
  134. data/lib/order_cloud/models/password_reset.rb +1 -1
  135. data/lib/order_cloud/models/password_reset_request.rb +1 -1
  136. data/lib/order_cloud/models/payment.rb +1 -1
  137. data/lib/order_cloud/models/payment_transaction.rb +1 -1
  138. data/lib/order_cloud/models/ping_response.rb +1 -1
  139. data/lib/order_cloud/models/price_break.rb +1 -1
  140. data/lib/order_cloud/models/price_schedule.rb +1 -1
  141. data/lib/order_cloud/models/product.rb +41 -5
  142. data/lib/order_cloud/models/product_assignment.rb +20 -20
  143. data/lib/order_cloud/models/promotion.rb +1 -1
  144. data/lib/order_cloud/models/promotion_assignment.rb +1 -1
  145. data/lib/order_cloud/models/security_profile.rb +1 -1
  146. data/lib/order_cloud/models/security_profile_assignment.rb +1 -1
  147. data/lib/order_cloud/models/shipment.rb +1 -1
  148. data/lib/order_cloud/models/shipment_item.rb +1 -1
  149. data/lib/order_cloud/models/spec.rb +1 -1
  150. data/lib/order_cloud/models/spec_option.rb +1 -1
  151. data/lib/order_cloud/models/spec_product_assignment.rb +1 -1
  152. data/lib/order_cloud/models/spending_account.rb +1 -1
  153. data/lib/order_cloud/models/spending_account_assignment.rb +1 -1
  154. data/lib/order_cloud/models/user.rb +16 -5
  155. data/lib/order_cloud/models/user_group.rb +1 -1
  156. data/lib/order_cloud/models/user_group_assignment.rb +1 -1
  157. data/lib/order_cloud/models/variant.rb +1 -1
  158. data/lib/order_cloud/models/web_hook.rb +1 -1
  159. data/lib/order_cloud/models/web_hook_route.rb +1 -1
  160. data/lib/order_cloud/models/xp_index.rb +1 -1
  161. data/lib/order_cloud/version.rb +2 -2
  162. data/order_cloud.gemspec +2 -2
  163. data/spec/api/address_api_spec.rb +1 -1
  164. data/spec/api/admin_address_api_spec.rb +1 -1
  165. data/spec/api/admin_user_api_spec.rb +1 -1
  166. data/spec/api/admin_user_group_api_spec.rb +165 -0
  167. data/spec/api/approval_rule_api_spec.rb +1 -1
  168. data/spec/api/buyer_api_spec.rb +1 -1
  169. data/spec/api/category_api_spec.rb +2 -2
  170. data/spec/api/cost_center_api_spec.rb +1 -1
  171. data/spec/api/credit_card_api_spec.rb +1 -1
  172. data/spec/api/email_template_api_spec.rb +1 -1
  173. data/spec/api/line_item_api_spec.rb +1 -1
  174. data/spec/api/me_api_spec.rb +1 -1
  175. data/spec/api/message_senders_api_spec.rb +149 -0
  176. data/spec/api/order_api_spec.rb +1 -1
  177. data/spec/api/password_reset_api_spec.rb +1 -1
  178. data/spec/api/payment_api_spec.rb +1 -1
  179. data/spec/api/price_schedule_api_spec.rb +1 -1
  180. data/spec/api/product_api_spec.rb +2 -2
  181. data/spec/api/promotion_api_spec.rb +1 -1
  182. data/spec/api/security_profile_api_spec.rb +1 -1
  183. data/spec/api/shipment_api_spec.rb +1 -1
  184. data/spec/api/spec_api_spec.rb +1 -1
  185. data/spec/api/spending_account_api_spec.rb +1 -1
  186. data/spec/api/user_api_spec.rb +2 -2
  187. data/spec/api/user_group_api_spec.rb +2 -2
  188. data/spec/api_auth_spec.rb +1 -1
  189. data/spec/api_client_spec.rb +1 -1
  190. data/spec/configuration_spec.rb +3 -3
  191. data/spec/models/access_token_spec.rb +1 -1
  192. data/spec/models/address_assignment_spec.rb +1 -1
  193. data/spec/models/address_spec.rb +1 -1
  194. data/spec/models/admin_company_spec.rb +1 -1
  195. data/spec/models/admin_model_on_view_spec.rb +1 -1
  196. data/spec/models/approval_rule_spec.rb +1 -1
  197. data/spec/models/base_spec_spec.rb +1 -1
  198. data/spec/models/buyer_address_spec.rb +1 -1
  199. data/spec/models/buyer_credit_card_spec.rb +1 -1
  200. data/spec/models/buyer_product_spec.rb +1 -1
  201. data/spec/models/buyer_spec.rb +1 -1
  202. data/spec/models/buyer_spec_spec.rb +1 -1
  203. data/spec/models/category_assignment_spec.rb +1 -1
  204. data/spec/models/category_product_assignment_spec.rb +1 -1
  205. data/spec/models/category_spec.rb +1 -1
  206. data/spec/models/cost_center_assignment_spec.rb +1 -1
  207. data/spec/models/cost_center_spec.rb +1 -1
  208. data/spec/models/credit_card_assignment_spec.rb +1 -1
  209. data/spec/models/credit_card_spec.rb +1 -1
  210. data/spec/models/email_template_spec.rb +1 -1
  211. data/spec/models/file_spec.rb +1 -1
  212. data/spec/models/impersonate_token_request_spec.rb +1 -1
  213. data/spec/models/inventory_spec.rb +1 -1
  214. data/spec/models/line_item_spec.rb +1 -1
  215. data/spec/models/line_item_spec_spec.rb +1 -1
  216. data/spec/models/list_address_assignment_spec.rb +1 -1
  217. data/spec/models/list_address_spec.rb +1 -1
  218. data/spec/models/list_admin_company_spec.rb +1 -1
  219. data/spec/models/list_approval_rule_spec.rb +1 -1
  220. data/spec/models/list_buyer_address_spec.rb +1 -1
  221. data/spec/models/list_buyer_credit_card_spec.rb +1 -1
  222. data/spec/models/list_buyer_product_spec.rb +1 -1
  223. data/spec/models/list_buyer_spec.rb +1 -1
  224. data/spec/models/list_buyer_spec_spec.rb +1 -1
  225. data/spec/models/list_category_assignment_spec.rb +1 -1
  226. data/spec/models/list_category_product_assignment_spec.rb +1 -1
  227. data/spec/models/list_category_spec.rb +1 -1
  228. data/spec/models/list_cost_center_assignment_spec.rb +1 -1
  229. data/spec/models/list_cost_center_spec.rb +1 -1
  230. data/spec/models/list_credit_card_assignment_spec.rb +1 -1
  231. data/spec/models/list_credit_card_spec.rb +1 -1
  232. data/spec/models/list_file_spec.rb +1 -1
  233. data/spec/models/list_inventory_spec.rb +1 -1
  234. data/spec/models/list_line_item_spec.rb +1 -1
  235. data/spec/models/list_message_cc_listener_assignment_spec.rb +59 -0
  236. data/spec/models/{list_api_client_spec.rb → list_message_config_spec.rb} +7 -7
  237. data/spec/models/list_message_sender_assignment_spec.rb +59 -0
  238. data/spec/models/{list_dev_accessible_company_spec.rb → list_message_sender_spec.rb} +7 -7
  239. data/spec/models/list_order_approval_spec.rb +1 -1
  240. data/spec/models/list_order_promotion_spec.rb +1 -1
  241. data/spec/models/list_order_spec.rb +1 -1
  242. data/spec/models/list_payment_spec.rb +1 -1
  243. data/spec/models/list_price_schedule_spec.rb +1 -1
  244. data/spec/models/list_product_assignment_spec.rb +1 -1
  245. data/spec/models/list_product_spec.rb +1 -1
  246. data/spec/models/list_promotion_assignment_spec.rb +1 -1
  247. data/spec/models/list_promotion_spec.rb +1 -1
  248. data/spec/models/list_security_profile_assignment_spec.rb +1 -1
  249. data/spec/models/list_security_profile_spec.rb +1 -1
  250. data/spec/models/list_shipment_spec.rb +1 -1
  251. data/spec/models/list_spec_option_spec.rb +1 -1
  252. data/spec/models/list_spec_product_assignment_spec.rb +1 -1
  253. data/spec/models/list_spec_spec.rb +1 -1
  254. data/spec/models/list_spending_account_assignment_spec.rb +1 -1
  255. data/spec/models/list_spending_account_spec.rb +1 -1
  256. data/spec/models/list_user_group_assignment_spec.rb +1 -1
  257. data/spec/models/list_user_group_spec.rb +1 -1
  258. data/spec/models/list_user_spec.rb +1 -1
  259. data/spec/models/list_variant_spec.rb +1 -1
  260. data/spec/models/list_web_hook_route_spec.rb +1 -1
  261. data/spec/models/list_web_hook_spec.rb +1 -1
  262. data/spec/models/list_xp_index_spec.rb +1 -1
  263. data/spec/models/message_cc_listener_assignment_spec.rb +83 -0
  264. data/spec/models/message_config_spec.rb +71 -0
  265. data/spec/models/message_sender_assignment_spec.rb +77 -0
  266. data/spec/models/message_sender_spec.rb +65 -0
  267. data/spec/models/meta_spec.rb +1 -1
  268. data/spec/models/order_approval_spec.rb +1 -1
  269. data/spec/models/order_promotion_spec.rb +1 -1
  270. data/spec/models/order_spec.rb +1 -1
  271. data/spec/models/password_reset_request_spec.rb +1 -1
  272. data/spec/models/password_reset_spec.rb +1 -1
  273. data/spec/models/payment_spec.rb +1 -1
  274. data/spec/models/payment_transaction_spec.rb +1 -1
  275. data/spec/models/ping_response_spec.rb +1 -1
  276. data/spec/models/price_break_spec.rb +1 -1
  277. data/spec/models/price_schedule_spec.rb +1 -1
  278. data/spec/models/product_assignment_spec.rb +6 -6
  279. data/spec/models/product_spec.rb +25 -1
  280. data/spec/models/promotion_assignment_spec.rb +1 -1
  281. data/spec/models/promotion_spec.rb +1 -1
  282. data/spec/models/security_profile_assignment_spec.rb +1 -1
  283. data/spec/models/security_profile_spec.rb +1 -1
  284. data/spec/models/shipment_item_spec.rb +1 -1
  285. data/spec/models/shipment_spec.rb +1 -1
  286. data/spec/models/spec_option_spec.rb +1 -1
  287. data/spec/models/spec_product_assignment_spec.rb +1 -1
  288. data/spec/models/spec_spec.rb +1 -1
  289. data/spec/models/spending_account_assignment_spec.rb +1 -1
  290. data/spec/models/spending_account_spec.rb +1 -1
  291. data/spec/models/user_group_assignment_spec.rb +1 -1
  292. data/spec/models/user_group_spec.rb +1 -1
  293. data/spec/models/user_spec.rb +7 -1
  294. data/spec/models/variant_spec.rb +1 -1
  295. data/spec/models/web_hook_route_spec.rb +1 -1
  296. data/spec/models/web_hook_spec.rb +1 -1
  297. data/spec/models/xp_index_spec.rb +1 -1
  298. data/spec/spec_helper.rb +1 -1
  299. metadata +42 -15
  300. data/Gemfile.lock +0 -34
  301. data/docs/FileApi.md +0 -162
  302. data/lib/order_cloud/api/file_api.rb +0 -206
  303. data/spec/api/file_api_spec.rb +0 -83
@@ -1,34 +0,0 @@
1
- GEM
2
- remote: https://rubygems.org/
3
- specs:
4
- diff-lcs (1.2.5)
5
- ethon (0.9.0)
6
- ffi (>= 1.3.0)
7
- ffi (1.9.14)
8
- rake (11.2.2)
9
- rspec (3.5.0)
10
- rspec-core (~> 3.5.0)
11
- rspec-expectations (~> 3.5.0)
12
- rspec-mocks (~> 3.5.0)
13
- rspec-core (3.5.3)
14
- rspec-support (~> 3.5.0)
15
- rspec-expectations (3.5.0)
16
- diff-lcs (>= 1.2.0, < 2.0)
17
- rspec-support (~> 3.5.0)
18
- rspec-mocks (3.5.0)
19
- diff-lcs (>= 1.2.0, < 2.0)
20
- rspec-support (~> 3.5.0)
21
- rspec-support (3.5.0)
22
- typhoeus (1.1.0)
23
- ethon (>= 0.9.0)
24
-
25
- PLATFORMS
26
- ruby
27
-
28
- DEPENDENCIES
29
- rake
30
- rspec
31
- typhoeus
32
-
33
- BUNDLED WITH
34
- 1.13.1
@@ -1,162 +0,0 @@
1
- # OrderCloud::FileApi
2
-
3
- All URIs are relative to *https://api.ordercloud.io/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get**](FileApi.md#get) | **GET** /files/{fileID} |
8
- [**list**](FileApi.md#list) | **GET** /files |
9
- [**post_file_data**](FileApi.md#post_file_data) | **POST** /files |
10
-
11
-
12
- # **get**
13
- > File get(file_id)
14
-
15
-
16
-
17
- ### Example
18
- ```ruby
19
- # load the gem
20
- require 'order_cloud'
21
- # setup authorization
22
- OrderCloud.configure do |config|
23
- # Configure OAuth2 access token for authorization: oauth2
24
- config.access_token = 'YOUR ACCESS TOKEN'
25
- end
26
-
27
- api_instance = OrderCloud::FileApi.new
28
-
29
- file_id = "file_id_example" # String | ID of the file.
30
-
31
-
32
- begin
33
- result = api_instance.get(file_id)
34
- p result
35
- rescue OrderCloud::ApiError => e
36
- puts "Exception when calling FileApi->get: #{e}"
37
- end
38
- ```
39
-
40
- ### Parameters
41
-
42
- Name | Type | Description | Notes
43
- ------------- | ------------- | ------------- | -------------
44
- **file_id** | **String**| ID of the file. |
45
-
46
- ### Return type
47
-
48
- **File**
49
-
50
- ### Authorization
51
-
52
- [oauth2](../README.md#oauth2)
53
-
54
- ### HTTP request headers
55
-
56
- - **Content-Type**: application/json, text/plain; charset=utf-8
57
- - **Accept**: application/json
58
-
59
-
60
-
61
- # **list**
62
- > ListFile list(opts)
63
-
64
-
65
-
66
- ### Example
67
- ```ruby
68
- # load the gem
69
- require 'order_cloud'
70
- # setup authorization
71
- OrderCloud.configure do |config|
72
- # Configure OAuth2 access token for authorization: oauth2
73
- config.access_token = 'YOUR ACCESS TOKEN'
74
- end
75
-
76
- api_instance = OrderCloud::FileApi.new
77
-
78
- opts = {
79
- page: 56, # Integer | Page of results to return. Default: 1
80
- page_size: 56 # Integer | Number of results to return per page. Default: 20, max: 100.
81
- }
82
-
83
- begin
84
- result = api_instance.list(opts)
85
- p result
86
- rescue OrderCloud::ApiError => e
87
- puts "Exception when calling FileApi->list: #{e}"
88
- end
89
- ```
90
-
91
- ### Parameters
92
-
93
- Name | Type | Description | Notes
94
- ------------- | ------------- | ------------- | -------------
95
- **page** | **Integer**| Page of results to return. Default: 1 | [optional]
96
- **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional]
97
-
98
- ### Return type
99
-
100
- [**ListFile**](ListFile.md)
101
-
102
- ### Authorization
103
-
104
- [oauth2](../README.md#oauth2)
105
-
106
- ### HTTP request headers
107
-
108
- - **Content-Type**: application/json, text/plain; charset=utf-8
109
- - **Accept**: application/json
110
-
111
-
112
-
113
- # **post_file_data**
114
- > File post_file_data(opts)
115
-
116
-
117
-
118
- ### Example
119
- ```ruby
120
- # load the gem
121
- require 'order_cloud'
122
- # setup authorization
123
- OrderCloud.configure do |config|
124
- # Configure OAuth2 access token for authorization: oauth2
125
- config.access_token = 'YOUR ACCESS TOKEN'
126
- end
127
-
128
- api_instance = OrderCloud::FileApi.new
129
-
130
- opts = {
131
- filename: "filename_example" # String | Filename of the file.
132
- }
133
-
134
- begin
135
- result = api_instance.post_file_data(opts)
136
- p result
137
- rescue OrderCloud::ApiError => e
138
- puts "Exception when calling FileApi->post_file_data: #{e}"
139
- end
140
- ```
141
-
142
- ### Parameters
143
-
144
- Name | Type | Description | Notes
145
- ------------- | ------------- | ------------- | -------------
146
- **filename** | **String**| Filename of the file. | [optional]
147
-
148
- ### Return type
149
-
150
- **File**
151
-
152
- ### Authorization
153
-
154
- [oauth2](../README.md#oauth2)
155
-
156
- ### HTTP request headers
157
-
158
- - **Content-Type**: application/json, text/plain; charset=utf-8
159
- - **Accept**: application/json
160
-
161
-
162
-
@@ -1,206 +0,0 @@
1
- =begin
2
- #OrderCloud
3
-
4
- #A full ecommerce backend as a service.
5
-
6
- OpenAPI spec version: 1.0
7
- Contact: ordercloud@four51.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- Licensed under the Apache License, Version 2.0 (the "License");
11
- you may not use this file except in compliance with the License.
12
- You may obtain a copy of the License at
13
-
14
- http://www.apache.org/licenses/LICENSE-2.0
15
-
16
- Unless required by applicable law or agreed to in writing, software
17
- distributed under the License is distributed on an "AS IS" BASIS,
18
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
- See the License for the specific language governing permissions and
20
- limitations under the License.
21
-
22
- =end
23
-
24
- require "uri"
25
-
26
- module OrderCloud
27
- class FileApi
28
- attr_accessor :api_client
29
-
30
- def initialize(api_client = ApiClient.default)
31
- @api_client = api_client
32
- end
33
-
34
- #
35
- #
36
- # @param file_id ID of the file.
37
- # @param [Hash] opts the optional parameters
38
- # @return [File]
39
- def get(file_id, opts = {})
40
- data, _status_code, _headers = get_with_http_info(file_id, opts)
41
- return data
42
- end
43
-
44
- #
45
- #
46
- # @param file_id ID of the file.
47
- # @param [Hash] opts the optional parameters
48
- # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
49
- def get_with_http_info(file_id, opts = {})
50
- if @api_client.config.debugging
51
- @api_client.config.logger.debug "Calling API: FileApi.get ..."
52
- end
53
- # verify the required parameter 'file_id' is set
54
- fail ArgumentError, "Missing the required parameter 'file_id' when calling FileApi.get" if file_id.nil?
55
- # resource path
56
- local_var_path = "/files/{fileID}".sub('{format}','json').sub('{' + 'fileID' + '}', file_id.to_s)
57
-
58
- # query parameters
59
- query_params = {}
60
-
61
- # header parameters
62
- header_params = {}
63
-
64
- # HTTP header 'Accept' (if needed)
65
- local_header_accept = ['application/json']
66
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
-
68
- # HTTP header 'Content-Type'
69
- local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
70
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
-
72
- # form parameters
73
- form_params = {}
74
-
75
- # http body (model)
76
- post_body = nil
77
- auth_names = ['oauth2']
78
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
79
- :header_params => header_params,
80
- :query_params => query_params,
81
- :form_params => form_params,
82
- :body => post_body,
83
- :auth_names => auth_names,
84
- :return_type => 'File')
85
- if @api_client.config.debugging
86
- @api_client.config.logger.debug "API called: FileApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
- end
88
- return data, status_code, headers
89
- end
90
-
91
- #
92
- #
93
- # @param [Hash] opts the optional parameters
94
- # @option opts [Integer] :page Page of results to return. Default: 1
95
- # @option opts [Integer] :page_size Number of results to return per page. Default: 20, max: 100.
96
- # @return [ListFile]
97
- def list(opts = {})
98
- data, _status_code, _headers = list_with_http_info(opts)
99
- return data
100
- end
101
-
102
- #
103
- #
104
- # @param [Hash] opts the optional parameters
105
- # @option opts [Integer] :page Page of results to return. Default: 1
106
- # @option opts [Integer] :page_size Number of results to return per page. Default: 20, max: 100.
107
- # @return [Array<(ListFile, Fixnum, Hash)>] ListFile data, response status code and response headers
108
- def list_with_http_info(opts = {})
109
- if @api_client.config.debugging
110
- @api_client.config.logger.debug "Calling API: FileApi.list ..."
111
- end
112
- # resource path
113
- local_var_path = "/files".sub('{format}','json')
114
-
115
- # query parameters
116
- query_params = {}
117
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
118
- query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
119
-
120
- # header parameters
121
- header_params = {}
122
-
123
- # HTTP header 'Accept' (if needed)
124
- local_header_accept = ['application/json']
125
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
126
-
127
- # HTTP header 'Content-Type'
128
- local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
129
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
130
-
131
- # form parameters
132
- form_params = {}
133
-
134
- # http body (model)
135
- post_body = nil
136
- auth_names = ['oauth2']
137
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
138
- :header_params => header_params,
139
- :query_params => query_params,
140
- :form_params => form_params,
141
- :body => post_body,
142
- :auth_names => auth_names,
143
- :return_type => 'ListFile')
144
- if @api_client.config.debugging
145
- @api_client.config.logger.debug "API called: FileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
146
- end
147
- return data, status_code, headers
148
- end
149
-
150
- #
151
- #
152
- # @param [Hash] opts the optional parameters
153
- # @option opts [String] :filename Filename of the file.
154
- # @return [File]
155
- def post_file_data(opts = {})
156
- data, _status_code, _headers = post_file_data_with_http_info(opts)
157
- return data
158
- end
159
-
160
- #
161
- #
162
- # @param [Hash] opts the optional parameters
163
- # @option opts [String] :filename Filename of the file.
164
- # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
165
- def post_file_data_with_http_info(opts = {})
166
- if @api_client.config.debugging
167
- @api_client.config.logger.debug "Calling API: FileApi.post_file_data ..."
168
- end
169
- # resource path
170
- local_var_path = "/files".sub('{format}','json')
171
-
172
- # query parameters
173
- query_params = {}
174
- query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
175
-
176
- # header parameters
177
- header_params = {}
178
-
179
- # HTTP header 'Accept' (if needed)
180
- local_header_accept = ['application/json']
181
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
182
-
183
- # HTTP header 'Content-Type'
184
- local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
185
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
186
-
187
- # form parameters
188
- form_params = {}
189
-
190
- # http body (model)
191
- post_body = nil
192
- auth_names = ['oauth2']
193
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
194
- :header_params => header_params,
195
- :query_params => query_params,
196
- :form_params => form_params,
197
- :body => post_body,
198
- :auth_names => auth_names,
199
- :return_type => 'File')
200
- if @api_client.config.debugging
201
- @api_client.config.logger.debug "API called: FileApi#post_file_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
202
- end
203
- return data, status_code, headers
204
- end
205
- end
206
- end
@@ -1,83 +0,0 @@
1
- =begin
2
- #OrderCloud
3
-
4
- #A full ecommerce backend as a service.
5
-
6
- OpenAPI spec version: 1.0
7
- Contact: ordercloud@four51.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- Licensed under the Apache License, Version 2.0 (the "License");
11
- you may not use this file except in compliance with the License.
12
- You may obtain a copy of the License at
13
-
14
- http://www.apache.org/licenses/LICENSE-2.0
15
-
16
- Unless required by applicable law or agreed to in writing, software
17
- distributed under the License is distributed on an "AS IS" BASIS,
18
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
- See the License for the specific language governing permissions and
20
- limitations under the License.
21
-
22
- =end
23
-
24
- require 'spec_helper'
25
- require 'json'
26
-
27
- # Unit tests for OrderCloud::FileApi
28
- # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
29
- # Please update as you see appropriate
30
- describe 'FileApi' do
31
- before do
32
- # run before each test
33
- @instance = OrderCloud::FileApi.new
34
- end
35
-
36
- after do
37
- # run after each test
38
- end
39
-
40
- describe 'test an instance of FileApi' do
41
- it 'should create an instact of FileApi' do
42
- expect(@instance).to be_instance_of(OrderCloud::FileApi)
43
- end
44
- end
45
-
46
- # unit tests for get
47
- #
48
- #
49
- # @param file_id ID of the file.
50
- # @param [Hash] opts the optional parameters
51
- # @return [File]
52
- describe 'get test' do
53
- it "should work" do
54
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
- end
56
- end
57
-
58
- # unit tests for list
59
- #
60
- #
61
- # @param [Hash] opts the optional parameters
62
- # @option opts [Integer] :page Page of results to return. Default: 1
63
- # @option opts [Integer] :page_size Number of results to return per page. Default: 20, max: 100.
64
- # @return [ListFile]
65
- describe 'list test' do
66
- it "should work" do
67
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
- end
69
- end
70
-
71
- # unit tests for post_file_data
72
- #
73
- #
74
- # @param [Hash] opts the optional parameters
75
- # @option opts [String] :filename Filename of the file.
76
- # @return [File]
77
- describe 'post_file_data test' do
78
- it "should work" do
79
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
- end
81
- end
82
-
83
- end