ultracart_api 4.1.102 → 4.1.103

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e184ae5eeb45aff50611924cb65b7dbd38f294c3e605d4264b063766d30e126
-  data.tar.gz: ba150f5a4d0f43f6eea1a35cdcec19482a47197cb7bff3331d7dffe98f104b6d
+  metadata.gz: 34b115d828400c2a6827ff8224c251b7a98543a0e3d82e8e0286903361a19e5a
+  data.tar.gz: 6b39303a24be29373dbdac1d3e476c1bcf3caec3951860058495e55ac132de0d
 SHA512:
-  metadata.gz: 42348e40659cecc10047f1f828ba071e126346a4c12889694bc873f70d232b01d47a233fdbec636f2ed3892869622930045fc976743a166ca02fc36974e8c128
-  data.tar.gz: e2931485d637b353c6af89f22fd3158bd01b2ce0386867283b8c702c738efa649ad9bec9ce3e804c73f36975a666605c67c3ca658194e6d883ab46882168ab88
+  metadata.gz: 24859f67f94d6fca28fdb38828cfacdb5ed6e36483485a091271cb01dbd764e4e6d94eaf60b69ce09d58f972c02346ea044c485d35f2987f502b8a076cfb5bc2
+  data.tar.gz: 8ddb6a724e0614622b72b4585697531bbc02473756635e3468f90dd39a939bb3771637028510e3807776f834831e6294979300f62b95b64cba041d1d0a7e8039

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.102
+- Package version: 4.1.103
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.102'
+gem 'ultracart_api', '4.1.103'
 ```
 
 install:
@@ -82,8 +82,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*UltracartClient::AffiliateApi* | [**delete_affiliate**](docs/AffiliateApi.md#delete_affiliate) | **DELETE** /affiliate/affiliates/{affiliate_oid} | Delete an affiliate
+*UltracartClient::AffiliateApi* | [**get_affiliate**](docs/AffiliateApi.md#get_affiliate) | **GET** /affiliate/affiliates/{affiliate_oid} | Retrieve an affiliate
+*UltracartClient::AffiliateApi* | [**get_affiliates_by_query**](docs/AffiliateApi.md#get_affiliates_by_query) | **POST** /affiliate/affiliates/query | Retrieve affiliates
 *UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
 *UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
+*UltracartClient::AffiliateApi* | [**insert_affiliate**](docs/AffiliateApi.md#insert_affiliate) | **POST** /affiliate/affiliates | Insert an affiliate
+*UltracartClient::AffiliateApi* | [**update_affiliate**](docs/AffiliateApi.md#update_affiliate) | **PUT** /affiliate/affiliates/{affiliate_oid} | Update an affiliate
 *UltracartClient::AutoOrderApi* | [**cancel_auto_order_item_by_reference_order_id**](docs/AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order
 *UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
 *UltracartClient::AutoOrderApi* | [**establish_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id
@@ -709,6 +714,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AddLibraryItemRequest](docs/AddLibraryItemRequest.md)
  - [UltracartClient::AdjustInternalCertificateRequest](docs/AdjustInternalCertificateRequest.md)
  - [UltracartClient::AdjustInternalCertificateResponse](docs/AdjustInternalCertificateResponse.md)
+ - [UltracartClient::Affiliate](docs/Affiliate.md)
+ - [UltracartClient::AffiliateAttribute](docs/AffiliateAttribute.md)
  - [UltracartClient::AffiliateClick](docs/AffiliateClick.md)
  - [UltracartClient::AffiliateClickQuery](docs/AffiliateClickQuery.md)
  - [UltracartClient::AffiliateClicksResponse](docs/AffiliateClicksResponse.md)
@@ -716,6 +723,11 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AffiliateLedgerQuery](docs/AffiliateLedgerQuery.md)
  - [UltracartClient::AffiliateLedgersResponse](docs/AffiliateLedgersResponse.md)
  - [UltracartClient::AffiliateLink](docs/AffiliateLink.md)
+ - [UltracartClient::AffiliateMarketingStrategy](docs/AffiliateMarketingStrategy.md)
+ - [UltracartClient::AffiliateQuery](docs/AffiliateQuery.md)
+ - [UltracartClient::AffiliateResponse](docs/AffiliateResponse.md)
+ - [UltracartClient::AffiliateTierRelationship](docs/AffiliateTierRelationship.md)
+ - [UltracartClient::AffiliatesResponse](docs/AffiliatesResponse.md)
  - [UltracartClient::AgentSummary](docs/AgentSummary.md)
  - [UltracartClient::ApiUserApplicationProfile](docs/ApiUserApplicationProfile.md)
  - [UltracartClient::ApplyLibraryItemRequest](docs/ApplyLibraryItemRequest.md)
@@ -1780,6 +1792,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.103 | 06/18/2026 | affiliate api alpha |
 | 4.1.102 | 06/17/2026 | storefront communications - new single email enrollment method |
 | 4.1.101 | 06/10/2026 | conversation pbx call notes fields |
 | 4.1.100 | 06/05/2026 | webhook log summary filtering |

data/docs/Affiliate.md

@@ -0,0 +1,122 @@
+# UltracartClient::Affiliate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accepted_downline_recruiting_terms** | **Boolean** | True if affiliate has agreed to the terms associated with recruiting downline affiliates | [optional] |
+| **address_1** | **String** | Address 1 | [optional] |
+| **address_2** | **String** | Address 2 | [optional] |
+| **affiliate_commission_group_oid** | **Integer** | Commission group that this affiliate is assigned to | [optional] |
+| **affiliate_oid** | **Integer** | Unique object identifier for this Affiliate | [optional] |
+| **allow_downline_recruiting** | **Boolean** | True if affiliate is allowed to recruit downline affiliates | [optional] |
+| **allow_google_adwords_tracking** | **Boolean** | True if the affiliate is allowed to have their Google Adwords tracking pixel on the receipt | [optional] |
+| **allow_yahoo_search_marketing_tracking** | **Boolean** | True if the affiliate is allowed to have their Yahoo Search Marketing tracking pixel on the receipt | [optional] |
+| **analytics_internal_tracking** | **Boolean** | True if this is used for internal tracking and should not influence UltraCart Analytics | [optional] |
+| **attributes** | [**Array<AffiliateAttribute>**](AffiliateAttribute.md) | Custom attributes about the affiliate that can be used in the catalog/StoreFront | [optional] |
+| **auto_apply_coupon_code** | **String** | Coupon code to automatically apply when this affiliate sends traffic | [optional] |
+| **auto_apply_coupon_oid** | **Integer** | Coupon object id to automatically apply when this affiliate sends traffic | [optional] |
+| **auto_approve_commissions** | **Boolean** | True if this affiliates commissions are automatically approved | [optional] |
+| **check_payable_to** | **String** | If the affiliate wants to be paid by check instead of PayPal, then this is the name to make the check out to | [optional] |
+| **city** | **String** | City | [optional] |
+| **company_name** | **String** | Company Name | [optional] |
+| **cookie_ttl** | **Integer** | Number of days the affiliate tracking cookie lasts before expiring | [optional] |
+| **country_code** | **String** | ISO-3166 two letter country code | [optional] |
+| **dob** | **String** | Date of birth | [optional] |
+| **email** | **String** | Email | [optional] |
+| **email_notification_schedule** | **String** | Email notification of transactions | [optional] |
+| **fax** | **String** | Fax | [optional] |
+| **first_name** | **String** | First Name | [optional] |
+| **google_conversion_id** | **String** | Google Adwords conversion id to use for the tracking pixel | [optional] |
+| **html_permitted** | **Boolean** | True if the affiliate is allowed to specify custom HTML to render on the receipt | [optional] |
+| **last_name** | **String** | Last Name | [optional] |
+| **last_terms_acceptance** | **String** | Last date/time the affiliate program terms were agreed to | [optional] |
+| **marketing_strategy** | [**AffiliateMarketingStrategy**](AffiliateMarketingStrategy.md) |  | [optional] |
+| **member_type** | **Integer** | Member type object identifier the affiliate is assigned to within the program | [optional] |
+| **merchant_id** | **String** | Merchant ID | [optional] |
+| **minimum_payout** | **Float** | Minimum balance that must accrue before the affiliate is paid | [optional] |
+| **password** | **String** | Password (can only be used to update) | [optional] |
+| **pay_commissions_on_auto_orders** | **Boolean** | True if commissions are paid on auto order (rebill) transactions | [optional] |
+| **pay_commissions_on_repeat_orders_by_email** | **Boolean** | True if commissions are paid on repeat orders matched by customer email | [optional] |
+| **pay_via_paypal** | **Boolean** | True if the affiliate is paid via PayPal | [optional] |
+| **payment_adjustment** | **Float** | Fixed adjustment applied to the affiliate's commission payments | [optional] |
+| **paypal_email** | **String** | Alternate email address to use for their PayPal payment if different than their primary email | [optional] |
+| **phone** | **String** | Phone | [optional] |
+| **postal_code** | **String** | Postal Code | [optional] |
+| **prevent_cookie_stomping** | **Boolean** | True if cookie stomping of this affiliate is prevented | [optional] |
+| **prevent_sending_all_emails** | **Boolean** | If true, affiliate will not receive any email notifications. | [optional] |
+| **refund_server_to_server_postback_url** | **String** | Server to server postback URL notified of affiliate refunds | [optional] |
+| **remove_cookie_after_purchase** | **Boolean** | If true, affiliate cookies are removed after a purchase. | [optional] |
+| **salesforce_account_id** | **String** | Salesforce.com account id | [optional] |
+| **salesforce_contact_id** | **String** | Salesforce.com contact id | [optional] |
+| **server_to_server_postback_url** | **String** | Server to server postback URL notified of affiliate transactions | [optional] |
+| **short_code** | **String** | Short code that can be used in place of the affiliate id within tracking links | [optional] |
+| **state** | **String** | State | [optional] |
+| **status** | **String** | Status | [optional] |
+| **tax_id** | **String** | Tax ID (can only be used to update) | [optional] |
+| **terminated_for_spam** | **Boolean** | True if the affiliate has been terminated for spamming | [optional] |
+| **tier_relationships** | [**Array<AffiliateTierRelationship>**](AffiliateTierRelationship.md) | Relationship with other affiliates that recruted this affiliate | [optional] |
+| **ysm_account_id** | **String** | Yahoo Search Marketing account id to use for the tracking pixel | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::Affiliate.new(
+  accepted_downline_recruiting_terms: null,
+  address_1: null,
+  address_2: null,
+  affiliate_commission_group_oid: null,
+  affiliate_oid: null,
+  allow_downline_recruiting: null,
+  allow_google_adwords_tracking: null,
+  allow_yahoo_search_marketing_tracking: null,
+  analytics_internal_tracking: null,
+  attributes: null,
+  auto_apply_coupon_code: null,
+  auto_apply_coupon_oid: null,
+  auto_approve_commissions: null,
+  check_payable_to: null,
+  city: null,
+  company_name: null,
+  cookie_ttl: null,
+  country_code: null,
+  dob: null,
+  email: null,
+  email_notification_schedule: null,
+  fax: null,
+  first_name: null,
+  google_conversion_id: null,
+  html_permitted: null,
+  last_name: null,
+  last_terms_acceptance: null,
+  marketing_strategy: null,
+  member_type: null,
+  merchant_id: null,
+  minimum_payout: null,
+  password: null,
+  pay_commissions_on_auto_orders: null,
+  pay_commissions_on_repeat_orders_by_email: null,
+  pay_via_paypal: null,
+  payment_adjustment: null,
+  paypal_email: null,
+  phone: null,
+  postal_code: null,
+  prevent_cookie_stomping: null,
+  prevent_sending_all_emails: null,
+  refund_server_to_server_postback_url: null,
+  remove_cookie_after_purchase: null,
+  salesforce_account_id: null,
+  salesforce_contact_id: null,
+  server_to_server_postback_url: null,
+  short_code: null,
+  state: null,
+  status: null,
+  tax_id: null,
+  terminated_for_spam: null,
+  tier_relationships: null,
+  ysm_account_id: null
+)
+```
+

