zippendo 1.0.0

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 (480) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +99 -0
  5. data/Rakefile +10 -0
  6. data/docs/AddressesApi.md +375 -0
  7. data/docs/BatchSendShipments200Response.md +20 -0
  8. data/docs/BatchSendShipments200ResponseResultsInner.md +26 -0
  9. data/docs/BatchSendShipments200ResponseSummary.md +22 -0
  10. data/docs/BatchSendShipmentsRequest.md +18 -0
  11. data/docs/BatchSplitShipment201Response.md +20 -0
  12. data/docs/BatchSplitShipmentRequest.md +28 -0
  13. data/docs/BatchSplitShipmentRequestShipmentsInner.md +20 -0
  14. data/docs/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md +20 -0
  15. data/docs/BillingApi.md +77 -0
  16. data/docs/CarrierCatalogApi.md +77 -0
  17. data/docs/CarriersApi.md +521 -0
  18. data/docs/ConnectCarrierRequest.md +22 -0
  19. data/docs/CreateAddressRequest.md +40 -0
  20. data/docs/CreateApiToken201Response.md +32 -0
  21. data/docs/CreateApiTokenRequest.md +22 -0
  22. data/docs/CreateOrder201Response.md +52 -0
  23. data/docs/CreateOrder201ResponseOrderLinesInner.md +54 -0
  24. data/docs/CreateOrder201ResponseShippingAddress.md +42 -0
  25. data/docs/CreateOrderRequest.md +40 -0
  26. data/docs/CreateOrderRequestOrderLinesInner.md +54 -0
  27. data/docs/CreateOrderRequestShippingAddress.md +42 -0
  28. data/docs/CreateOrgWebhook201Response.md +32 -0
  29. data/docs/CreateOrgWebhookRequest.md +24 -0
  30. data/docs/CreateShipment201Response.md +64 -0
  31. data/docs/CreateShipment201ResponseActivitiesInner.md +26 -0
  32. data/docs/CreateShipment201ResponseDocumentsInner.md +32 -0
  33. data/docs/CreateShipment201ResponseErrorsInner.md +26 -0
  34. data/docs/CreateShipment201ResponseLogsInner.md +32 -0
  35. data/docs/CreateShipment201ResponseParcelsInner.md +38 -0
  36. data/docs/CreateShipment201ResponseParcelsInnerDimensions.md +22 -0
  37. data/docs/CreateShipment201ResponseParcelsInnerOrderLinesInner.md +36 -0
  38. data/docs/CreateShipment201ResponsePartiesInner.md +38 -0
  39. data/docs/CreateShipment201ResponsePartiesInnerAttributesInner.md +20 -0
  40. data/docs/CreateShipment201ResponsePickupDetails.md +24 -0
  41. data/docs/CreateShipment201ResponseShippingRule.md +40 -0
  42. data/docs/CreateShipment201ResponseTracking.md +28 -0
  43. data/docs/CreateShipmentRequest.md +42 -0
  44. data/docs/CreateShipmentRequestCarrierSettings.md +24 -0
  45. data/docs/CreateShipmentRequestParcelsInner.md +38 -0
  46. data/docs/CreateShipmentRequestParcelsInnerDimensions.md +22 -0
  47. data/docs/CreateShipmentRequestParcelsInnerOrderLinesInner.md +36 -0
  48. data/docs/CreateShipmentRequestPartiesInner.md +38 -0
  49. data/docs/CreateShipmentRequestPartiesInnerAttributesInner.md +20 -0
  50. data/docs/CreateShipmentRequestPickupDetails.md +24 -0
  51. data/docs/CreateShippingQuote200Response.md +18 -0
  52. data/docs/CreateShippingQuote200ResponseRatesInner.md +38 -0
  53. data/docs/CreateShippingQuote400Response.md +20 -0
  54. data/docs/CreateShippingQuote404Response.md +20 -0
  55. data/docs/CreateShippingQuoteRequest.md +24 -0
  56. data/docs/CreateShippingQuoteRequestDestination.md +28 -0
  57. data/docs/CreateShippingQuoteRequestItemsInner.md +30 -0
  58. data/docs/CreateShippingRule201Response.md +74 -0
  59. data/docs/CreateShippingRuleRequest.md +66 -0
  60. data/docs/CreateShippingRuleRequestAdditionalParameters.md +15 -0
  61. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfInner.md +20 -0
  62. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValue.md +24 -0
  63. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md +24 -0
  64. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md +15 -0
  65. data/docs/CreateShippingRuleRequestConditionsInner.md +55 -0
  66. data/docs/CreateShippingRuleRequestConditionsInnerOneOf.md +26 -0
  67. data/docs/CreateShippingRuleRequestConditionsInnerOneOf1.md +28 -0
  68. data/docs/CreateShippingRuleRequestConditionsInnerOneOf2.md +28 -0
  69. data/docs/CreateShippingRuleRequestConditionsInnerOneOf3.md +26 -0
  70. data/docs/CreateShippingRuleRequestConditionsInnerOneOf4.md +22 -0
  71. data/docs/DeleteOrgWebhook200Response.md +18 -0
  72. data/docs/DeleteShippingRule200Response.md +18 -0
  73. data/docs/GetBillingUsage200Response.md +24 -0
  74. data/docs/GetBillingUsage200ResponseAddOnsInner.md +24 -0
  75. data/docs/GetBillingUsage200ResponseCurrentPeriod.md +20 -0
  76. data/docs/GetBillingUsage200ResponseLimits.md +30 -0
  77. data/docs/GetBillingUsage200ResponseLimitsTeamMembers.md +20 -0
  78. data/docs/GetBillingUsage200ResponseShipments.md +24 -0
  79. data/docs/GetOrder200Response.md +58 -0
  80. data/docs/GetOrder200ResponseShipmentsInner.md +36 -0
  81. data/docs/GetOrder200ResponseShippingRule.md +40 -0
  82. data/docs/GetOrg200Response.md +50 -0
  83. data/docs/GetOrg200ResponseCount.md +18 -0
  84. data/docs/GetOrgBranding200Response.md +22 -0
  85. data/docs/HealthCheck200Response.md +22 -0
  86. data/docs/ListAddresses200Response.md +26 -0
  87. data/docs/ListAddresses200ResponseDataInner.md +48 -0
  88. data/docs/ListApiTokens200Response.md +26 -0
  89. data/docs/ListApiTokens200ResponseDataInner.md +32 -0
  90. data/docs/ListApiTokens200ResponseDataInnerCreatedBy.md +22 -0
  91. data/docs/ListApiTokens401Response.md +22 -0
  92. data/docs/ListAvailableCarriers200ResponseInner.md +38 -0
  93. data/docs/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md +28 -0
  94. data/docs/ListCarrierProductServicePoints200ResponseInner.md +32 -0
  95. data/docs/ListCarrierProductServicePoints200ResponseInnerAddress.md +28 -0
  96. data/docs/ListCarrierProductServicePointsRequest.md +28 -0
  97. data/docs/ListCarrierProducts200ResponseInner.md +38 -0
  98. data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md +30 -0
  99. data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md +22 -0
  100. data/docs/ListCarrierProducts200ResponseInnerServicesInner.md +20 -0
  101. data/docs/ListCarrierProducts200ResponseInnerWeightLimits.md +22 -0
  102. data/docs/ListCarriers200Response.md +26 -0
  103. data/docs/ListCarriers200ResponseDataInner.md +38 -0
  104. data/docs/ListCarriers200ResponseDataInnerConfigValue.md +15 -0
  105. data/docs/ListOrders200Response.md +26 -0
  106. data/docs/ListOrders200ResponseDataInner.md +40 -0
  107. data/docs/ListOrders200ResponseDataInnerOrderChannel.md +22 -0
  108. data/docs/ListOrgWebhookDeliveries200Response.md +26 -0
  109. data/docs/ListOrgWebhookDeliveries200ResponseDataInner.md +38 -0
  110. data/docs/ListOrgWebhooks200Response.md +26 -0
  111. data/docs/ListOrgWebhooks200ResponseDataInner.md +30 -0
  112. data/docs/ListShipments200Response.md +26 -0
  113. data/docs/ListShipments200ResponseDataInner.md +32 -0
  114. data/docs/ListShipments200ResponseDataInnerAddress.md +48 -0
  115. data/docs/ListShipments200ResponseDataInnerCarrierSettings.md +24 -0
  116. data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md +24 -0
  117. data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md +24 -0
  118. data/docs/ListShippingRules200Response.md +26 -0
  119. data/docs/ListShippingRules200ResponseDataInner.md +84 -0
  120. data/docs/ListShippingRules200ResponseDataInnerAdditionalParametersInner.md +20 -0
  121. data/docs/ListShippingRules200ResponseDataInnerCarrier.md +30 -0
  122. data/docs/ListShippingRules200ResponseDataInnerConditionsInner.md +55 -0
  123. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.md +26 -0
  124. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.md +28 -0
  125. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.md +28 -0
  126. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.md +26 -0
  127. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.md +22 -0
  128. data/docs/ListShippingRules200ResponseDataInnerLabelPrinter.md +20 -0
  129. data/docs/ListShippingRules200ResponseDataInnerReturnShippingRule.md +20 -0
  130. data/docs/OrdersApi.md +379 -0
  131. data/docs/OrgsApi.md +503 -0
  132. data/docs/QuotesApi.md +79 -0
  133. data/docs/RevokeApiToken200Response.md +18 -0
  134. data/docs/RulesApi.md +373 -0
  135. data/docs/SendShipment422Response.md +24 -0
  136. data/docs/SendShipment422ResponseErrorsInner.md +20 -0
  137. data/docs/ShipmentsApi.md +962 -0
  138. data/docs/SplitShipment201Response.md +20 -0
  139. data/docs/SplitShipmentParcel200Response.md +18 -0
  140. data/docs/SplitShipmentParcelRequest.md +18 -0
  141. data/docs/SplitShipmentParcelRequestParcelsInner.md +20 -0
  142. data/docs/SplitShipmentRequest.md +30 -0
  143. data/docs/SystemApi.md +74 -0
  144. data/docs/TestOrgWebhook200Response.md +18 -0
  145. data/docs/TokensApi.md +443 -0
  146. data/docs/TrackShipment200Response.md +26 -0
  147. data/docs/TrackShipment200ResponseEventsInner.md +28 -0
  148. data/docs/UpdateAddressRequest.md +40 -0
  149. data/docs/UpdateApiTokenRequest.md +18 -0
  150. data/docs/UpdateCarrierRequest.md +22 -0
  151. data/docs/UpdateOrderRequest.md +38 -0
  152. data/docs/UpdateOrg200Response.md +48 -0
  153. data/docs/UpdateOrgBrandingRequest.md +20 -0
  154. data/docs/UpdateOrgRequest.md +44 -0
  155. data/docs/UpdateOrgWebhookRequest.md +24 -0
  156. data/docs/UpdateShipmentRequest.md +44 -0
  157. data/docs/UpdateShippingRuleRequest.md +66 -0
  158. data/docs/VerifyApiToken200Response.md +28 -0
  159. data/docs/VerifyApiTokenRequest.md +18 -0
  160. data/docs/WebhooksApi.md +523 -0
  161. data/git_push.sh +57 -0
  162. data/lib/zippendo/api/addresses_api.rb +406 -0
  163. data/lib/zippendo/api/billing_api.rb +85 -0
  164. data/lib/zippendo/api/carrier_catalog_api.rb +85 -0
  165. data/lib/zippendo/api/carriers_api.rb +554 -0
  166. data/lib/zippendo/api/orders_api.rb +412 -0
  167. data/lib/zippendo/api/orgs_api.rb +497 -0
  168. data/lib/zippendo/api/quotes_api.rb +96 -0
  169. data/lib/zippendo/api/rules_api.rb +399 -0
  170. data/lib/zippendo/api/shipments_api.rb +1003 -0
  171. data/lib/zippendo/api/system_api.rb +79 -0
  172. data/lib/zippendo/api/tokens_api.rb +467 -0
  173. data/lib/zippendo/api/webhooks_api.rb +559 -0
  174. data/lib/zippendo/api_client.rb +397 -0
  175. data/lib/zippendo/api_error.rb +58 -0
  176. data/lib/zippendo/api_model_base.rb +88 -0
  177. data/lib/zippendo/configuration.rb +309 -0
  178. data/lib/zippendo/models/batch_send_shipments200_response.rb +193 -0
  179. data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +260 -0
  180. data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +274 -0
  181. data/lib/zippendo/models/batch_send_shipments_request.rb +185 -0
  182. data/lib/zippendo/models/batch_split_shipment201_response.rb +193 -0
  183. data/lib/zippendo/models/batch_split_shipment_request.rb +247 -0
  184. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +186 -0
  185. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +210 -0
  186. data/lib/zippendo/models/connect_carrier_request.rb +239 -0
  187. data/lib/zippendo/models/create_address_request.rb +508 -0
  188. data/lib/zippendo/models/create_api_token201_response.rb +328 -0
  189. data/lib/zippendo/models/create_api_token_request.rb +267 -0
  190. data/lib/zippendo/models/create_order201_response.rb +491 -0
  191. data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +533 -0
  192. data/lib/zippendo/models/create_order201_response_shipping_address.rb +433 -0
  193. data/lib/zippendo/models/create_order_request.rb +410 -0
  194. data/lib/zippendo/models/create_order_request_order_lines_inner.rb +533 -0
  195. data/lib/zippendo/models/create_order_request_shipping_address.rb +433 -0
  196. data/lib/zippendo/models/create_org_webhook201_response.rb +356 -0
  197. data/lib/zippendo/models/create_org_webhook_request.rb +268 -0
  198. data/lib/zippendo/models/create_shipment201_response.rb +659 -0
  199. data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +281 -0
  200. data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +382 -0
  201. data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +257 -0
  202. data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +300 -0
  203. data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +356 -0
  204. data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +246 -0
  205. data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +402 -0
  206. data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +468 -0
  207. data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +210 -0
  208. data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +229 -0
  209. data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +365 -0
  210. data/lib/zippendo/models/create_shipment201_response_tracking.rb +204 -0
  211. data/lib/zippendo/models/create_shipment_request.rb +407 -0
  212. data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +250 -0
  213. data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +356 -0
  214. data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +246 -0
  215. data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +402 -0
  216. data/lib/zippendo/models/create_shipment_request_parties_inner.rb +451 -0
  217. data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +210 -0
  218. data/lib/zippendo/models/create_shipment_request_pickup_details.rb +229 -0
  219. data/lib/zippendo/models/create_shipping_quote200_response.rb +167 -0
  220. data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +333 -0
  221. data/lib/zippendo/models/create_shipping_quote400_response.rb +192 -0
  222. data/lib/zippendo/models/create_shipping_quote404_response.rb +192 -0
  223. data/lib/zippendo/models/create_shipping_quote_request.rb +276 -0
  224. data/lib/zippendo/models/create_shipping_quote_request_destination.rb +233 -0
  225. data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +315 -0
  226. data/lib/zippendo/models/create_shipping_rule201_response.rb +910 -0
  227. data/lib/zippendo/models/create_shipping_rule_request.rb +640 -0
  228. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +104 -0
  229. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner.rb +201 -0
  230. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value.rb +105 -0
  231. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb +259 -0
  232. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb +102 -0
  233. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +107 -0
  234. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +342 -0
  235. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +359 -0
  236. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +366 -0
  237. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +344 -0
  238. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +270 -0
  239. data/lib/zippendo/models/delete_org_webhook200_response.rb +165 -0
  240. data/lib/zippendo/models/delete_shipping_rule200_response.rb +165 -0
  241. data/lib/zippendo/models/get_billing_usage200_response.rb +245 -0
  242. data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +270 -0
  243. data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +192 -0
  244. data/lib/zippendo/models/get_billing_usage200_response_limits.rb +320 -0
  245. data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +192 -0
  246. data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +246 -0
  247. data/lib/zippendo/models/get_order200_response.rb +555 -0
  248. data/lib/zippendo/models/get_order200_response_shipments_inner.rb +385 -0
  249. data/lib/zippendo/models/get_order200_response_shipping_rule.rb +365 -0
  250. data/lib/zippendo/models/get_org200_response.rb +440 -0
  251. data/lib/zippendo/models/get_org200_response_count.rb +165 -0
  252. data/lib/zippendo/models/get_org_branding200_response.rb +177 -0
  253. data/lib/zippendo/models/health_check200_response.rb +219 -0
  254. data/lib/zippendo/models/list_addresses200_response.rb +275 -0
  255. data/lib/zippendo/models/list_addresses200_response_data_inner.rb +553 -0
  256. data/lib/zippendo/models/list_api_tokens200_response.rb +275 -0
  257. data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +327 -0
  258. data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +205 -0
  259. data/lib/zippendo/models/list_api_tokens401_response.rb +236 -0
  260. data/lib/zippendo/models/list_available_carriers200_response_inner.rb +286 -0
  261. data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +292 -0
  262. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +287 -0
  263. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +314 -0
  264. data/lib/zippendo/models/list_carrier_product_service_points_request.rb +313 -0
  265. data/lib/zippendo/models/list_carrier_products200_response_inner.rb +398 -0
  266. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +321 -0
  267. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +219 -0
  268. data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +192 -0
  269. data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +244 -0
  270. data/lib/zippendo/models/list_carriers200_response.rb +275 -0
  271. data/lib/zippendo/models/list_carriers200_response_data_inner.rb +369 -0
  272. data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +104 -0
  273. data/lib/zippendo/models/list_orders200_response.rb +275 -0
  274. data/lib/zippendo/models/list_orders200_response_data_inner.rb +423 -0
  275. data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +244 -0
  276. data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +275 -0
  277. data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +365 -0
  278. data/lib/zippendo/models/list_org_webhooks200_response.rb +275 -0
  279. data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +329 -0
  280. data/lib/zippendo/models/list_shipments200_response.rb +275 -0
  281. data/lib/zippendo/models/list_shipments200_response_data_inner.rb +362 -0
  282. data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +553 -0
  283. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +250 -0
  284. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb +105 -0
  285. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb +259 -0
  286. data/lib/zippendo/models/list_shipping_rules200_response.rb +275 -0
  287. data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +992 -0
  288. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner.rb +201 -0
  289. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +329 -0
  290. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +107 -0
  291. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +342 -0
  292. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +364 -0
  293. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +371 -0
  294. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +344 -0
  295. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +270 -0
  296. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +192 -0
  297. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +192 -0
  298. data/lib/zippendo/models/revoke_api_token200_response.rb +165 -0
  299. data/lib/zippendo/models/send_shipment422_response.rb +265 -0
  300. data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +175 -0
  301. data/lib/zippendo/models/split_shipment201_response.rb +190 -0
  302. data/lib/zippendo/models/split_shipment_parcel200_response.rb +164 -0
  303. data/lib/zippendo/models/split_shipment_parcel_request.rb +176 -0
  304. data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +186 -0
  305. data/lib/zippendo/models/split_shipment_request.rb +231 -0
  306. data/lib/zippendo/models/test_org_webhook200_response.rb +165 -0
  307. data/lib/zippendo/models/track_shipment200_response.rb +251 -0
  308. data/lib/zippendo/models/track_shipment200_response_events_inner.rb +296 -0
  309. data/lib/zippendo/models/update_address_request.rb +471 -0
  310. data/lib/zippendo/models/update_api_token_request.rb +183 -0
  311. data/lib/zippendo/models/update_carrier_request.rb +208 -0
  312. data/lib/zippendo/models/update_order_request.rb +400 -0
  313. data/lib/zippendo/models/update_org200_response.rb +414 -0
  314. data/lib/zippendo/models/update_org_branding_request.rb +194 -0
  315. data/lib/zippendo/models/update_org_request.rb +389 -0
  316. data/lib/zippendo/models/update_org_webhook_request.rb +235 -0
  317. data/lib/zippendo/models/update_shipment_request.rb +394 -0
  318. data/lib/zippendo/models/update_shipping_rule_request.rb +531 -0
  319. data/lib/zippendo/models/verify_api_token200_response.rb +218 -0
  320. data/lib/zippendo/models/verify_api_token_request.rb +165 -0
  321. data/lib/zippendo/version.rb +15 -0
  322. data/lib/zippendo.rb +195 -0
  323. data/spec/api/addresses_api_spec.rb +103 -0
  324. data/spec/api/billing_api_spec.rb +47 -0
  325. data/spec/api/carrier_catalog_api_spec.rb +47 -0
  326. data/spec/api/carriers_api_spec.rb +130 -0
  327. data/spec/api/orders_api_spec.rb +105 -0
  328. data/spec/api/orgs_api_spec.rb +122 -0
  329. data/spec/api/quotes_api_spec.rb +48 -0
  330. data/spec/api/rules_api_spec.rb +102 -0
  331. data/spec/api/shipments_api_spec.rb +212 -0
  332. data/spec/api/system_api_spec.rb +46 -0
  333. data/spec/api/tokens_api_spec.rb +114 -0
  334. data/spec/api/webhooks_api_spec.rb +130 -0
  335. data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +68 -0
  336. data/spec/models/batch_send_shipments200_response_spec.rb +42 -0
  337. data/spec/models/batch_send_shipments200_response_summary_spec.rb +48 -0
  338. data/spec/models/batch_send_shipments_request_spec.rb +36 -0
  339. data/spec/models/batch_split_shipment201_response_spec.rb +42 -0
  340. data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +42 -0
  341. data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +42 -0
  342. data/spec/models/batch_split_shipment_request_spec.rb +66 -0
  343. data/spec/models/connect_carrier_request_spec.rb +48 -0
  344. data/spec/models/create_address_request_spec.rb +106 -0
  345. data/spec/models/create_api_token201_response_spec.rb +78 -0
  346. data/spec/models/create_api_token_request_spec.rb +52 -0
  347. data/spec/models/create_order201_response_order_lines_inner_spec.rb +148 -0
  348. data/spec/models/create_order201_response_shipping_address_spec.rb +108 -0
  349. data/spec/models/create_order201_response_spec.rb +142 -0
  350. data/spec/models/create_order_request_order_lines_inner_spec.rb +148 -0
  351. data/spec/models/create_order_request_shipping_address_spec.rb +108 -0
  352. data/spec/models/create_order_request_spec.rb +102 -0
  353. data/spec/models/create_org_webhook201_response_spec.rb +78 -0
  354. data/spec/models/create_org_webhook_request_spec.rb +58 -0
  355. data/spec/models/create_shipment201_response_activities_inner_spec.rb +64 -0
  356. data/spec/models/create_shipment201_response_documents_inner_spec.rb +90 -0
  357. data/spec/models/create_shipment201_response_errors_inner_spec.rb +60 -0
  358. data/spec/models/create_shipment201_response_logs_inner_spec.rb +82 -0
  359. data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +48 -0
  360. data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +90 -0
  361. data/spec/models/create_shipment201_response_parcels_inner_spec.rb +100 -0
  362. data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +42 -0
  363. data/spec/models/create_shipment201_response_parties_inner_spec.rb +100 -0
  364. data/spec/models/create_shipment201_response_pickup_details_spec.rb +54 -0
  365. data/spec/models/create_shipment201_response_shipping_rule_spec.rb +102 -0
  366. data/spec/models/create_shipment201_response_spec.rb +182 -0
  367. data/spec/models/create_shipment201_response_tracking_spec.rb +66 -0
  368. data/spec/models/create_shipment_request_carrier_settings_spec.rb +54 -0
  369. data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +48 -0
  370. data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +90 -0
  371. data/spec/models/create_shipment_request_parcels_inner_spec.rb +100 -0
  372. data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +42 -0
  373. data/spec/models/create_shipment_request_parties_inner_spec.rb +100 -0
  374. data/spec/models/create_shipment_request_pickup_details_spec.rb +54 -0
  375. data/spec/models/create_shipment_request_spec.rb +116 -0
  376. data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +96 -0
  377. data/spec/models/create_shipping_quote200_response_spec.rb +36 -0
  378. data/spec/models/create_shipping_quote400_response_spec.rb +42 -0
  379. data/spec/models/create_shipping_quote404_response_spec.rb +42 -0
  380. data/spec/models/create_shipping_quote_request_destination_spec.rb +66 -0
  381. data/spec/models/create_shipping_quote_request_items_inner_spec.rb +72 -0
  382. data/spec/models/create_shipping_quote_request_spec.rb +54 -0
  383. data/spec/models/create_shipping_rule201_response_spec.rb +208 -0
  384. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +42 -0
  385. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +21 -0
  386. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +54 -0
  387. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +21 -0
  388. data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +21 -0
  389. data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +78 -0
  390. data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +74 -0
  391. data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +68 -0
  392. data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +52 -0
  393. data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +64 -0
  394. data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +32 -0
  395. data/spec/models/create_shipping_rule_request_spec.rb +184 -0
  396. data/spec/models/delete_org_webhook200_response_spec.rb +36 -0
  397. data/spec/models/delete_shipping_rule200_response_spec.rb +36 -0
  398. data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +58 -0
  399. data/spec/models/get_billing_usage200_response_current_period_spec.rb +42 -0
  400. data/spec/models/get_billing_usage200_response_limits_spec.rb +72 -0
  401. data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +42 -0
  402. data/spec/models/get_billing_usage200_response_shipments_spec.rb +54 -0
  403. data/spec/models/get_billing_usage200_response_spec.rb +54 -0
  404. data/spec/models/get_order200_response_shipments_inner_spec.rb +98 -0
  405. data/spec/models/get_order200_response_shipping_rule_spec.rb +102 -0
  406. data/spec/models/get_order200_response_spec.rb +160 -0
  407. data/spec/models/get_org200_response_count_spec.rb +36 -0
  408. data/spec/models/get_org200_response_spec.rb +132 -0
  409. data/spec/models/get_org_branding200_response_spec.rb +48 -0
  410. data/spec/models/health_check200_response_spec.rb +48 -0
  411. data/spec/models/list_addresses200_response_data_inner_spec.rb +130 -0
  412. data/spec/models/list_addresses200_response_spec.rb +60 -0
  413. data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +48 -0
  414. data/spec/models/list_api_tokens200_response_data_inner_spec.rb +78 -0
  415. data/spec/models/list_api_tokens200_response_spec.rb +60 -0
  416. data/spec/models/list_api_tokens401_response_spec.rb +52 -0
  417. data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +70 -0
  418. data/spec/models/list_available_carriers200_response_inner_spec.rb +96 -0
  419. data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +66 -0
  420. data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +78 -0
  421. data/spec/models/list_carrier_product_service_points_request_spec.rb +66 -0
  422. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +48 -0
  423. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +76 -0
  424. data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +42 -0
  425. data/spec/models/list_carrier_products200_response_inner_spec.rb +100 -0
  426. data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +52 -0
  427. data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +21 -0
  428. data/spec/models/list_carriers200_response_data_inner_spec.rb +96 -0
  429. data/spec/models/list_carriers200_response_spec.rb +60 -0
  430. data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +52 -0
  431. data/spec/models/list_orders200_response_data_inner_spec.rb +106 -0
  432. data/spec/models/list_orders200_response_spec.rb +60 -0
  433. data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +96 -0
  434. data/spec/models/list_org_webhook_deliveries200_response_spec.rb +60 -0
  435. data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +72 -0
  436. data/spec/models/list_org_webhooks200_response_spec.rb +60 -0
  437. data/spec/models/list_shipments200_response_data_inner_address_spec.rb +130 -0
  438. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +54 -0
  439. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +21 -0
  440. data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +54 -0
  441. data/spec/models/list_shipments200_response_data_inner_spec.rb +86 -0
  442. data/spec/models/list_shipments200_response_spec.rb +60 -0
  443. data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +42 -0
  444. data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +72 -0
  445. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +78 -0
  446. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +74 -0
  447. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +68 -0
  448. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +52 -0
  449. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +64 -0
  450. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +32 -0
  451. data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +42 -0
  452. data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +42 -0
  453. data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +238 -0
  454. data/spec/models/list_shipping_rules200_response_spec.rb +60 -0
  455. data/spec/models/revoke_api_token200_response_spec.rb +36 -0
  456. data/spec/models/send_shipment422_response_errors_inner_spec.rb +42 -0
  457. data/spec/models/send_shipment422_response_spec.rb +58 -0
  458. data/spec/models/split_shipment201_response_spec.rb +42 -0
  459. data/spec/models/split_shipment_parcel200_response_spec.rb +36 -0
  460. data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +42 -0
  461. data/spec/models/split_shipment_parcel_request_spec.rb +36 -0
  462. data/spec/models/split_shipment_request_spec.rb +72 -0
  463. data/spec/models/test_org_webhook200_response_spec.rb +36 -0
  464. data/spec/models/track_shipment200_response_events_inner_spec.rb +70 -0
  465. data/spec/models/track_shipment200_response_spec.rb +64 -0
  466. data/spec/models/update_address_request_spec.rb +106 -0
  467. data/spec/models/update_api_token_request_spec.rb +36 -0
  468. data/spec/models/update_carrier_request_spec.rb +48 -0
  469. data/spec/models/update_order_request_spec.rb +100 -0
  470. data/spec/models/update_org200_response_spec.rb +126 -0
  471. data/spec/models/update_org_branding_request_spec.rb +42 -0
  472. data/spec/models/update_org_request_spec.rb +118 -0
  473. data/spec/models/update_org_webhook_request_spec.rb +58 -0
  474. data/spec/models/update_shipment_request_spec.rb +122 -0
  475. data/spec/models/update_shipping_rule_request_spec.rb +184 -0
  476. data/spec/models/verify_api_token200_response_spec.rb +66 -0
  477. data/spec/models/verify_api_token_request_spec.rb +36 -0
  478. data/spec/spec_helper.rb +111 -0
  479. data/zippendo.gemspec +39 -0
  480. metadata +715 -0
