RubyGems - ultracart_api - Versions diffs - 4.1.18 → 4.1.20 - Mend

ultracart_api 4.1.18 → 4.1.20

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 (32) hide show

checksums.yaml +4 -4
data/README.md +13 -10
data/docs/ConversationVirtualAgentCapabilities.md +7 -1
data/docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md +20 -0
data/docs/CustomDashboard.md +3 -1
data/docs/CustomDashboardExecutionParameter.md +24 -0
data/docs/CustomDashboardSchedule.md +26 -0
data/docs/{ChargebackDisputeResponse.md → CustomDashboardScheduleResponse.md} +4 -4
data/docs/{ChargebackDisputesResponse.md → CustomDashboardSchedulesResponse.md} +4 -4
data/docs/CustomReport.md +2 -0
data/docs/CustomReportExecutionParameter.md +2 -0
data/docs/DatawarehouseApi.md +220 -0
data/docs/EmailCampaign.md +4 -0
data/lib/ultracart_api/api/datawarehouse_api.rb +290 -0
data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +38 -6
data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb +228 -0
data/lib/ultracart_api/models/custom_dashboard.rb +15 -4
data/lib/ultracart_api/models/custom_dashboard_execution_parameter.rb +246 -0
data/lib/ultracart_api/models/custom_dashboard_schedule.rb +258 -0
data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_dashboard_schedule_response.rb} +13 -13
data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedules_response.rb} +16 -15
data/lib/ultracart_api/models/custom_report.rb +10 -1
data/lib/ultracart_api/models/custom_report_execution_parameter.rb +10 -1
data/lib/ultracart_api/models/email_campaign.rb +21 -1
data/lib/ultracart_api/models/order_payment.rb +2 -2
data/lib/ultracart_api/version.rb +1 -1
data/lib/ultracart_api.rb +5 -4
metadata +12 -10
data/docs/ChargebackApi.md +0 -297
data/docs/ChargebackDispute.md +0 -62
data/lib/ultracart_api/api/chargeback_api.rb +0 -410
data/lib/ultracart_api/models/chargeback_dispute.rb +0 -649

data/docs/ChargebackApi.md DELETED Viewed