data/docs/AffiliateApi.md

@@ -4,8 +4,176 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**delete_affiliate**](AffiliateApi.md#delete_affiliate) | **DELETE** /affiliate/affiliates/{affiliate_oid} | Delete an affiliate |
+| [**get_affiliate**](AffiliateApi.md#get_affiliate) | **GET** /affiliate/affiliates/{affiliate_oid} | Retrieve an affiliate |
+| [**get_affiliates_by_query**](AffiliateApi.md#get_affiliates_by_query) | **POST** /affiliate/affiliates/query | Retrieve affiliates |
 | [**get_clicks_by_query**](AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks |
 | [**get_ledgers_by_query**](AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries |
+| [**insert_affiliate**](AffiliateApi.md#insert_affiliate) | **POST** /affiliate/affiliates | Insert an affiliate |
+| [**update_affiliate**](AffiliateApi.md#update_affiliate) | **PUT** /affiliate/affiliates/{affiliate_oid} | Update an affiliate |
+
+
+## delete_affiliate
+
+> delete_affiliate(affiliate_oid)
+
+Delete an affiliate
+
+Delete an affiliate on the UltraCart account.  The affiliate is disabled within the active affiliate program; their ledger and click history is preserved. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the delete_affiliate_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_affiliate_with_http_info(affiliate_oid)
+
+```ruby
+begin
+  # Delete an affiliate
+  data, status_code, headers = api_instance.delete_affiliate_with_http_info(affiliate_oid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->delete_affiliate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** | The affiliate oid to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_affiliate
+
+> <AffiliateResponse> get_affiliate(affiliate_oid, opts)
+
+Retrieve an affiliate
+
+Retrieves a single affiliate using the specified affiliate oid. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_affiliate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AffiliateResponse>, Integer, Hash)> get_affiliate_with_http_info(affiliate_oid, opts)
+
+```ruby
+begin
+  # Retrieve an affiliate
+  data, status_code, headers = api_instance.get_affiliate_with_http_info(affiliate_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AffiliateResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->get_affiliate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** | The affiliate oid to retrieve. |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**AffiliateResponse**](AffiliateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_affiliates_by_query
+
+> <AffiliatesResponse> get_affiliates_by_query(affiliate_query, opts)
+
+Retrieve affiliates
+
+Retrieves a group of affiliates from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_affiliates_by_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AffiliatesResponse>, Integer, Hash)> get_affiliates_by_query_with_http_info(affiliate_query, opts)
+
+```ruby
+begin
+  # Retrieve affiliates
+  data, status_code, headers = api_instance.get_affiliates_by_query_with_http_info(affiliate_query, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AffiliatesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->get_affiliates_by_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_query** | [**AffiliateQuery**](AffiliateQuery.md) | Affiliate query |  |
+| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Maximum 200) | [optional][default to 100] |
+| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
+| **_sort** | **String** | The sort order of the affiliates.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
+
+### Return type
+
+[**AffiliatesResponse**](AffiliatesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
 ## get_clicks_by_query
@@ -121,3 +289,112 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## insert_affiliate
+
+> <AffiliateResponse> insert_affiliate(affiliate, opts)
+
+Insert an affiliate
+
+Insert an affiliate on the UltraCart account.  The affiliate is created within the merchant's active affiliate program. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the insert_affiliate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AffiliateResponse>, Integer, Hash)> insert_affiliate_with_http_info(affiliate, opts)
+
+```ruby
+begin
+  # Insert an affiliate
+  data, status_code, headers = api_instance.insert_affiliate_with_http_info(affiliate, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AffiliateResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->insert_affiliate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate** | [**Affiliate**](Affiliate.md) | Affiliate to insert |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**AffiliateResponse**](AffiliateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
+## update_affiliate
+
+> <AffiliateResponse> update_affiliate(affiliate_oid, affiliate, opts)
+
+Update an affiliate
+
+Update an affiliate on the UltraCart account.  This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the update_affiliate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AffiliateResponse>, Integer, Hash)> update_affiliate_with_http_info(affiliate_oid, affiliate, opts)
+
+```ruby
+begin
+  # Update an affiliate
+  data, status_code, headers = api_instance.update_affiliate_with_http_info(affiliate_oid, affiliate, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AffiliateResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AffiliateApi->update_affiliate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** | The affiliate oid to update. |  |
+| **affiliate** | [**Affiliate**](Affiliate.md) | Affiliate to update |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**AffiliateResponse**](AffiliateResponse.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/AffiliateAttribute.md

@@ -0,0 +1,22 @@
+# UltracartClient::AffiliateAttribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the attribute | [optional] |
+| **type** | **String** | Type of the attribute | [optional] |
+| **value** | **String** | Value of the attribute | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AffiliateAttribute.new(
+  name: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/AffiliateMarketingStrategy.md

@@ -0,0 +1,38 @@
+# UltracartClient::AffiliateMarketingStrategy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **marketing_strategy** | **String** | Description of their marketing strategy | [optional] |
+| **using_ad_network** | **Boolean** | True if they are using an ad network | [optional] |
+| **using_adware** | **Boolean** | True if they are using ad software | [optional] |
+| **using_blog** | **Boolean** | True if they are using their blog | [optional] |
+| **using_other** | **String** | True if they are using some ohter marketing technique | [optional] |
+| **using_per_acquisition** | **Boolean** | True if they are using a per acquisition model | [optional] |
+| **using_ppc** | **Boolean** | True if they are using pay per click ads | [optional] |
+| **using_seo** | **Boolean** | True if they are using search engine optimization techniques | [optional] |
+| **using_website** | **Boolean** | True if they are driving traffic from their website | [optional] |
+| **website_name** | **String** | Name of the affiliates website | [optional] |
+| **website_url** | **String** | URL of the affiliates website | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AffiliateMarketingStrategy.new(
+  marketing_strategy: null,
+  using_ad_network: null,
+  using_adware: null,
+  using_blog: null,
+  using_other: null,
+  using_per_acquisition: null,
+  using_ppc: null,
+  using_seo: null,
+  using_website: null,
+  website_name: null,
+  website_url: null
+)
+```
+

data/docs/AffiliateQuery.md

@@ -0,0 +1,38 @@
+# UltracartClient::AffiliateQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** | Affiliate OID | [optional] |
+| **city** | **String** | City | [optional] |
+| **company_name** | **String** | Company name | [optional] |
+| **country_code** | **String** | ISO-3166 two letter country code | [optional] |
+| **email** | **String** | Email | [optional] |
+| **first_name** | **String** | First name | [optional] |
+| **last_name** | **String** | Last name | [optional] |
+| **postal_code** | **String** | Postal code | [optional] |
+| **short_code** | **String** | StoreFront short code | [optional] |
+| **state** | **String** | State for United States otherwise region or province for other countries | [optional] |
+| **status** | **String** | Status | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AffiliateQuery.new(
+  affiliate_oid: null,
+  city: null,
+  company_name: null,
+  country_code: null,
+  email: null,
+  first_name: null,
+  last_name: null,
+  postal_code: null,
+  short_code: null,
+  state: null,
+  status: null
+)
+```
+

data/docs/AffiliateResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::AffiliateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate** | [**Affiliate**](Affiliate.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AffiliateResponse.new(
+  affiliate: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/AffiliateTierRelationship.md

@@ -0,0 +1,20 @@
+# UltracartClient::AffiliateTierRelationship
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliate_oid** | **Integer** | Affiliate object ID that recruited the affiliate | [optional] |
+| **tier_number** | **Integer** | Tier number | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AffiliateTierRelationship.new(
+  affiliate_oid: null,
+  tier_number: null
+)
+```
+

data/docs/AffiliatesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::AffiliatesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affiliates** | [**Array<Affiliate>**](Affiliate.md) | affiliates | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AffiliatesResponse.new(
+  affiliates: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+