@@ -0,0 +1,559 @@
1
+ =begin
2
+ #Zippendo Public API
3
+
4
+ #Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zippendo.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.24.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Zippendo
16
+ class WebhooksApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create webhook
23
+ # Create a new webhook endpoint for an organization that receives event notifications.
24
+ # @param org_id [String] Organization ID
25
+ # @param create_org_webhook_request [CreateOrgWebhookRequest]
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [CreateOrgWebhook201Response]
28
+ def create_org_webhook(org_id, create_org_webhook_request, opts = {})
29
+ data, _status_code, _headers = create_org_webhook_with_http_info(org_id, create_org_webhook_request, opts)
30
+ data
31
+ end
32
+
33
+ # Create webhook
34
+ # Create a new webhook endpoint for an organization that receives event notifications.
35
+ # @param org_id [String] Organization ID
36
+ # @param create_org_webhook_request [CreateOrgWebhookRequest]
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(CreateOrgWebhook201Response, Integer, Hash)>] CreateOrgWebhook201Response data, response status code and response headers
39
+ def create_org_webhook_with_http_info(org_id, create_org_webhook_request, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.create_org_webhook ...'
42
+ end
43
+ # verify the required parameter 'org_id' is set
44
+ if @api_client.config.client_side_validation && org_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.create_org_webhook"
46
+ end
47
+ # verify the required parameter 'create_org_webhook_request' is set
48
+ if @api_client.config.client_side_validation && create_org_webhook_request.nil?
49
+ fail ArgumentError, "Missing the required parameter 'create_org_webhook_request' when calling WebhooksApi.create_org_webhook"
50
+ end
51
+ # resource path
52
+ local_var_path = '/orgs/{orgId}/webhooks'.sub('{orgId}', CGI.escape(org_id.to_s))
53
+
54
+ # query parameters
55
+ query_params = opts[:query_params] || {}
56
+
57
+ # header parameters
58
+ header_params = opts[:header_params] || {}
59
+ # HTTP header 'Accept' (if needed)
60
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
61
+ # HTTP header 'Content-Type'
62
+ content_type = @api_client.select_header_content_type(['application/json'])
63
+ if !content_type.nil?
64
+ header_params['Content-Type'] = content_type
65
+ end
66
+
67
+ # form parameters
68
+ form_params = opts[:form_params] || {}
69
+
70
+ # http body (model)
71
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_org_webhook_request)
72
+
73
+ # return_type
74
+ return_type = opts[:debug_return_type] || 'CreateOrgWebhook201Response'
75
+
76
+ # auth_names
77
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
78
+
79
+ new_options = opts.merge(
80
+ :operation => :"WebhooksApi.create_org_webhook",
81
+ :header_params => header_params,
82
+ :query_params => query_params,
83
+ :form_params => form_params,
84
+ :body => post_body,
85
+ :auth_names => auth_names,
86
+ :return_type => return_type
87
+ )
88
+
89
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
90
+ if @api_client.config.debugging
91
+ @api_client.config.logger.debug "API called: WebhooksApi#create_org_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
92
+ end
93
+ return data, status_code, headers
94
+ end
95
+
96
+ # Delete webhook
97
+ # Permanently delete a webhook and all its delivery logs.
98
+ # @param org_id [String] Organization ID
99
+ # @param webhook_id [String] Webhook ID
100
+ # @param [Hash] opts the optional parameters
101
+ # @return [DeleteOrgWebhook200Response]
102
+ def delete_org_webhook(org_id, webhook_id, opts = {})
103
+ data, _status_code, _headers = delete_org_webhook_with_http_info(org_id, webhook_id, opts)
104
+ data
105
+ end
106
+
107
+ # Delete webhook
108
+ # Permanently delete a webhook and all its delivery logs.
109
+ # @param org_id [String] Organization ID
110
+ # @param webhook_id [String] Webhook ID
111
+ # @param [Hash] opts the optional parameters
112
+ # @return [Array<(DeleteOrgWebhook200Response, Integer, Hash)>] DeleteOrgWebhook200Response data, response status code and response headers
113
+ def delete_org_webhook_with_http_info(org_id, webhook_id, opts = {})
114
+ if @api_client.config.debugging
115
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_org_webhook ...'
116
+ end
117
+ # verify the required parameter 'org_id' is set
118
+ if @api_client.config.client_side_validation && org_id.nil?
119
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.delete_org_webhook"
120
+ end
121
+ # verify the required parameter 'webhook_id' is set
122
+ if @api_client.config.client_side_validation && webhook_id.nil?
123
+ fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.delete_org_webhook"
124
+ end
125
+ # resource path
126
+ local_var_path = '/orgs/{orgId}/webhooks/{webhookId}'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{webhookId}', CGI.escape(webhook_id.to_s))
127
+
128
+ # query parameters
129
+ query_params = opts[:query_params] || {}
130
+
131
+ # header parameters
132
+ header_params = opts[:header_params] || {}
133
+ # HTTP header 'Accept' (if needed)
134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
135
+
136
+ # form parameters
137
+ form_params = opts[:form_params] || {}
138
+
139
+ # http body (model)
140
+ post_body = opts[:debug_body]
141
+
142
+ # return_type
143
+ return_type = opts[:debug_return_type] || 'DeleteOrgWebhook200Response'
144
+
145
+ # auth_names
146
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
147
+
148
+ new_options = opts.merge(
149
+ :operation => :"WebhooksApi.delete_org_webhook",
150
+ :header_params => header_params,
151
+ :query_params => query_params,
152
+ :form_params => form_params,
153
+ :body => post_body,
154
+ :auth_names => auth_names,
155
+ :return_type => return_type
156
+ )
157
+
158
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
159
+ if @api_client.config.debugging
160
+ @api_client.config.logger.debug "API called: WebhooksApi#delete_org_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
161
+ end
162
+ return data, status_code, headers
163
+ end
164
+
165
+ # Get webhook
166
+ # Get a specific webhook including its signing secret.
167
+ # @param org_id [String] Organization ID
168
+ # @param webhook_id [String] Webhook ID
169
+ # @param [Hash] opts the optional parameters
170
+ # @return [CreateOrgWebhook201Response]
171
+ def get_org_webhook(org_id, webhook_id, opts = {})
172
+ data, _status_code, _headers = get_org_webhook_with_http_info(org_id, webhook_id, opts)
173
+ data
174
+ end
175
+
176
+ # Get webhook
177
+ # Get a specific webhook including its signing secret.
178
+ # @param org_id [String] Organization ID
179
+ # @param webhook_id [String] Webhook ID
180
+ # @param [Hash] opts the optional parameters
181
+ # @return [Array<(CreateOrgWebhook201Response, Integer, Hash)>] CreateOrgWebhook201Response data, response status code and response headers
182
+ def get_org_webhook_with_http_info(org_id, webhook_id, opts = {})
183
+ if @api_client.config.debugging
184
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_org_webhook ...'
185
+ end
186
+ # verify the required parameter 'org_id' is set
187
+ if @api_client.config.client_side_validation && org_id.nil?
188
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.get_org_webhook"
189
+ end
190
+ # verify the required parameter 'webhook_id' is set
191
+ if @api_client.config.client_side_validation && webhook_id.nil?
192
+ fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.get_org_webhook"
193
+ end
194
+ # resource path
195
+ local_var_path = '/orgs/{orgId}/webhooks/{webhookId}'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{webhookId}', CGI.escape(webhook_id.to_s))
196
+
197
+ # query parameters
198
+ query_params = opts[:query_params] || {}
199
+
200
+ # header parameters
201
+ header_params = opts[:header_params] || {}
202
+ # HTTP header 'Accept' (if needed)
203
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
204
+
205
+ # form parameters
206
+ form_params = opts[:form_params] || {}
207
+
208
+ # http body (model)
209
+ post_body = opts[:debug_body]
210
+
211
+ # return_type
212
+ return_type = opts[:debug_return_type] || 'CreateOrgWebhook201Response'
213
+
214
+ # auth_names
215
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
216
+
217
+ new_options = opts.merge(
218
+ :operation => :"WebhooksApi.get_org_webhook",
219
+ :header_params => header_params,
220
+ :query_params => query_params,
221
+ :form_params => form_params,
222
+ :body => post_body,
223
+ :auth_names => auth_names,
224
+ :return_type => return_type
225
+ )
226
+
227
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
228
+ if @api_client.config.debugging
229
+ @api_client.config.logger.debug "API called: WebhooksApi#get_org_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
230
+ end
231
+ return data, status_code, headers
232
+ end
233
+
234
+ # List webhook deliveries
235
+ # List the delivery history for a specific webhook.
236
+ # @param org_id [String] Organization ID
237
+ # @param webhook_id [String] Webhook ID
238
+ # @param [Hash] opts the optional parameters
239
+ # @option opts [Integer] :page Page number (1-based) (default to 1)
240
+ # @option opts [Integer] :limit Items per page (max 100) (default to 20)
241
+ # @return [ListOrgWebhookDeliveries200Response]
242
+ def list_org_webhook_deliveries(org_id, webhook_id, opts = {})
243
+ data, _status_code, _headers = list_org_webhook_deliveries_with_http_info(org_id, webhook_id, opts)
244
+ data
245
+ end
246
+
247
+ # List webhook deliveries
248
+ # List the delivery history for a specific webhook.
249
+ # @param org_id [String] Organization ID
250
+ # @param webhook_id [String] Webhook ID
251
+ # @param [Hash] opts the optional parameters
252
+ # @option opts [Integer] :page Page number (1-based) (default to 1)
253
+ # @option opts [Integer] :limit Items per page (max 100) (default to 20)
254
+ # @return [Array<(ListOrgWebhookDeliveries200Response, Integer, Hash)>] ListOrgWebhookDeliveries200Response data, response status code and response headers
255
+ def list_org_webhook_deliveries_with_http_info(org_id, webhook_id, opts = {})
256
+ if @api_client.config.debugging
257
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.list_org_webhook_deliveries ...'
258
+ end
259
+ # verify the required parameter 'org_id' is set
260
+ if @api_client.config.client_side_validation && org_id.nil?
261
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.list_org_webhook_deliveries"
262
+ end
263
+ # verify the required parameter 'webhook_id' is set
264
+ if @api_client.config.client_side_validation && webhook_id.nil?
265
+ fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.list_org_webhook_deliveries"
266
+ end
267
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 9007199254740991
268
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WebhooksApi.list_org_webhook_deliveries, must be smaller than or equal to 9007199254740991.'
269
+ end
270
+
271
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
272
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WebhooksApi.list_org_webhook_deliveries, must be greater than or equal to 1.'
273
+ end
274
+
275
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
276
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WebhooksApi.list_org_webhook_deliveries, must be smaller than or equal to 100.'
277
+ end
278
+
279
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
280
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WebhooksApi.list_org_webhook_deliveries, must be greater than or equal to 1.'
281
+ end
282
+
283
+ # resource path
284
+ local_var_path = '/orgs/{orgId}/webhooks/{webhookId}/deliveries'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{webhookId}', CGI.escape(webhook_id.to_s))
285
+
286
+ # query parameters
287
+ query_params = opts[:query_params] || {}
288
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
289
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
290
+
291
+ # header parameters
292
+ header_params = opts[:header_params] || {}
293
+ # HTTP header 'Accept' (if needed)
294
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
295
+
296
+ # form parameters
297
+ form_params = opts[:form_params] || {}
298
+
299
+ # http body (model)
300
+ post_body = opts[:debug_body]
301
+
302
+ # return_type
303
+ return_type = opts[:debug_return_type] || 'ListOrgWebhookDeliveries200Response'
304
+
305
+ # auth_names
306
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
307
+
308
+ new_options = opts.merge(
309
+ :operation => :"WebhooksApi.list_org_webhook_deliveries",
310
+ :header_params => header_params,
311
+ :query_params => query_params,
312
+ :form_params => form_params,
313
+ :body => post_body,
314
+ :auth_names => auth_names,
315
+ :return_type => return_type
316
+ )
317
+
318
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
319
+ if @api_client.config.debugging
320
+ @api_client.config.logger.debug "API called: WebhooksApi#list_org_webhook_deliveries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
321
+ end
322
+ return data, status_code, headers
323
+ end
324
+
325
+ # List webhooks
326
+ # List all webhooks belonging to an organization.
327
+ # @param org_id [String] Organization ID
328
+ # @param [Hash] opts the optional parameters
329
+ # @option opts [Integer] :page Page number (1-based) (default to 1)
330
+ # @option opts [Integer] :limit Items per page (max 100) (default to 20)
331
+ # @return [ListOrgWebhooks200Response]
332
+ def list_org_webhooks(org_id, opts = {})
333
+ data, _status_code, _headers = list_org_webhooks_with_http_info(org_id, opts)
334
+ data
335
+ end
336
+
337
+ # List webhooks
338
+ # List all webhooks belonging to an organization.
339
+ # @param org_id [String] Organization ID
340
+ # @param [Hash] opts the optional parameters
341
+ # @option opts [Integer] :page Page number (1-based) (default to 1)
342
+ # @option opts [Integer] :limit Items per page (max 100) (default to 20)
343
+ # @return [Array<(ListOrgWebhooks200Response, Integer, Hash)>] ListOrgWebhooks200Response data, response status code and response headers
344
+ def list_org_webhooks_with_http_info(org_id, opts = {})
345
+ if @api_client.config.debugging
346
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.list_org_webhooks ...'
347
+ end
348
+ # verify the required parameter 'org_id' is set
349
+ if @api_client.config.client_side_validation && org_id.nil?
350
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.list_org_webhooks"
351
+ end
352
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 9007199254740991
353
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WebhooksApi.list_org_webhooks, must be smaller than or equal to 9007199254740991.'
354
+ end
355
+
356
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
357
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WebhooksApi.list_org_webhooks, must be greater than or equal to 1.'
358
+ end
359
+
360
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
361
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WebhooksApi.list_org_webhooks, must be smaller than or equal to 100.'
362
+ end
363
+
364
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
365
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WebhooksApi.list_org_webhooks, must be greater than or equal to 1.'
366
+ end
367
+
368
+ # resource path
369
+ local_var_path = '/orgs/{orgId}/webhooks'.sub('{orgId}', CGI.escape(org_id.to_s))
370
+
371
+ # query parameters
372
+ query_params = opts[:query_params] || {}
373
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
374
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
375
+
376
+ # header parameters
377
+ header_params = opts[:header_params] || {}
378
+ # HTTP header 'Accept' (if needed)
379
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
380
+
381
+ # form parameters
382
+ form_params = opts[:form_params] || {}
383
+
384
+ # http body (model)
385
+ post_body = opts[:debug_body]
386
+
387
+ # return_type
388
+ return_type = opts[:debug_return_type] || 'ListOrgWebhooks200Response'
389
+
390
+ # auth_names
391
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
392
+
393
+ new_options = opts.merge(
394
+ :operation => :"WebhooksApi.list_org_webhooks",
395
+ :header_params => header_params,
396
+ :query_params => query_params,
397
+ :form_params => form_params,
398
+ :body => post_body,
399
+ :auth_names => auth_names,
400
+ :return_type => return_type
401
+ )
402
+
403
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
404
+ if @api_client.config.debugging
405
+ @api_client.config.logger.debug "API called: WebhooksApi#list_org_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
406
+ end
407
+ return data, status_code, headers
408
+ end
409
+
410
+ # Test webhook
411
+ # Send a test ping event to the webhook endpoint to verify connectivity.
412
+ # @param org_id [String] Organization ID
413
+ # @param webhook_id [String] Webhook ID
414
+ # @param [Hash] opts the optional parameters
415
+ # @return [TestOrgWebhook200Response]
416
+ def test_org_webhook(org_id, webhook_id, opts = {})
417
+ data, _status_code, _headers = test_org_webhook_with_http_info(org_id, webhook_id, opts)
418
+ data
419
+ end
420
+
421
+ # Test webhook
422
+ # Send a test ping event to the webhook endpoint to verify connectivity.
423
+ # @param org_id [String] Organization ID
424
+ # @param webhook_id [String] Webhook ID
425
+ # @param [Hash] opts the optional parameters
426
+ # @return [Array<(TestOrgWebhook200Response, Integer, Hash)>] TestOrgWebhook200Response data, response status code and response headers
427
+ def test_org_webhook_with_http_info(org_id, webhook_id, opts = {})
428
+ if @api_client.config.debugging
429
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.test_org_webhook ...'
430
+ end
431
+ # verify the required parameter 'org_id' is set
432
+ if @api_client.config.client_side_validation && org_id.nil?
433
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.test_org_webhook"
434
+ end
435
+ # verify the required parameter 'webhook_id' is set
436
+ if @api_client.config.client_side_validation && webhook_id.nil?
437
+ fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.test_org_webhook"
438
+ end
439
+ # resource path
440
+ local_var_path = '/orgs/{orgId}/webhooks/{webhookId}/test'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{webhookId}', CGI.escape(webhook_id.to_s))
441
+
442
+ # query parameters
443
+ query_params = opts[:query_params] || {}
444
+
445
+ # header parameters
446
+ header_params = opts[:header_params] || {}
447
+ # HTTP header 'Accept' (if needed)
448
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
449
+
450
+ # form parameters
451
+ form_params = opts[:form_params] || {}
452
+
453
+ # http body (model)
454
+ post_body = opts[:debug_body]
455
+
456
+ # return_type
457
+ return_type = opts[:debug_return_type] || 'TestOrgWebhook200Response'
458
+
459
+ # auth_names
460
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
461
+
462
+ new_options = opts.merge(
463
+ :operation => :"WebhooksApi.test_org_webhook",
464
+ :header_params => header_params,
465
+ :query_params => query_params,
466
+ :form_params => form_params,
467
+ :body => post_body,
468
+ :auth_names => auth_names,
469
+ :return_type => return_type
470
+ )
471
+
472
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
473
+ if @api_client.config.debugging
474
+ @api_client.config.logger.debug "API called: WebhooksApi#test_org_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
475
+ end
476
+ return data, status_code, headers
477
+ end
478
+
479
+ # Update webhook
480
+ # Update the configuration of an existing webhook.
481
+ # @param org_id [String] Organization ID
482
+ # @param webhook_id [String] Webhook ID
483
+ # @param update_org_webhook_request [UpdateOrgWebhookRequest]
484
+ # @param [Hash] opts the optional parameters
485
+ # @return [CreateOrgWebhook201Response]
486
+ def update_org_webhook(org_id, webhook_id, update_org_webhook_request, opts = {})
487
+ data, _status_code, _headers = update_org_webhook_with_http_info(org_id, webhook_id, update_org_webhook_request, opts)
488
+ data
489
+ end
490
+
491
+ # Update webhook
492
+ # Update the configuration of an existing webhook.
493
+ # @param org_id [String] Organization ID
494
+ # @param webhook_id [String] Webhook ID
495
+ # @param update_org_webhook_request [UpdateOrgWebhookRequest]
496
+ # @param [Hash] opts the optional parameters
497
+ # @return [Array<(CreateOrgWebhook201Response, Integer, Hash)>] CreateOrgWebhook201Response data, response status code and response headers
498
+ def update_org_webhook_with_http_info(org_id, webhook_id, update_org_webhook_request, opts = {})
499
+ if @api_client.config.debugging
500
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.update_org_webhook ...'
501
+ end
502
+ # verify the required parameter 'org_id' is set
503
+ if @api_client.config.client_side_validation && org_id.nil?
504
+ fail ArgumentError, "Missing the required parameter 'org_id' when calling WebhooksApi.update_org_webhook"
505
+ end
506
+ # verify the required parameter 'webhook_id' is set
507
+ if @api_client.config.client_side_validation && webhook_id.nil?
508
+ fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.update_org_webhook"
509
+ end
510
+ # verify the required parameter 'update_org_webhook_request' is set
511
+ if @api_client.config.client_side_validation && update_org_webhook_request.nil?
512
+ fail ArgumentError, "Missing the required parameter 'update_org_webhook_request' when calling WebhooksApi.update_org_webhook"
513
+ end
514
+ # resource path
515
+ local_var_path = '/orgs/{orgId}/webhooks/{webhookId}'.sub('{orgId}', CGI.escape(org_id.to_s)).sub('{webhookId}', CGI.escape(webhook_id.to_s))
516
+
517
+ # query parameters
518
+ query_params = opts[:query_params] || {}
519
+
520
+ # header parameters
521
+ header_params = opts[:header_params] || {}
522
+ # HTTP header 'Accept' (if needed)
523
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
524
+ # HTTP header 'Content-Type'
525
+ content_type = @api_client.select_header_content_type(['application/json'])
526
+ if !content_type.nil?
527
+ header_params['Content-Type'] = content_type
528
+ end
529
+
530
+ # form parameters
531
+ form_params = opts[:form_params] || {}
532
+
533
+ # http body (model)
534
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_org_webhook_request)
535
+
536
+ # return_type
537
+ return_type = opts[:debug_return_type] || 'CreateOrgWebhook201Response'
538
+
539
+ # auth_names
540
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
541
+
542
+ new_options = opts.merge(
543
+ :operation => :"WebhooksApi.update_org_webhook",
544
+ :header_params => header_params,
545
+ :query_params => query_params,
546
+ :form_params => form_params,
547
+ :body => post_body,
548
+ :auth_names => auth_names,
549
+ :return_type => return_type
550
+ )
551
+
552
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
553
+ if @api_client.config.debugging
554
+ @api_client.config.logger.debug "API called: WebhooksApi#update_org_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
555
+ end
556
+ return data, status_code, headers
557
+ end
558
+ end
559
+ end