@@ -1,297 +0,0 @@
-# UltracartClient::ChargebackApi
-All URIs are relative to *https://secure.ultracart.com/rest/v2*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**delete_chargeback**](ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback |
-| [**get_chargeback_dispute**](ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback |
-| [**get_chargeback_disputes**](ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks |
-| [**insert_chargeback**](ChargebackApi.md#insert_chargeback) | **POST** /chargeback/chargebacks | Insert a chargeback |
-| [**update_chargeback**](ChargebackApi.md#update_chargeback) | **PUT** /chargeback/chargebacks/{chargeback_dispute_oid} | Update a chargeback |
-## delete_chargeback
-> <ChargebackDisputeResponse> delete_chargeback(chargeback_dispute_oid)
-Delete a chargeback
-Delete a chargeback on the UltraCart account.
-### Examples
-```ruby
-# Internal API.  No samples are provided as merchants will never need this api method
-```
-#### Using the delete_chargeback_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<ChargebackDisputeResponse>, Integer, Hash)> delete_chargeback_with_http_info(chargeback_dispute_oid)
-```ruby
-begin
-  # Delete a chargeback
-  data, status_code, headers = api_instance.delete_chargeback_with_http_info(chargeback_dispute_oid)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ChargebackDisputeResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling ChargebackApi->delete_chargeback_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to delete. |  |
-### Return type
-[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_chargeback_dispute
-> <ChargebackDisputeResponse> get_chargeback_dispute(chargeback_dispute_oid, opts)
-Retrieve a chargeback
-Retrieves a single chargeback using the specified chargeback dispute oid.
-### Examples
-```ruby
-# Internal API.  No samples are provided as merchants will never need this api method
-```
-#### Using the get_chargeback_dispute_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<ChargebackDisputeResponse>, Integer, Hash)> get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
-```ruby
-begin
-  # Retrieve a chargeback
-  data, status_code, headers = api_instance.get_chargeback_dispute_with_http_info(chargeback_dispute_oid, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ChargebackDisputeResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling ChargebackApi->get_chargeback_dispute_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chargeback_dispute_oid** | **Integer** | The chargeback dispute oid to retrieve. |  |
-| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
-### Return type
-[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## get_chargeback_disputes
-> <ChargebackDisputesResponse> get_chargeback_disputes(opts)
-Retrieve chargebacks
-Retrieves chargebacks from the account.  If no parameters are specified, all chargebacks will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
-### Examples
-```ruby
-# Internal API.  No samples are provided as merchants will never need this api method
-```
-#### Using the get_chargeback_disputes_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<ChargebackDisputesResponse>, Integer, Hash)> get_chargeback_disputes_with_http_info(opts)
-```ruby
-begin
-  # Retrieve chargebacks
-  data, status_code, headers = api_instance.get_chargeback_disputes_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ChargebackDisputesResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling ChargebackApi->get_chargeback_disputes_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **order_id** | **String** | Order Id | [optional] |
-| **case_number** | **String** | Case number | [optional] |
-| **status** | **String** | Status | [optional] |
-| **expiration_dts_start** | **String** | Expiration dts start | [optional] |
-| **expiration_dts_end** | **String** | Expiration dts end | [optional] |
-| **chargeback_dts_start** | **String** | Chargeback dts start | [optional] |
-| **chargeback_dts_end** | **String** | Chargeback dts end | [optional] |
-| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
-| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
-| **_since** | **String** | Fetch chargebacks that have been created/modified since this date/time. | [optional] |
-| **_sort** | **String** | The sort order of the chargebacks.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
-| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
-### Return type
-[**ChargebackDisputesResponse**](ChargebackDisputesResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## insert_chargeback
-> <ChargebackDisputeResponse> insert_chargeback(chargeback, opts)
-Insert a chargeback
-Insert a chargeback on the UltraCart account.
-### Examples
-```ruby
-# Internal API.  No samples are provided as merchants will never need this api method
-```
-#### Using the insert_chargeback_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<ChargebackDisputeResponse>, Integer, Hash)> insert_chargeback_with_http_info(chargeback, opts)
-```ruby
-begin
-  # Insert a chargeback
-  data, status_code, headers = api_instance.insert_chargeback_with_http_info(chargeback, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ChargebackDisputeResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling ChargebackApi->insert_chargeback_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to insert |  |
-| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
-### Return type
-[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
-- **Content-Type**: application/json; charset=UTF-8
-- **Accept**: application/json
-## update_chargeback
-> <ChargebackDisputeResponse> update_chargeback(chargeback_dispute_oid, chargeback, opts)
-Update a chargeback
-Update a chargeback on the UltraCart account.
-### Examples
-```ruby
-# Internal API.  No samples are provided as merchants will never need this api method
-```
-#### Using the update_chargeback_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<ChargebackDisputeResponse>, Integer, Hash)> update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
-```ruby
-begin
-  # Update a chargeback
-  data, status_code, headers = api_instance.update_chargeback_with_http_info(chargeback_dispute_oid, chargeback, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ChargebackDisputeResponse>
-rescue UltracartClient::ApiError => e
-  puts "Error when calling ChargebackApi->update_chargeback_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chargeback_dispute_oid** | **Integer** | The chargeback_dispute_oid to update. |  |
-| **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | Chargeback to update |  |
-| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
-### Return type
-[**ChargebackDisputeResponse**](ChargebackDisputeResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
-- **Content-Type**: application/json; charset=UTF-8
-- **Accept**: application/json

data/docs/ChargebackDispute.md DELETED Viewed

@@ -1,62 +0,0 @@
-# UltracartClient::ChargebackDispute
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_number** | **String** | Account number | [optional] |
-| **adjustment_request_text** | **String** | Adjustment request text | [optional] |
-| **amount** | **Float** | Amount | [optional] |
-| **auth_code** | **String** | Auth code | [optional] |
-| **case_number** | **String** | Case number | [optional] |
-| **chargeback_dispute_oid** | **Integer** | Chargeback Dispute Oid | [optional] |
-| **chargeback_dts** | **String** | Chargeback dts | [optional] |
-| **currency** | **String** | Currency | [optional] |
-| **customer_care_notes** | **String** | Customer care notes | [optional] |
-| **encryption_key** | **String** | Encryption key | [optional] |
-| **expiration_dts** | **String** | Expiration Dts | [optional] |
-| **fax_failure_reason** | **String** | Fax failure reason | [optional] |
-| **fax_number** | **String** | Fax number | [optional] |
-| **fax_transaction_id** | **Integer** | Fax transaction id | [optional] |
-| **icsid** | **String** | icsid | [optional] |
-| **merchant_account_profile_oid** | **Integer** | Merchant account profile oid | [optional] |
-| **order** | [**Order**](Order.md) |  | [optional] |
-| **order_id** | **String** | Order Id | [optional] |
-| **partial_card_number** | **String** | Partial card number | [optional] |
-| **pdf_file_oid** | **String** | PDF file oid | [optional] |
-| **reason_code** | **String** | Reason code | [optional] |
-| **status** | **String** | Status | [optional] |
-| **website_url** | **String** | Website URL | [optional] |
-## Example
-```ruby
-require 'ultracart_api'
-instance = UltracartClient::ChargebackDispute.new(
-  account_number: null,
-  adjustment_request_text: null,
-  amount: null,
-  auth_code: null,
-  case_number: null,
-  chargeback_dispute_oid: null,
-  chargeback_dts: null,
-  currency: null,
-  customer_care_notes: null,
-  encryption_key: null,
-  expiration_dts: null,
-  fax_failure_reason: null,
-  fax_number: null,
-  fax_transaction_id: null,
-  icsid: null,
-  merchant_account_profile_oid: null,
-  order: null,
-  order_id: null,
-  partial_card_number: null,
-  pdf_file_oid: null,
-  reason_code: null,
-  status: null,
-  website_url: null
-)
-```