v2.6.0: Partial Returns, Collections & Improved customer inventory (#19)

## v2.6.0 closes #18 ## Commit Summary * Initial Commit * minor fixes in readme
talon-one · Aug 14, 2022 · e589abe · e589abe
1 parent e6d1c52
commit e589abe
Show file tree

Hide file tree

Showing 621 changed files with 49,505 additions and 14,014 deletions.
diff --git a/README.md b/README.md
diff --git a/api/openapi.yaml b/api/openapi.yaml
diff --git a/api_integration.go b/api_integration.go
diff --git a/api_management.go b/api_management.go
diff --git a/client.go b/client.go
@@ -1,7 +1,7 @@
 /*
  * Talon.One API
  *
- * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
+ * Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}`
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)

diff --git a/configuration.go b/configuration.go
@@ -1,7 +1,7 @@
 /*
  * Talon.One API
  *
- * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
+ * Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}`
  *
  * API version: 1.0.0
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
@@ -97,11 +97,11 @@ type Configuration struct {
 func NewConfiguration() *Configuration {
 	cfg := &Configuration{
 		DefaultHeader: make(map[string]string),
-		UserAgent:     "OpenAPI-Generator/2.5.0/go",
+		UserAgent:     "OpenAPI-Generator/2.6.0/go",
 		Debug:         false,
 		Servers: ServerConfigurations{
 			{
-				URL:         "/",
+				URL:         "https://yourbaseurl.talon.one/",
 				Description: "No description provided",
 			},
 		},

diff --git a/docs/AcceptCouponEffectProps.md b/docs/AcceptCouponEffectProps.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Value** | Pointer to **string** | The coupon code that was accepted | 
+**Value** | Pointer to **string** | The coupon code that was accepted. | 
 
 ## Methods
 

diff --git a/docs/AcceptReferralEffectProps.md b/docs/AcceptReferralEffectProps.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Value** | Pointer to **string** | The referral code that was accepted | 
+**Value** | Pointer to **string** | The referral code that was accepted. | 
 
 ## Methods
 

diff --git a/docs/AccessLogEntry.md b/docs/AccessLogEntry.md
@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Uuid** | Pointer to **string** | UUID reference of request | 
-**Status** | Pointer to **int32** | HTTP status code of response | 
-**Method** | Pointer to **string** | HTTP method of request | 
+**Uuid** | Pointer to **string** | UUID reference of request. | 
+**Status** | Pointer to **int32** | HTTP status code of response. | 
+**Method** | Pointer to **string** | HTTP method of request. | 
 **RequestUri** | Pointer to **string** | target URI of request | 
 **Time** | Pointer to [**time.Time**](time.Time.md) | timestamp of request | 
 **RequestPayload** | Pointer to **string** | payload of request | 

diff --git a/docs/Account.md b/docs/Account.md
@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Id** | Pointer to **int32** | Unique ID for this entity. | 
+**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
 **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | 
 **Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | 
 **CompanyName** | Pointer to **string** |  | 
-**DomainName** | Pointer to **string** | Subdomain Name for yourcompany.talon.one | 
-**State** | Pointer to **string** | State of the account (active, deactivated) | 
+**DomainName** | Pointer to **string** | Subdomain Name for yourcompany.talon.one. | 
+**State** | Pointer to **string** | State of the account (active, deactivated). | 
 **BillingEmail** | Pointer to **string** | The billing email address associated with your company account. | 
 **PlanName** | Pointer to **string** | The name of your booked plan. | [optional] 
 **PlanExpires** | Pointer to [**time.Time**](time.Time.md) | The point in time at which your current plan expires. | [optional] 
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **UserCount** | Pointer to **int32** | The current number of Campaign Manager Users in your account. | 
 **CampaignsActiveCount** | Pointer to **int32** | The current number of active Campaigns in your account. | 
 **CampaignsInactiveCount** | Pointer to **int32** | The current number of inactive Campaigns in your account. | 
-**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] 
+**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] 
 
 ## Methods
 

diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md
@@ -4,13 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Id** | Pointer to **int32** | Unique ID for this entity. | 
+**Id** | Pointer to **int32** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
 **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | 
 **AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | 
 **Name** | Pointer to **string** | The additional cost name that will be used in API requests and Talang. E.g. if &#x60;name &#x3D;&#x3D; \&quot;shipping\&quot;&#x60; then you would set the shipping additional cost by including an &#x60;additionalCosts.shipping&#x60; property in your request payload. | 
 **Title** | Pointer to **string** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like &#x60;name&#x60;, the combination of entity and title must also be unique. | 
 **Description** | Pointer to **string** | A description of this additional cost. | 
-**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this additional cost | [optional] 
+**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional] 
+**Type** | Pointer to **string** | The type of additional cost. The following options can be chosen: - &#x60;session&#x60;: Additional cost will be added per session, - &#x60;item&#x60;: Additional cost will be added per item, - &#x60;both&#x60;: Additional cost will be added per item and session.  | [optional] [default to TYPE_SESSION]
 
 ## Methods
 
@@ -189,6 +190,31 @@ HasSubscribedApplicationsIds returns a boolean if a field has been set.
 
 SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field.
 
+### GetType
+
+`func (o *AccountAdditionalCost) GetType() string`
+
+GetType returns the Type field if non-nil, zero value otherwise.
+
+### GetTypeOk
+
+`func (o *AccountAdditionalCost) GetTypeOk() (string, bool)`
+
+GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### HasType
+
+`func (o *AccountAdditionalCost) HasType() bool`
+
+HasType returns a boolean if a field has been set.
+
+### SetType
+
+`func (o *AccountAdditionalCost) SetType(v string)`
+
+SetType gets a reference to the given string and assigns it to the Type field.
+
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AccountAnalytics.md b/docs/AccountAnalytics.md
@@ -4,24 +4,25 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Applications** | Pointer to **int32** | Total number of applications in the account | 
-**LiveApplications** | Pointer to **int32** | Total number of live applications in the account | 
-**SandboxApplications** | Pointer to **int32** | Total number of sandbox applications in the account | 
-**Campaigns** | Pointer to **int32** | Total number of campaigns in the account | 
-**ActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in the account | 
-**LiveActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in live applications in the account | 
-**Coupons** | Pointer to **int32** | Total number of coupons in the account | 
-**ActiveCoupons** | Pointer to **int32** | Total number of active coupons in the account | 
-**ExpiredCoupons** | Pointer to **int32** | Total number of expired coupons in the account | 
-**ReferralCodes** | Pointer to **int32** | Total number of referral codes in the account | 
-**ActiveReferralCodes** | Pointer to **int32** | Total number of active referral codes in the account | 
-**ExpiredReferralCodes** | Pointer to **int32** | Total number of expired referral codes in the account | 
-**ActiveRules** | Pointer to **int32** | Total number of active rules in the account | 
-**Users** | Pointer to **int32** | Total number of users in the account | 
-**Roles** | Pointer to **int32** | Total number of roles in the account | 
-**CustomAttributes** | Pointer to **int32** | Total number of custom attributes in the account | 
-**Webhooks** | Pointer to **int32** | Total number of webhooks in the account | 
-**LoyaltyPrograms** | Pointer to **int32** | Total number of loyalty programs in the account | 
+**Applications** | Pointer to **int32** | Total number of applications in the account. | 
+**LiveApplications** | Pointer to **int32** | Total number of live applications in the account. | 
+**SandboxApplications** | Pointer to **int32** | Total number of sandbox applications in the account. | 
+**Campaigns** | Pointer to **int32** | Total number of campaigns in the account. | 
+**ActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in the account. | 
+**LiveActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in live applications in the account. | 
+**Coupons** | Pointer to **int32** | Total number of coupons in the account. | 
+**ActiveCoupons** | Pointer to **int32** | Total number of active coupons in the account. | 
+**ExpiredCoupons** | Pointer to **int32** | Total number of expired coupons in the account. | 
+**ReferralCodes** | Pointer to **int32** | Total number of referral codes in the account. | 
+**ActiveReferralCodes** | Pointer to **int32** | Total number of active referral codes in the account. | 
+**ExpiredReferralCodes** | Pointer to **int32** | Total number of expired referral codes in the account. | 
+**ActiveRules** | Pointer to **int32** | Total number of active rules in the account. | 
+**Users** | Pointer to **int32** | Total number of users in the account. | 
+**Roles** | Pointer to **int32** | Total number of roles in the account. | 
+**CustomAttributes** | Pointer to **int32** | Total number of custom attributes in the account. | 
+**Webhooks** | Pointer to **int32** | Total number of webhooks in the account. | 
+**LoyaltyPrograms** | Pointer to **int32** | Total number of all loyalty programs in the account. | 
+**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of live loyalty programs in the account. | 
 
 ## Methods
 
@@ -475,6 +476,31 @@ HasLoyaltyPrograms returns a boolean if a field has been set.
 
 SetLoyaltyPrograms gets a reference to the given int32 and assigns it to the LoyaltyPrograms field.
 
+### GetLiveLoyaltyPrograms
+
+`func (o *AccountAnalytics) GetLiveLoyaltyPrograms() int32`
+
+GetLiveLoyaltyPrograms returns the LiveLoyaltyPrograms field if non-nil, zero value otherwise.
+
+### GetLiveLoyaltyProgramsOk
+
+`func (o *AccountAnalytics) GetLiveLoyaltyProgramsOk() (int32, bool)`
+
+GetLiveLoyaltyProgramsOk returns a tuple with the LiveLoyaltyPrograms field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### HasLiveLoyaltyPrograms
+
+`func (o *AccountAnalytics) HasLiveLoyaltyPrograms() bool`
+
+HasLiveLoyaltyPrograms returns a boolean if a field has been set.
+
+### SetLiveLoyaltyPrograms
+
+`func (o *AccountAnalytics) SetLiveLoyaltyPrograms(v int32)`
+
+SetLiveLoyaltyPrograms gets a reference to the given int32 and assigns it to the LiveLoyaltyPrograms field.
+
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/AccountLimits.md b/docs/AccountLimits.md
@@ -4,18 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**LiveApplications** | Pointer to **int32** | Total number of allowed live applications in the account | 
-**SandboxApplications** | Pointer to **int32** | Total number of allowed sandbox applications in the account | 
-**ActiveCampaigns** | Pointer to **int32** | Total number of allowed active campaigns in live applications in the account | 
-**Coupons** | Pointer to **int32** | Total number of allowed coupons in the account | 
-**ReferralCodes** | Pointer to **int32** | Total number of allowed referral codes in the account | 
-**ActiveRules** | Pointer to **int32** | Total number of allowed active rulesets in the account | 
-**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of allowed live loyalty programs in the account | 
-**SandboxLoyaltyPrograms** | Pointer to **int32** | Total number of allowed sandbox loyalty programs in the account | 
-**Webhooks** | Pointer to **int32** | Total number of allowed webhooks in the account | 
-**Users** | Pointer to **int32** | Total number of allowed users in the account | 
-**ApiVolume** | Pointer to **int32** | Allowed volume of API requests to the account | 
-**PromotionTypes** | Pointer to **[]string** | Array of promotion types that are employed in the account | 
+**LiveApplications** | Pointer to **int32** | Total number of allowed live applications in the account. | 
+**SandboxApplications** | Pointer to **int32** | Total number of allowed sandbox applications in the account. | 
+**ActiveCampaigns** | Pointer to **int32** | Total number of allowed active campaigns in live applications in the account. | 
+**Coupons** | Pointer to **int32** | Total number of allowed coupons in the account. | 
+**ReferralCodes** | Pointer to **int32** | Total number of allowed referral codes in the account. | 
+**ActiveRules** | Pointer to **int32** | Total number of allowed active rulesets in the account. | 
+**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of allowed live loyalty programs in the account. | 
+**SandboxLoyaltyPrograms** | Pointer to **int32** | Total number of allowed sandbox loyalty programs in the account. | 
+**Webhooks** | Pointer to **int32** | Total number of allowed webhooks in the account. | 
+**Users** | Pointer to **int32** | Total number of allowed users in the account. | 
+**ApiVolume** | Pointer to **int32** | Allowed volume of API requests to the account. | 
+**PromotionTypes** | Pointer to **[]string** | Array of promotion types that are employed in the account. | 
 
 ## Methods
 

diff --git a/docs/AddFreeItemEffectProps.md b/docs/AddFreeItemEffectProps.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Sku** | Pointer to **string** | SKU of the item that needs to be added | 
-**Name** | Pointer to **string** | The name/description of the effect | 
+**Sku** | Pointer to **string** | SKU of the item that needs to be added. | 
+**Name** | Pointer to **string** | The name/description of the effect. | 
 
 ## Methods