Class: TalonOne::ManagementApi
- Inherits:
-
Object
- Object
- TalonOne::ManagementApi
- Defined in:
- lib/talon_one/api/management_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_loyalty_points(program_id, integration_id, body, opts = {}) ⇒ nil
Add points in a certain loyalty program for the specified customer.
-
#add_loyalty_points_with_http_info(program_id, integration_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Add points in a certain loyalty program for the specified customer.
-
#copy_campaign_to_applications(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2002
Copy the campaign into every specified application Copy the campaign into every specified application.
-
#copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>
Copy the campaign into every specified application Copy the campaign into every specified application.
-
#create_additional_cost(body, opts = {}) ⇒ AccountAdditionalCost
Define a new additional cost Defines a new _additional cost_ in this account.
-
#create_additional_cost_with_http_info(body, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>
Define a new additional cost Defines a new _additional cost_ in this account.
-
#create_attribute(body, opts = {}) ⇒ Attribute
Define a new custom attribute Defines a new _custom attribute_ in this account.
-
#create_attribute_with_http_info(body, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>
Define a new custom attribute Defines a new _custom attribute_ in this account.
-
#create_campaign(application_id, body, opts = {}) ⇒ Campaign
Create a Campaign.
-
#create_campaign_with_http_info(application_id, body, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>
Create a Campaign.
-
#create_coupons(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2004
Create Coupons Create coupons according to some pattern.
-
#create_coupons_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Create Coupons Create coupons according to some pattern.
-
#create_password_recovery_email(body, opts = {}) ⇒ NewPasswordEmail
Request a password reset Sends an email with a password recovery link to the email of an existing account.
-
#create_password_recovery_email_with_http_info(body, opts = {}) ⇒ Array<(NewPasswordEmail, Integer, Hash)>
Request a password reset Sends an email with a password recovery link to the email of an existing account.
-
#create_ruleset(application_id, campaign_id, body, opts = {}) ⇒ Ruleset
Create a Ruleset.
-
#create_ruleset_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>
Create a Ruleset.
-
#create_session(body, opts = {}) ⇒ Session
Create a Session.
-
#create_session_with_http_info(body, opts = {}) ⇒ Array<(Session, Integer, Hash)>
Create a Session.
-
#delete_campaign(application_id, campaign_id, opts = {}) ⇒ nil
Delete a Campaign.
-
#delete_campaign_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Campaign.
-
#delete_coupon(application_id, campaign_id, coupon_id, opts = {}) ⇒ nil
Delete one Coupon.
-
#delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete one Coupon.
-
#delete_coupons(application_id, campaign_id, opts = {}) ⇒ nil
Delete Coupons.
-
#delete_coupons_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Coupons.
-
#delete_referral(application_id, campaign_id, referral_id, opts = {}) ⇒ nil
Delete one Referral.
-
#delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete one Referral.
-
#delete_ruleset(application_id, campaign_id, ruleset_id, opts = {}) ⇒ nil
Delete a Ruleset.
-
#delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Ruleset.
-
#get_access_logs(application_id, range_start, range_end, opts = {}) ⇒ InlineResponse2009
Get access logs for application (with total count).
-
#get_access_logs_with_http_info(application_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse2009, Integer, Hash)>
Get access logs for application (with total count).
-
#get_access_logs_without_total_count(application_id, range_start, range_end, opts = {}) ⇒ InlineResponse20010
Get access logs for application.
-
#get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20010, Integer, Hash)>
Get access logs for application.
-
#get_account(account_id, opts = {}) ⇒ Account
Get Account Details Return the details of your companies Talon.One account.
-
#get_account_analytics(account_id, opts = {}) ⇒ AccountAnalytics
Get Account Analytics Return the analytics of your companies Talon.One account.
-
#get_account_analytics_with_http_info(account_id, opts = {}) ⇒ Array<(AccountAnalytics, Integer, Hash)>
Get Account Analytics Return the analytics of your companies Talon.One account.
-
#get_account_with_http_info(account_id, opts = {}) ⇒ Array<(Account, Integer, Hash)>
Get Account Details Return the details of your companies Talon.One account.
-
#get_additional_cost(additional_cost_id, opts = {}) ⇒ AccountAdditionalCost
Get an additional cost Returns additional cost for the account by its id.
-
#get_additional_cost_with_http_info(additional_cost_id, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>
Get an additional cost Returns additional cost for the account by its id.
-
#get_additional_costs(opts = {}) ⇒ InlineResponse20021
List additional costs Returns all the defined additional costs for the account.
-
#get_additional_costs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20021, Integer, Hash)>
List additional costs Returns all the defined additional costs for the account.
-
#get_all_access_logs(range_start, range_end, opts = {}) ⇒ InlineResponse2009
Get all access logs Fetches the access logs for the entire account.
-
#get_all_access_logs_with_http_info(range_start, range_end, opts = {}) ⇒ Array<(InlineResponse2009, Integer, Hash)>
Get all access logs Fetches the access logs for the entire account.
-
#get_all_roles(opts = {}) ⇒ InlineResponse20030
Get all roles.
-
#get_all_roles_with_http_info(opts = {}) ⇒ Array<(InlineResponse20030, Integer, Hash)>
Get all roles.
-
#get_application(application_id, opts = {}) ⇒ Application
Get Application Get the application specified by the ID.
-
#get_application_api_health(application_id, opts = {}) ⇒ ApplicationApiHealth
Get report of health of application API.
-
#get_application_api_health_with_http_info(application_id, opts = {}) ⇒ Array<(ApplicationApiHealth, Integer, Hash)>
Get report of health of application API.
-
#get_application_customer(application_id, customer_id, opts = {}) ⇒ ApplicationCustomer
Get Application Customer.
-
#get_application_customer_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(ApplicationCustomer, Integer, Hash)>
Get Application Customer.
-
#get_application_customers(application_id, opts = {}) ⇒ InlineResponse20012
List Application Customers.
-
#get_application_customers_by_attributes(body, opts = {}) ⇒ InlineResponse20013
Get a list of the customer profiles that match the given attributes (with total count) Gets a list of all the customer profiles for the account that exactly match a set of attributes.
-
#get_application_customers_by_attributes_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>
Get a list of the customer profiles that match the given attributes (with total count) Gets a list of all the customer profiles for the account that exactly match a set of attributes.
-
#get_application_customers_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20012, Integer, Hash)>
List Application Customers.
-
#get_application_event_types(application_id, opts = {}) ⇒ InlineResponse20019
List Applications Event Types Get all of the distinct values of the Event ‘type` property for events recorded in the application.
-
#get_application_event_types_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20019, Integer, Hash)>
List Applications Event Types Get all of the distinct values of the Event `type` property for events recorded in the application.
-
#get_application_events(application_id, opts = {}) ⇒ InlineResponse20017
List Applications Events (with total count) Lists all events recorded for an application.
-
#get_application_events_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20017, Integer, Hash)>
List Applications Events (with total count) Lists all events recorded for an application.
-
#get_application_events_without_total_count(application_id, opts = {}) ⇒ InlineResponse20018
List Applications Events Lists all events recorded for an application.
-
#get_application_events_without_total_count_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20018, Integer, Hash)>
List Applications Events Lists all events recorded for an application.
-
#get_application_session(application_id, session_id, opts = {}) ⇒ ApplicationSession
Get Application Session.
-
#get_application_session_with_http_info(application_id, session_id, opts = {}) ⇒ Array<(ApplicationSession, Integer, Hash)>
Get Application Session.
-
#get_application_sessions(application_id, opts = {}) ⇒ InlineResponse20016
List Application Sessions.
-
#get_application_sessions_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20016, Integer, Hash)>
List Application Sessions.
-
#get_application_with_http_info(application_id, opts = {}) ⇒ Array<(Application, Integer, Hash)>
Get Application Get the application specified by the ID.
-
#get_applications(opts = {}) ⇒ InlineResponse2001
List Applications List all application in the current account.
-
#get_applications_with_http_info(opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>
List Applications List all application in the current account.
-
#get_attribute(attribute_id, opts = {}) ⇒ Attribute
Get a custom attribute Returns custom attribute for the account by its id.
-
#get_attribute_with_http_info(attribute_id, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>
Get a custom attribute Returns custom attribute for the account by its id.
-
#get_attributes(opts = {}) ⇒ InlineResponse20020
List custom attributes Returns all the defined custom attributes for the account.
-
#get_attributes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20020, Integer, Hash)>
List custom attributes Returns all the defined custom attributes for the account.
-
#get_campaign(application_id, campaign_id, opts = {}) ⇒ Campaign
Get a Campaign.
-
#get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {}) ⇒ InlineResponse20011
Get analytics of campaigns.
-
#get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20011, Integer, Hash)>
Get analytics of campaigns.
-
#get_campaign_by_attributes(application_id, body, opts = {}) ⇒ InlineResponse2002
Get a list of all campaigns that match the given attributes Gets a list of all the campaigns that exactly match a set of attributes.
-
#get_campaign_by_attributes_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>
Get a list of all campaigns that match the given attributes Gets a list of all the campaigns that exactly match a set of attributes.
-
#get_campaign_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>
Get a Campaign.
-
#get_campaigns(application_id, opts = {}) ⇒ InlineResponse2002
List your Campaigns.
-
#get_campaigns_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>
List your Campaigns.
-
#get_changes(opts = {}) ⇒ InlineResponse20027
Get audit log for an account Get list of changes caused by API calls for an account.
-
#get_changes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20027, Integer, Hash)>
Get audit log for an account Get list of changes caused by API calls for an account.
-
#get_coupons(application_id, campaign_id, opts = {}) ⇒ InlineResponse2004
List Coupons (with total count).
-
#get_coupons_by_attributes(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes Gets a list of all the coupons that exactly match a set of attributes.
-
#get_coupons_by_attributes_application_wide(application_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria Application wide.
-
#get_coupons_by_attributes_application_wide_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria Application wide.
-
#get_coupons_by_attributes_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes Gets a list of all the coupons that exactly match a set of attributes.
-
#get_coupons_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
List Coupons (with total count).
-
#get_coupons_without_total_count(application_id, campaign_id, opts = {}) ⇒ InlineResponse2005
List Coupons.
-
#get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>
List Coupons.
-
#get_customer_activity_report(range_start, range_end, application_id, customer_id, opts = {}) ⇒ CustomerActivityReport
Get Activity Report for Single Customer Fetch summary report for single application customer based on a time range.
-
#get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts = {}) ⇒ Array<(CustomerActivityReport, Integer, Hash)>
Get Activity Report for Single Customer Fetch summary report for single application customer based on a time range.
-
#get_customer_activity_reports(range_start, range_end, application_id, opts = {}) ⇒ InlineResponse20014
Get Activity Reports for Application Customers (with total count) Fetch summary reports for all application customers based on a time range.
-
#get_customer_activity_reports_with_http_info(range_start, range_end, application_id, opts = {}) ⇒ Array<(InlineResponse20014, Integer, Hash)>
Get Activity Reports for Application Customers (with total count) Fetch summary reports for all application customers based on a time range.
-
#get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {}) ⇒ InlineResponse20015
Get Activity Reports for Application Customers Fetch summary reports for all application customers based on a time range.
-
#get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {}) ⇒ Array<(InlineResponse20015, Integer, Hash)>
Get Activity Reports for Application Customers Fetch summary reports for all application customers based on a time range.
-
#get_customer_analytics(application_id, customer_id, opts = {}) ⇒ CustomerAnalytics
Get Analytics Report for a Customer Fetch analytics for single application customer.
-
#get_customer_analytics_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(CustomerAnalytics, Integer, Hash)>
Get Analytics Report for a Customer Fetch analytics for single application customer.
-
#get_customer_profile(application_id, customer_id, opts = {}) ⇒ ApplicationCustomer
Get Customer Profile.
-
#get_customer_profile_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(ApplicationCustomer, Integer, Hash)>
Get Customer Profile.
-
#get_customer_profiles(opts = {}) ⇒ InlineResponse20013
List Customer Profiles.
-
#get_customer_profiles_with_http_info(opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>
List Customer Profiles.
-
#get_customers_by_attributes(body, opts = {}) ⇒ InlineResponse20013
Get a list of the customer profiles that match the given attributes Gets a list of all the customer profiles for the account that exactly match a set of attributes.
-
#get_customers_by_attributes_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>
Get a list of the customer profiles that match the given attributes Gets a list of all the customer profiles for the account that exactly match a set of attributes.
-
#get_event_types(opts = {}) ⇒ InlineResponse20025
List Event Types Fetch all event type definitions for your account.
-
#get_event_types_with_http_info(opts = {}) ⇒ Array<(InlineResponse20025, Integer, Hash)>
List Event Types Fetch all event type definitions for your account.
-
#get_exports(opts = {}) ⇒ InlineResponse20028
Get Exports Get a list of all past exports.
-
#get_exports_with_http_info(opts = {}) ⇒ Array<(InlineResponse20028, Integer, Hash)>
Get Exports Get a list of all past exports.
-
#get_imports(opts = {}) ⇒ InlineResponse20029
Get Imports Get a list of all past imports.
-
#get_imports_with_http_info(opts = {}) ⇒ Array<(InlineResponse20029, Integer, Hash)>
Get Imports Get a list of all past imports.
-
#get_loyalty_points(program_id, integration_id, opts = {}) ⇒ LoyaltyLedger
get the Loyalty Ledger for this integrationID Get the Loyalty Ledger for this profile integration ID.
-
#get_loyalty_points_with_http_info(program_id, integration_id, opts = {}) ⇒ Array<(LoyaltyLedger, Integer, Hash)>
get the Loyalty Ledger for this integrationID Get the Loyalty Ledger for this profile integration ID.
-
#get_loyalty_program(program_id, opts = {}) ⇒ LoyaltyProgram
Get a loyalty program.
-
#get_loyalty_program_with_http_info(program_id, opts = {}) ⇒ Array<(LoyaltyProgram, Integer, Hash)>
Get a loyalty program.
-
#get_loyalty_programs(opts = {}) ⇒ InlineResponse2008
List all loyalty Programs.
-
#get_loyalty_programs_with_http_info(opts = {}) ⇒ Array<(InlineResponse2008, Integer, Hash)>
List all loyalty Programs.
-
#get_referrals(application_id, campaign_id, opts = {}) ⇒ InlineResponse2006
List Referrals (with total count).
-
#get_referrals_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2006, Integer, Hash)>
List Referrals (with total count).
-
#get_referrals_without_total_count(application_id, campaign_id, opts = {}) ⇒ InlineResponse2007
List Referrals.
-
#get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>
List Referrals.
-
#get_role(role_id, opts = {}) ⇒ Role
Get information for the specified role.
-
#get_role_with_http_info(role_id, opts = {}) ⇒ Array<(Role, Integer, Hash)>
Get information for the specified role.
-
#get_ruleset(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Ruleset
Get a Ruleset.
-
#get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>
Get a Ruleset.
-
#get_rulesets(application_id, campaign_id, opts = {}) ⇒ InlineResponse2003
List Campaign Rulesets.
-
#get_rulesets_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2003, Integer, Hash)>
List Campaign Rulesets.
-
#get_user(user_id, opts = {}) ⇒ User
Get a single User Retrieves the data (including an invitation code) for a user.
-
#get_user_with_http_info(user_id, opts = {}) ⇒ Array<(User, Integer, Hash)>
Get a single User Retrieves the data (including an invitation code) for a user.
-
#get_users(opts = {}) ⇒ InlineResponse20026
List Users in your account Retrieve all users in your account.
-
#get_users_with_http_info(opts = {}) ⇒ Array<(InlineResponse20026, Integer, Hash)>
List Users in your account Retrieve all users in your account.
-
#get_webhook(webhook_id, opts = {}) ⇒ Webhook
Get Webhook Returns an webhook by its id.
-
#get_webhook_activation_logs(opts = {}) ⇒ InlineResponse20023
List Webhook activation Log Entries Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook.
-
#get_webhook_activation_logs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20023, Integer, Hash)>
List Webhook activation Log Entries Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook.
-
#get_webhook_logs(opts = {}) ⇒ InlineResponse20024
List Webhook Log Entries.
-
#get_webhook_logs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20024, Integer, Hash)>
List Webhook Log Entries.
-
#get_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Get Webhook Returns an webhook by its id.
-
#get_webhooks(opts = {}) ⇒ InlineResponse20022
List Webhooks.
-
#get_webhooks_with_http_info(opts = {}) ⇒ Array<(InlineResponse20022, Integer, Hash)>
List Webhooks.
-
#initialize(api_client = ApiClient.default) ⇒ ManagementApi
constructor
A new instance of ManagementApi.
-
#remove_loyalty_points(program_id, integration_id, body, opts = {}) ⇒ nil
Deduct points in a certain loyalty program for the specified customer.
-
#remove_loyalty_points_with_http_info(program_id, integration_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Deduct points in a certain loyalty program for the specified customer.
-
#reset_password(body, opts = {}) ⇒ NewPassword
Reset password Consumes the supplied password reset token and updates the password for the associated account.
-
#reset_password_with_http_info(body, opts = {}) ⇒ Array<(NewPassword, Integer, Hash)>
Reset password Consumes the supplied password reset token and updates the password for the associated account.
-
#search_coupons_advanced(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes (with total count) Gets a list of all the coupons with attributes matching the query criteria.
-
#search_coupons_advanced_application_wide(application_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application.
-
#search_coupons_advanced_application_wide_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application.
-
#search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {}) ⇒ InlineResponse2005
Get a list of the coupons that match the given attributes in all active campaigns of an application Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application.
-
#search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>
Get a list of the coupons that match the given attributes in all active campaigns of an application Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application.
-
#search_coupons_advanced_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes (with total count) Gets a list of all the coupons with attributes matching the query criteria.
-
#search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2005
Get a list of the coupons that match the given attributes Gets a list of all the coupons with attributes matching the query criteria.
-
#search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>
Get a list of the coupons that match the given attributes Gets a list of all the coupons with attributes matching the query criteria.
-
#update_additional_cost(additional_cost_id, body, opts = {}) ⇒ AccountAdditionalCost
Update an additional cost Updates an existing additional cost.
-
#update_additional_cost_with_http_info(additional_cost_id, body, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>
Update an additional cost Updates an existing additional cost.
-
#update_attribute(attribute_id, body, opts = {}) ⇒ Attribute
Update a custom attribute Updates an existing custom attribute.
-
#update_attribute_with_http_info(attribute_id, body, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>
Update a custom attribute Updates an existing custom attribute.
-
#update_campaign(application_id, campaign_id, body, opts = {}) ⇒ Campaign
Update a Campaign.
-
#update_campaign_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>
Update a Campaign.
-
#update_coupon(application_id, campaign_id, coupon_id, body, opts = {}) ⇒ Coupon
Update a Coupon.
-
#update_coupon_batch(application_id, campaign_id, body, opts = {}) ⇒ nil
Update a Batch of Coupons.
-
#update_coupon_batch_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update a Batch of Coupons.
-
#update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts = {}) ⇒ Array<(Coupon, Integer, Hash)>
Update a Coupon.
-
#update_ruleset(application_id, campaign_id, ruleset_id, body, opts = {}) ⇒ Ruleset
Update a Ruleset.
-
#update_ruleset_with_http_info(application_id, campaign_id, ruleset_id, body, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>
Update a Ruleset.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ManagementApi
Returns a new instance of ManagementApi.
19 20 21 |
# File 'lib/talon_one/api/management_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/talon_one/api/management_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_loyalty_points(program_id, integration_id, body, opts = {}) ⇒ nil
Add points in a certain loyalty program for the specified customer
28 29 30 31 |
# File 'lib/talon_one/api/management_api.rb', line 28 def add_loyalty_points(program_id, integration_id, body, opts = {}) add_loyalty_points_with_http_info(program_id, integration_id, body, opts) nil end |
#add_loyalty_points_with_http_info(program_id, integration_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Add points in a certain loyalty program for the specified customer
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/talon_one/api/management_api.rb', line 39 def add_loyalty_points_with_http_info(program_id, integration_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.add_loyalty_points ...' end # verify the required parameter 'program_id' is set if @api_client.config.client_side_validation && program_id.nil? fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.add_loyalty_points" end # verify the required parameter 'integration_id' is set if @api_client.config.client_side_validation && integration_id.nil? fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.add_loyalty_points" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.add_loyalty_points" end # resource path local_var_path = '/v1/loyalty_programs/{programID}/profile/{integrationID}/add_points'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s)).sub('{' + 'integrationID' + '}', CGI.escape(integration_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#add_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#copy_campaign_to_applications(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2002
Copy the campaign into every specified application Copy the campaign into every specified application.
101 102 103 104 |
# File 'lib/talon_one/api/management_api.rb', line 101 def copy_campaign_to_applications(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts) data end |
#copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>
Copy the campaign into every specified application Copy the campaign into every specified application.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/talon_one/api/management_api.rb', line 113 def copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.copy_campaign_to_applications ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.copy_campaign_to_applications" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.copy_campaign_to_applications" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.copy_campaign_to_applications" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/copy'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2002' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#copy_campaign_to_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_additional_cost(body, opts = {}) ⇒ AccountAdditionalCost
Define a new additional cost Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
175 176 177 178 |
# File 'lib/talon_one/api/management_api.rb', line 175 def create_additional_cost(body, opts = {}) data, _status_code, _headers = create_additional_cost_with_http_info(body, opts) data end |
#create_additional_cost_with_http_info(body, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>
Define a new additional cost Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/talon_one/api/management_api.rb', line 185 def create_additional_cost_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_additional_cost ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_additional_cost" end # resource path local_var_path = '/v1/additional_costs' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'AccountAdditionalCost' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_additional_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_attribute(body, opts = {}) ⇒ Attribute
Define a new custom attribute Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a ‘zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
239 240 241 242 |
# File 'lib/talon_one/api/management_api.rb', line 239 def create_attribute(body, opts = {}) data, _status_code, _headers = create_attribute_with_http_info(body, opts) data end |
#create_attribute_with_http_info(body, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>
Define a new custom attribute Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/talon_one/api/management_api.rb', line 249 def create_attribute_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_attribute ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_attribute" end # resource path local_var_path = '/v1/attributes' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Attribute' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_campaign(application_id, body, opts = {}) ⇒ Campaign
Create a Campaign
303 304 305 306 |
# File 'lib/talon_one/api/management_api.rb', line 303 def create_campaign(application_id, body, opts = {}) data, _status_code, _headers = create_campaign_with_http_info(application_id, body, opts) data end |
#create_campaign_with_http_info(application_id, body, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>
Create a Campaign
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
# File 'lib/talon_one/api/management_api.rb', line 313 def create_campaign_with_http_info(application_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_campaign ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_campaign" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_campaign" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Campaign' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_coupons(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2004
Create Coupons Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
374 375 376 377 |
# File 'lib/talon_one/api/management_api.rb', line 374 def create_coupons(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts) data end |
#create_coupons_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Create Coupons Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
# File 'lib/talon_one/api/management_api.rb', line 387 def create_coupons_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2004' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_password_recovery_email(body, opts = {}) ⇒ NewPasswordEmail
Request a password reset Sends an email with a password recovery link to the email of an existing account.
450 451 452 453 |
# File 'lib/talon_one/api/management_api.rb', line 450 def create_password_recovery_email(body, opts = {}) data, _status_code, _headers = create_password_recovery_email_with_http_info(body, opts) data end |
#create_password_recovery_email_with_http_info(body, opts = {}) ⇒ Array<(NewPasswordEmail, Integer, Hash)>
Request a password reset Sends an email with a password recovery link to the email of an existing account.
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/talon_one/api/management_api.rb', line 460 def create_password_recovery_email_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_password_recovery_email ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_password_recovery_email" end # resource path local_var_path = '/v1/password_recovery_emails' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'NewPasswordEmail' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_password_recovery_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_ruleset(application_id, campaign_id, body, opts = {}) ⇒ Ruleset
Create a Ruleset
515 516 517 518 |
# File 'lib/talon_one/api/management_api.rb', line 515 def create_ruleset(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = create_ruleset_with_http_info(application_id, campaign_id, body, opts) data end |
#create_ruleset_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>
Create a Ruleset
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 |
# File 'lib/talon_one/api/management_api.rb', line 526 def create_ruleset_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_ruleset ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_ruleset" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_ruleset" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_ruleset" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Ruleset' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_session(body, opts = {}) ⇒ Session
Create a Session
587 588 589 590 |
# File 'lib/talon_one/api/management_api.rb', line 587 def create_session(body, opts = {}) data, _status_code, _headers = create_session_with_http_info(body, opts) data end |
#create_session_with_http_info(body, opts = {}) ⇒ Array<(Session, Integer, Hash)>
Create a Session
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'lib/talon_one/api/management_api.rb', line 596 def create_session_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.create_session ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_session" end # resource path local_var_path = '/v1/sessions' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Session' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#create_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_campaign(application_id, campaign_id, opts = {}) ⇒ nil
Delete a Campaign
650 651 652 653 |
# File 'lib/talon_one/api/management_api.rb', line 650 def delete_campaign(application_id, campaign_id, opts = {}) delete_campaign_with_http_info(application_id, campaign_id, opts) nil end |
#delete_campaign_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Campaign
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 |
# File 'lib/talon_one/api/management_api.rb', line 660 def delete_campaign_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.delete_campaign ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_campaign" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_campaign" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#delete_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_coupon(application_id, campaign_id, coupon_id, opts = {}) ⇒ nil
Delete one Coupon
715 716 717 718 |
# File 'lib/talon_one/api/management_api.rb', line 715 def delete_coupon(application_id, campaign_id, coupon_id, opts = {}) delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts) nil end |
#delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete one Coupon
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/talon_one/api/management_api.rb', line 726 def delete_coupon_with_http_info(application_id, campaign_id, coupon_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.delete_coupon ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_coupon" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_coupon" end # verify the required parameter 'coupon_id' is set if @api_client.config.client_side_validation && coupon_id.nil? fail ArgumentError, "Missing the required parameter 'coupon_id' when calling ManagementApi.delete_coupon" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'couponId' + '}', CGI.escape(coupon_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#delete_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_coupons(application_id, campaign_id, opts = {}) ⇒ nil
Delete Coupons
797 798 799 800 |
# File 'lib/talon_one/api/management_api.rb', line 797 def delete_coupons(application_id, campaign_id, opts = {}) delete_coupons_with_http_info(application_id, campaign_id, opts) nil end |
#delete_coupons_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Coupons
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 |
# File 'lib/talon_one/api/management_api.rb', line 820 def delete_coupons_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.delete_coupons ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_coupons" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_coupons" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'startsAfter'] = opts[:'starts_after'] if !opts[:'starts_after'].nil? query_params[:'startsBefore'] = opts[:'starts_before'] if !opts[:'starts_before'].nil? query_params[:'expiresAfter'] = opts[:'expires_after'] if !opts[:'expires_after'].nil? query_params[:'expiresBefore'] = opts[:'expires_before'] if !opts[:'expires_before'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#delete_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_referral(application_id, campaign_id, referral_id, opts = {}) ⇒ nil
Delete one Referral
896 897 898 899 |
# File 'lib/talon_one/api/management_api.rb', line 896 def delete_referral(application_id, campaign_id, referral_id, opts = {}) delete_referral_with_http_info(application_id, campaign_id, referral_id, opts) nil end |
#delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete one Referral
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 |
# File 'lib/talon_one/api/management_api.rb', line 907 def delete_referral_with_http_info(application_id, campaign_id, referral_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.delete_referral ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_referral" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_referral" end # verify the required parameter 'referral_id' is set if @api_client.config.client_side_validation && referral_id.nil? fail ArgumentError, "Missing the required parameter 'referral_id' when calling ManagementApi.delete_referral" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'referralId' + '}', CGI.escape(referral_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#delete_referral\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_ruleset(application_id, campaign_id, ruleset_id, opts = {}) ⇒ nil
Delete a Ruleset
966 967 968 969 |
# File 'lib/talon_one/api/management_api.rb', line 966 def delete_ruleset(application_id, campaign_id, ruleset_id, opts = {}) delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts) nil end |
#delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Ruleset
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 |
# File 'lib/talon_one/api/management_api.rb', line 977 def delete_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.delete_ruleset ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.delete_ruleset" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.delete_ruleset" end # verify the required parameter 'ruleset_id' is set if @api_client.config.client_side_validation && ruleset_id.nil? fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling ManagementApi.delete_ruleset" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'rulesetId' + '}', CGI.escape(ruleset_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#delete_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_access_logs(application_id, range_start, range_end, opts = {}) ⇒ InlineResponse2009
Get access logs for application (with total count)
1042 1043 1044 1045 |
# File 'lib/talon_one/api/management_api.rb', line 1042 def get_access_logs(application_id, range_start, range_end, opts = {}) data, _status_code, _headers = get_access_logs_with_http_info(application_id, range_start, range_end, opts) data end |
#get_access_logs_with_http_info(application_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse2009, Integer, Hash)>
Get access logs for application (with total count)
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 |
# File 'lib/talon_one/api/management_api.rb', line 1059 def get_access_logs_with_http_info(application_id, range_start, range_end, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_access_logs" end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_access_logs" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_access_logs" end allowable_values = ["get", "put", "post", "delete", "patch"] if @api_client.config.client_side_validation && opts[:'method'] && !allowable_values.include?(opts[:'method']) fail ArgumentError, "invalid value for \"method\", must be one of #{allowable_values}" end allowable_values = ["success", "error"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/access_logs'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil? query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2009' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_access_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_access_logs_without_total_count(application_id, range_start, range_end, opts = {}) ⇒ InlineResponse20010
Get access logs for application
1142 1143 1144 1145 |
# File 'lib/talon_one/api/management_api.rb', line 1142 def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {}) data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts) data end |
#get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20010, Integer, Hash)>
Get access logs for application
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 |
# File 'lib/talon_one/api/management_api.rb', line 1159 def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_access_logs_without_total_count" end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_access_logs_without_total_count" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_access_logs_without_total_count" end allowable_values = ["get", "put", "post", "delete", "patch"] if @api_client.config.client_side_validation && opts[:'method'] && !allowable_values.include?(opts[:'method']) fail ArgumentError, "invalid value for \"method\", must be one of #{allowable_values}" end allowable_values = ["success", "error"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/access_logs/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil? query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20010' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_access_logs_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_account(account_id, opts = {}) ⇒ Account
Get Account Details Return the details of your companies Talon.One account.
1235 1236 1237 1238 |
# File 'lib/talon_one/api/management_api.rb', line 1235 def get_account(account_id, opts = {}) data, _status_code, _headers = get_account_with_http_info(account_id, opts) data end |
#get_account_analytics(account_id, opts = {}) ⇒ AccountAnalytics
Get Account Analytics Return the analytics of your companies Talon.One account.
1297 1298 1299 1300 |
# File 'lib/talon_one/api/management_api.rb', line 1297 def get_account_analytics(account_id, opts = {}) data, _status_code, _headers = get_account_analytics_with_http_info(account_id, opts) data end |
#get_account_analytics_with_http_info(account_id, opts = {}) ⇒ Array<(AccountAnalytics, Integer, Hash)>
Get Account Analytics Return the analytics of your companies Talon.One account.
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 |
# File 'lib/talon_one/api/management_api.rb', line 1307 def get_account_analytics_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_account_analytics ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ManagementApi.get_account_analytics" end # resource path local_var_path = '/v1/accounts/{accountId}/analytics'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'AccountAnalytics' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_account_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_account_with_http_info(account_id, opts = {}) ⇒ Array<(Account, Integer, Hash)>
Get Account Details Return the details of your companies Talon.One account.
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 |
# File 'lib/talon_one/api/management_api.rb', line 1245 def get_account_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_account ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ManagementApi.get_account" end # resource path local_var_path = '/v1/accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Account' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_additional_cost(additional_cost_id, opts = {}) ⇒ AccountAdditionalCost
Get an additional cost Returns additional cost for the account by its id.
1359 1360 1361 1362 |
# File 'lib/talon_one/api/management_api.rb', line 1359 def get_additional_cost(additional_cost_id, opts = {}) data, _status_code, _headers = get_additional_cost_with_http_info(additional_cost_id, opts) data end |
#get_additional_cost_with_http_info(additional_cost_id, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>
Get an additional cost Returns additional cost for the account by its id.
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 |
# File 'lib/talon_one/api/management_api.rb', line 1369 def get_additional_cost_with_http_info(additional_cost_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_cost ...' end # verify the required parameter 'additional_cost_id' is set if @api_client.config.client_side_validation && additional_cost_id.nil? fail ArgumentError, "Missing the required parameter 'additional_cost_id' when calling ManagementApi.get_additional_cost" end # resource path local_var_path = '/v1/additional_costs/{additionalCostId}'.sub('{' + 'additionalCostId' + '}', CGI.escape(additional_cost_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'AccountAdditionalCost' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_additional_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_additional_costs(opts = {}) ⇒ InlineResponse20021
List additional costs Returns all the defined additional costs for the account.
1423 1424 1425 1426 |
# File 'lib/talon_one/api/management_api.rb', line 1423 def get_additional_costs(opts = {}) data, _status_code, _headers = get_additional_costs_with_http_info(opts) data end |
#get_additional_costs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20021, Integer, Hash)>
List additional costs Returns all the defined additional costs for the account.
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 |
# File 'lib/talon_one/api/management_api.rb', line 1435 def get_additional_costs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...' end # resource path local_var_path = '/v1/additional_costs' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20021' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_additional_costs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_access_logs(range_start, range_end, opts = {}) ⇒ InlineResponse2009
Get all access logs Fetches the access logs for the entire account. Sensitive requests (logins) are always filtered from the logs.
1493 1494 1495 1496 |
# File 'lib/talon_one/api/management_api.rb', line 1493 def get_all_access_logs(range_start, range_end, opts = {}) data, _status_code, _headers = get_all_access_logs_with_http_info(range_start, range_end, opts) data end |
#get_all_access_logs_with_http_info(range_start, range_end, opts = {}) ⇒ Array<(InlineResponse2009, Integer, Hash)>
Get all access logs Fetches the access logs for the entire account. Sensitive requests (logins) are always filtered from the logs.
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 |
# File 'lib/talon_one/api/management_api.rb', line 1510 def get_all_access_logs_with_http_info(range_start, range_end, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_all_access_logs ...' end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_all_access_logs" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_all_access_logs" end allowable_values = ["get", "put", "post", "delete", "patch"] if @api_client.config.client_side_validation && opts[:'method'] && !allowable_values.include?(opts[:'method']) fail ArgumentError, "invalid value for \"method\", must be one of #{allowable_values}" end allowable_values = ["success", "error"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/access_logs' # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil? query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2009' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_all_access_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_roles(opts = {}) ⇒ InlineResponse20030
Get all roles.
1580 1581 1582 1583 |
# File 'lib/talon_one/api/management_api.rb', line 1580 def get_all_roles(opts = {}) data, _status_code, _headers = get_all_roles_with_http_info(opts) data end |
#get_all_roles_with_http_info(opts = {}) ⇒ Array<(InlineResponse20030, Integer, Hash)>
Get all roles.
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 |
# File 'lib/talon_one/api/management_api.rb', line 1588 def get_all_roles_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_all_roles ...' end # resource path local_var_path = '/v1/roles' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20030' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_all_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application(application_id, opts = {}) ⇒ Application
Get Application Get the application specified by the ID.
1636 1637 1638 1639 |
# File 'lib/talon_one/api/management_api.rb', line 1636 def get_application(application_id, opts = {}) data, _status_code, _headers = get_application_with_http_info(application_id, opts) data end |
#get_application_api_health(application_id, opts = {}) ⇒ ApplicationApiHealth
Get report of health of application API
1697 1698 1699 1700 |
# File 'lib/talon_one/api/management_api.rb', line 1697 def get_application_api_health(application_id, opts = {}) data, _status_code, _headers = get_application_api_health_with_http_info(application_id, opts) data end |
#get_application_api_health_with_http_info(application_id, opts = {}) ⇒ Array<(ApplicationApiHealth, Integer, Hash)>
Get report of health of application API
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 |
# File 'lib/talon_one/api/management_api.rb', line 1706 def get_application_api_health_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_api_health ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_api_health" end # resource path local_var_path = '/v1/applications/{applicationId}/health_report'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ApplicationApiHealth' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_api_health\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_customer(application_id, customer_id, opts = {}) ⇒ ApplicationCustomer
Get Application Customer
1758 1759 1760 1761 |
# File 'lib/talon_one/api/management_api.rb', line 1758 def get_application_customer(application_id, customer_id, opts = {}) data, _status_code, _headers = get_application_customer_with_http_info(application_id, customer_id, opts) data end |
#get_application_customer_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(ApplicationCustomer, Integer, Hash)>
Get Application Customer
1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 |
# File 'lib/talon_one/api/management_api.rb', line 1768 def get_application_customer_with_http_info(application_id, customer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_customer" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_application_customer" end # resource path local_var_path = '/v1/applications/{applicationId}/customers/{customerId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ApplicationCustomer' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_customers(application_id, opts = {}) ⇒ InlineResponse20012
List Application Customers
1823 1824 1825 1826 |
# File 'lib/talon_one/api/management_api.rb', line 1823 def get_application_customers(application_id, opts = {}) data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts) data end |
#get_application_customers_by_attributes(body, opts = {}) ⇒ InlineResponse20013
Get a list of the customer profiles that match the given attributes (with total count) Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
1884 1885 1886 1887 |
# File 'lib/talon_one/api/management_api.rb', line 1884 def get_application_customers_by_attributes(body, opts = {}) data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(body, opts) data end |
#get_application_customers_by_attributes_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>
Get a list of the customer profiles that match the given attributes (with total count) Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 |
# File 'lib/talon_one/api/management_api.rb', line 1894 def get_application_customers_by_attributes_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_application_customers_by_attributes" end # resource path local_var_path = '/v1/application_customer_search' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse20013' # auth_names auth_names = opts[:auth_names] || ['integration_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_customers_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_customers_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20012, Integer, Hash)>
List Application Customers
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 |
# File 'lib/talon_one/api/management_api.rb', line 1832 def get_application_customers_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_customers" end # resource path local_var_path = '/v1/applications/{applicationId}/customers'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20012' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_event_types(application_id, opts = {}) ⇒ InlineResponse20019
List Applications Event Types Get all of the distinct values of the Event ‘type` property for events recorded in the application. See also: [Track an event](/integration-api/reference/#trackEvent)
1951 1952 1953 1954 |
# File 'lib/talon_one/api/management_api.rb', line 1951 def get_application_event_types(application_id, opts = {}) data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts) data end |
#get_application_event_types_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20019, Integer, Hash)>
List Applications Event Types Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api/reference/#trackEvent)
1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/talon_one/api/management_api.rb', line 1964 def get_application_event_types_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_event_types" end # resource path local_var_path = '/v1/applications/{applicationId}/event_types'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20019' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_events(application_id, opts = {}) ⇒ InlineResponse20017
List Applications Events (with total count) Lists all events recorded for an application.
2033 2034 2035 2036 |
# File 'lib/talon_one/api/management_api.rb', line 2033 def get_application_events(application_id, opts = {}) data, _status_code, _headers = get_application_events_with_http_info(application_id, opts) data end |
#get_application_events_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20017, Integer, Hash)>
List Applications Events (with total count) Lists all events recorded for an application.
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 |
# File 'lib/talon_one/api/management_api.rb', line 2057 def get_application_events_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_events" end if @api_client.config.client_side_validation && !opts[:'customer_name'].nil? && opts[:'customer_name'].to_s.length < 2 fail ArgumentError, 'invalid value for "opts[:"customer_name"]" when calling ManagementApi.get_application_events, the character length must be great than or equal to 2.' end if @api_client.config.client_side_validation && !opts[:'customer_email'].nil? && opts[:'customer_email'].to_s.length < 2 fail ArgumentError, 'invalid value for "opts[:"customer_email"]" when calling ManagementApi.get_application_events, the character length must be great than or equal to 2.' end # resource path local_var_path = '/v1/applications/{applicationId}/events'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'session'] = opts[:'session'] if !opts[:'session'].nil? query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil? query_params[:'customerName'] = opts[:'customer_name'] if !opts[:'customer_name'].nil? query_params[:'customerEmail'] = opts[:'customer_email'] if !opts[:'customer_email'].nil? query_params[:'couponCode'] = opts[:'coupon_code'] if !opts[:'coupon_code'].nil? query_params[:'referralCode'] = opts[:'referral_code'] if !opts[:'referral_code'].nil? query_params[:'ruleQuery'] = opts[:'rule_query'] if !opts[:'rule_query'].nil? query_params[:'campaignQuery'] = opts[:'campaign_query'] if !opts[:'campaign_query'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20017' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_events_without_total_count(application_id, opts = {}) ⇒ InlineResponse20018
List Applications Events Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
2145 2146 2147 2148 |
# File 'lib/talon_one/api/management_api.rb', line 2145 def get_application_events_without_total_count(application_id, opts = {}) data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts) data end |
#get_application_events_without_total_count_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20018, Integer, Hash)>
List Applications Events Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 |
# File 'lib/talon_one/api/management_api.rb', line 2169 def get_application_events_without_total_count_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_events_without_total_count" end if @api_client.config.client_side_validation && !opts[:'customer_name'].nil? && opts[:'customer_name'].to_s.length < 2 fail ArgumentError, 'invalid value for "opts[:"customer_name"]" when calling ManagementApi.get_application_events_without_total_count, the character length must be great than or equal to 2.' end if @api_client.config.client_side_validation && !opts[:'customer_email'].nil? && opts[:'customer_email'].to_s.length < 2 fail ArgumentError, 'invalid value for "opts[:"customer_email"]" when calling ManagementApi.get_application_events_without_total_count, the character length must be great than or equal to 2.' end # resource path local_var_path = '/v1/applications/{applicationId}/events/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'session'] = opts[:'session'] if !opts[:'session'].nil? query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil? query_params[:'customerName'] = opts[:'customer_name'] if !opts[:'customer_name'].nil? query_params[:'customerEmail'] = opts[:'customer_email'] if !opts[:'customer_email'].nil? query_params[:'couponCode'] = opts[:'coupon_code'] if !opts[:'coupon_code'].nil? query_params[:'referralCode'] = opts[:'referral_code'] if !opts[:'referral_code'].nil? query_params[:'ruleQuery'] = opts[:'rule_query'] if !opts[:'rule_query'].nil? query_params[:'campaignQuery'] = opts[:'campaign_query'] if !opts[:'campaign_query'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20018' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_events_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_session(application_id, session_id, opts = {}) ⇒ ApplicationSession
Get Application Session
2243 2244 2245 2246 |
# File 'lib/talon_one/api/management_api.rb', line 2243 def get_application_session(application_id, session_id, opts = {}) data, _status_code, _headers = get_application_session_with_http_info(application_id, session_id, opts) data end |
#get_application_session_with_http_info(application_id, session_id, opts = {}) ⇒ Array<(ApplicationSession, Integer, Hash)>
Get Application Session
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 |
# File 'lib/talon_one/api/management_api.rb', line 2253 def get_application_session_with_http_info(application_id, session_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_session ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_session" end # verify the required parameter 'session_id' is set if @api_client.config.client_side_validation && session_id.nil? fail ArgumentError, "Missing the required parameter 'session_id' when calling ManagementApi.get_application_session" end # resource path local_var_path = '/v1/applications/{applicationId}/sessions/{sessionId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ApplicationSession' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_sessions(application_id, opts = {}) ⇒ InlineResponse20016
List Application Sessions
2317 2318 2319 2320 |
# File 'lib/talon_one/api/management_api.rb', line 2317 def get_application_sessions(application_id, opts = {}) data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts) data end |
#get_application_sessions_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse20016, Integer, Hash)>
List Application Sessions
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 |
# File 'lib/talon_one/api/management_api.rb', line 2335 def get_application_sessions_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application_sessions" end allowable_values = ["open", "closed", "cancelled"] if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state']) fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/sessions'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil? query_params[:'coupon'] = opts[:'coupon'] if !opts[:'coupon'].nil? query_params[:'referral'] = opts[:'referral'] if !opts[:'referral'].nil? query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil? query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20016' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_with_http_info(application_id, opts = {}) ⇒ Array<(Application, Integer, Hash)>
Get Application Get the application specified by the ID.
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 |
# File 'lib/talon_one/api/management_api.rb', line 1646 def get_application_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_application ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_application" end # resource path local_var_path = '/v1/applications/{applicationId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Application' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_applications(opts = {}) ⇒ InlineResponse2001
List Applications List all application in the current account.
2402 2403 2404 2405 |
# File 'lib/talon_one/api/management_api.rb', line 2402 def get_applications(opts = {}) data, _status_code, _headers = get_applications_with_http_info(opts) data end |
#get_applications_with_http_info(opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>
List Applications List all application in the current account.
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 |
# File 'lib/talon_one/api/management_api.rb', line 2414 def get_applications_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_applications ...' end # resource path local_var_path = '/v1/applications' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2001' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_attribute(attribute_id, opts = {}) ⇒ Attribute
Get a custom attribute Returns custom attribute for the account by its id.
2465 2466 2467 2468 |
# File 'lib/talon_one/api/management_api.rb', line 2465 def get_attribute(attribute_id, opts = {}) data, _status_code, _headers = get_attribute_with_http_info(attribute_id, opts) data end |
#get_attribute_with_http_info(attribute_id, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>
Get a custom attribute Returns custom attribute for the account by its id.
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 |
# File 'lib/talon_one/api/management_api.rb', line 2475 def get_attribute_with_http_info(attribute_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_attribute ...' end # verify the required parameter 'attribute_id' is set if @api_client.config.client_side_validation && attribute_id.nil? fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ManagementApi.get_attribute" end # resource path local_var_path = '/v1/attributes/{attributeId}'.sub('{' + 'attributeId' + '}', CGI.escape(attribute_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Attribute' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_attributes(opts = {}) ⇒ InlineResponse20020
List custom attributes Returns all the defined custom attributes for the account.
2529 2530 2531 2532 |
# File 'lib/talon_one/api/management_api.rb', line 2529 def get_attributes(opts = {}) data, _status_code, _headers = get_attributes_with_http_info(opts) data end |
#get_attributes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20020, Integer, Hash)>
List custom attributes Returns all the defined custom attributes for the account.
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 |
# File 'lib/talon_one/api/management_api.rb', line 2541 def get_attributes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...' end # resource path local_var_path = '/v1/attributes' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20020' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign(application_id, campaign_id, opts = {}) ⇒ Campaign
Get a Campaign
2592 2593 2594 2595 |
# File 'lib/talon_one/api/management_api.rb', line 2592 def get_campaign(application_id, campaign_id, opts = {}) data, _status_code, _headers = get_campaign_with_http_info(application_id, campaign_id, opts) data end |
#get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {}) ⇒ InlineResponse20011
Get analytics of campaigns
2661 2662 2663 2664 |
# File 'lib/talon_one/api/management_api.rb', line 2661 def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {}) data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts) data end |
#get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {}) ⇒ Array<(InlineResponse20011, Integer, Hash)>
Get analytics of campaigns
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 |
# File 'lib/talon_one/api/management_api.rb', line 2674 def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaign_analytics" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_campaign_analytics" end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_campaign_analytics" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_campaign_analytics" end allowable_values = ["1 hour", "1 day", "1 week", "1 month", "1 year"] if @api_client.config.client_side_validation && opts[:'granularity'] && !allowable_values.include?(opts[:'granularity']) fail ArgumentError, "invalid value for \"granularity\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/analytics'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20011' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_campaign_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_by_attributes(application_id, body, opts = {}) ⇒ InlineResponse2002
Get a list of all campaigns that match the given attributes Gets a list of all the campaigns that exactly match a set of attributes.
2750 2751 2752 2753 |
# File 'lib/talon_one/api/management_api.rb', line 2750 def get_campaign_by_attributes(application_id, body, opts = {}) data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts) data end |
#get_campaign_by_attributes_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>
Get a list of all campaigns that match the given attributes Gets a list of all the campaigns that exactly match a set of attributes.
2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 |
# File 'lib/talon_one/api/management_api.rb', line 2765 def get_campaign_by_attributes_with_http_info(application_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_by_attributes ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaign_by_attributes" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_campaign_by_attributes" end allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"] if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state']) fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns_search'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2002' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_campaign_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaign_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>
Get a Campaign
2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 |
# File 'lib/talon_one/api/management_api.rb', line 2602 def get_campaign_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaign" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_campaign" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Campaign' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_campaigns(application_id, opts = {}) ⇒ InlineResponse2002
List your Campaigns
2838 2839 2840 2841 |
# File 'lib/talon_one/api/management_api.rb', line 2838 def get_campaigns(application_id, opts = {}) data, _status_code, _headers = get_campaigns_with_http_info(application_id, opts) data end |
#get_campaigns_with_http_info(application_id, opts = {}) ⇒ Array<(InlineResponse2002, Integer, Hash)>
List your Campaigns
2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 |
# File 'lib/talon_one/api/management_api.rb', line 2855 def get_campaigns_with_http_info(application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_campaigns ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_campaigns" end allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"] if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state']) fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2002' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_changes(opts = {}) ⇒ InlineResponse20027
Get audit log for an account Get list of changes caused by API calls for an account. Only accessible for admins.
2926 2927 2928 2929 |
# File 'lib/talon_one/api/management_api.rb', line 2926 def get_changes(opts = {}) data, _status_code, _headers = get_changes_with_http_info(opts) data end |
#get_changes_with_http_info(opts = {}) ⇒ Array<(InlineResponse20027, Integer, Hash)>
Get audit log for an account Get list of changes caused by API calls for an account. Only accessible for admins.
2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 |
# File 'lib/talon_one/api/management_api.rb', line 2943 def get_changes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...' end # resource path local_var_path = '/v1/changes' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'withTotalResultSize'] = opts[:'with_total_result_size'] if !opts[:'with_total_result_size'].nil? query_params[:'includeOld'] = opts[:'include_old'] if !opts[:'include_old'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20027' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupons(application_id, campaign_id, opts = {}) ⇒ InlineResponse2004
List Coupons (with total count)
3015 3016 3017 3018 |
# File 'lib/talon_one/api/management_api.rb', line 3015 def get_coupons(application_id, campaign_id, opts = {}) data, _status_code, _headers = get_coupons_with_http_info(application_id, campaign_id, opts) data end |
#get_coupons_by_attributes(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes Gets a list of all the coupons that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request.
3135 3136 3137 3138 |
# File 'lib/talon_one/api/management_api.rb', line 3135 def get_coupons_by_attributes(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = get_coupons_by_attributes_with_http_info(application_id, campaign_id, body, opts) data end |
#get_coupons_by_attributes_application_wide(application_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria Application wide
3255 3256 3257 3258 |
# File 'lib/talon_one/api/management_api.rb', line 3255 def get_coupons_by_attributes_application_wide(application_id, body, opts = {}) data, _status_code, _headers = get_coupons_by_attributes_application_wide_with_http_info(application_id, body, opts) data end |
#get_coupons_by_attributes_application_wide_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria Application wide
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 |
# File 'lib/talon_one/api/management_api.rb', line 3279 def get_coupons_by_attributes_application_wide_with_http_info(application_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_by_attributes_application_wide ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_coupons_by_attributes_application_wide" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_coupons_by_attributes_application_wide" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"] if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state']) fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/coupons_search'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2004' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_coupons_by_attributes_application_wide\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupons_by_attributes_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes Gets a list of all the coupons that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request.
3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 |
# File 'lib/talon_one/api/management_api.rb', line 3159 def get_coupons_by_attributes_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_by_attributes ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_coupons_by_attributes" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_coupons_by_attributes" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_coupons_by_attributes" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2004' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_coupons_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupons_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
List Coupons (with total count)
3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 |
# File 'lib/talon_one/api/management_api.rb', line 3041 def get_coupons_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_coupons" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_coupons" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'startsAfter'] = opts[:'starts_after'] if !opts[:'starts_after'].nil? query_params[:'startsBefore'] = opts[:'starts_before'] if !opts[:'starts_before'].nil? query_params[:'expiresAfter'] = opts[:'expires_after'] if !opts[:'expires_after'].nil? query_params[:'expiresBefore'] = opts[:'expires_before'] if !opts[:'expires_before'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2004' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupons_without_total_count(application_id, campaign_id, opts = {}) ⇒ InlineResponse2005
List Coupons
3374 3375 3376 3377 |
# File 'lib/talon_one/api/management_api.rb', line 3374 def get_coupons_without_total_count(application_id, campaign_id, opts = {}) data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts) data end |
#get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>
List Coupons
3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 |
# File 'lib/talon_one/api/management_api.rb', line 3396 def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_without_total_count ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_coupons_without_total_count" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_coupons_without_total_count" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2005' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_coupons_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customer_activity_report(range_start, range_end, application_id, customer_id, opts = {}) ⇒ CustomerActivityReport
Get Activity Report for Single Customer Fetch summary report for single application customer based on a time range
3477 3478 3479 3480 |
# File 'lib/talon_one/api/management_api.rb', line 3477 def get_customer_activity_report(range_start, range_end, application_id, customer_id, opts = {}) data, _status_code, _headers = get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts) data end |
#get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts = {}) ⇒ Array<(CustomerActivityReport, Integer, Hash)>
Get Activity Report for Single Customer Fetch summary report for single application customer based on a time range
3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 |
# File 'lib/talon_one/api/management_api.rb', line 3492 def get_customer_activity_report_with_http_info(range_start, range_end, application_id, customer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_report ...' end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_customer_activity_report" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_customer_activity_report" end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_activity_report" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_customer_activity_report" end # resource path local_var_path = '/v1/applications/{applicationId}/customer_activity_reports/{customerId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CustomerActivityReport' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customer_activity_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customer_activity_reports(range_start, range_end, application_id, opts = {}) ⇒ InlineResponse20014
Get Activity Reports for Application Customers (with total count) Fetch summary reports for all application customers based on a time range
3569 3570 3571 3572 |
# File 'lib/talon_one/api/management_api.rb', line 3569 def get_customer_activity_reports(range_start, range_end, application_id, opts = {}) data, _status_code, _headers = get_customer_activity_reports_with_http_info(range_start, range_end, application_id, opts) data end |
#get_customer_activity_reports_with_http_info(range_start, range_end, application_id, opts = {}) ⇒ Array<(InlineResponse20014, Integer, Hash)>
Get Activity Reports for Application Customers (with total count) Fetch summary reports for all application customers based on a time range
3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 |
# File 'lib/talon_one/api/management_api.rb', line 3588 def get_customer_activity_reports_with_http_info(range_start, range_end, application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports ...' end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_customer_activity_reports" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_customer_activity_reports" end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_activity_reports" end # resource path local_var_path = '/v1/applications/{applicationId}/customer_activity_reports'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil? query_params[:'campaignName'] = opts[:'campaign_name'] if !opts[:'campaign_name'].nil? query_params[:'advocateName'] = opts[:'advocate_name'] if !opts[:'advocate_name'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20014' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customer_activity_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {}) ⇒ InlineResponse20015
Get Activity Reports for Application Customers Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only if there are more results.
3666 3667 3668 3669 |
# File 'lib/talon_one/api/management_api.rb', line 3666 def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {}) data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts) data end |
#get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {}) ⇒ Array<(InlineResponse20015, Integer, Hash)>
Get Activity Reports for Application Customers Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only if there are more results.
3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 |
# File 'lib/talon_one/api/management_api.rb', line 3685 def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...' end # verify the required parameter 'range_start' is set if @api_client.config.client_side_validation && range_start.nil? fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_customer_activity_reports_without_total_count" end # verify the required parameter 'range_end' is set if @api_client.config.client_side_validation && range_end.nil? fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_customer_activity_reports_without_total_count" end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_activity_reports_without_total_count" end # resource path local_var_path = '/v1/applications/{applicationId}/customer_activity_reports/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'rangeStart'] = range_start query_params[:'rangeEnd'] = range_end query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'integrationId'] = opts[:'integration_id'] if !opts[:'integration_id'].nil? query_params[:'campaignName'] = opts[:'campaign_name'] if !opts[:'campaign_name'].nil? query_params[:'advocateName'] = opts[:'advocate_name'] if !opts[:'advocate_name'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20015' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customer_activity_reports_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customer_analytics(application_id, customer_id, opts = {}) ⇒ CustomerAnalytics
Get Analytics Report for a Customer Fetch analytics for single application customer
3758 3759 3760 3761 |
# File 'lib/talon_one/api/management_api.rb', line 3758 def get_customer_analytics(application_id, customer_id, opts = {}) data, _status_code, _headers = get_customer_analytics_with_http_info(application_id, customer_id, opts) data end |
#get_customer_analytics_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(CustomerAnalytics, Integer, Hash)>
Get Analytics Report for a Customer Fetch analytics for single application customer
3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 |
# File 'lib/talon_one/api/management_api.rb', line 3772 def get_customer_analytics_with_http_info(application_id, customer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_analytics ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_analytics" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_customer_analytics" end # resource path local_var_path = '/v1/applications/{applicationId}/customers/{customerId}/analytics'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CustomerAnalytics' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customer_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customer_profile(application_id, customer_id, opts = {}) ⇒ ApplicationCustomer
Get Customer Profile
3831 3832 3833 3834 |
# File 'lib/talon_one/api/management_api.rb', line 3831 def get_customer_profile(application_id, customer_id, opts = {}) data, _status_code, _headers = get_customer_profile_with_http_info(application_id, customer_id, opts) data end |
#get_customer_profile_with_http_info(application_id, customer_id, opts = {}) ⇒ Array<(ApplicationCustomer, Integer, Hash)>
Get Customer Profile
3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 |
# File 'lib/talon_one/api/management_api.rb', line 3841 def get_customer_profile_with_http_info(application_id, customer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_customer_profile" end # verify the required parameter 'customer_id' is set if @api_client.config.client_side_validation && customer_id.nil? fail ArgumentError, "Missing the required parameter 'customer_id' when calling ManagementApi.get_customer_profile" end # resource path local_var_path = '/v1/customers/{customerId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ApplicationCustomer' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customer_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customer_profiles(opts = {}) ⇒ InlineResponse20013
List Customer Profiles
3897 3898 3899 3900 |
# File 'lib/talon_one/api/management_api.rb', line 3897 def get_customer_profiles(opts = {}) data, _status_code, _headers = get_customer_profiles_with_http_info(opts) data end |
#get_customer_profiles_with_http_info(opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>
List Customer Profiles
3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 |
# File 'lib/talon_one/api/management_api.rb', line 3907 def get_customer_profiles_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...' end # resource path local_var_path = '/v1/customers/no_total' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20013' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customer_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_customers_by_attributes(body, opts = {}) ⇒ InlineResponse20013
Get a list of the customer profiles that match the given attributes Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
3959 3960 3961 3962 |
# File 'lib/talon_one/api/management_api.rb', line 3959 def get_customers_by_attributes(body, opts = {}) data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts) data end |
#get_customers_by_attributes_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20013, Integer, Hash)>
Get a list of the customer profiles that match the given attributes Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 |
# File 'lib/talon_one/api/management_api.rb', line 3971 def get_customers_by_attributes_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.get_customers_by_attributes" end # resource path local_var_path = '/v1/customer_search/no_total' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse20013' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_customers_by_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_event_types(opts = {}) ⇒ InlineResponse20025
List Event Types Fetch all event type definitions for your account. Each event type can be
4032 4033 4034 4035 |
# File 'lib/talon_one/api/management_api.rb', line 4032 def get_event_types(opts = {}) data, _status_code, _headers = get_event_types_with_http_info(opts) data end |
#get_event_types_with_http_info(opts = {}) ⇒ Array<(InlineResponse20025, Integer, Hash)>
List Event Types Fetch all event type definitions for your account. Each event type can be
4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 |
# File 'lib/talon_one/api/management_api.rb', line 4047 def get_event_types_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...' end # resource path local_var_path = '/v1/event_types' # query parameters query_params = opts[:query_params] || {} query_params[:'applicationIds'] = opts[:'application_ids'] if !opts[:'application_ids'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'includeOldVersions'] = opts[:'include_old_versions'] if !opts[:'include_old_versions'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20025' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_exports(opts = {}) ⇒ InlineResponse20028
Get Exports Get a list of all past exports
4105 4106 4107 4108 |
# File 'lib/talon_one/api/management_api.rb', line 4105 def get_exports(opts = {}) data, _status_code, _headers = get_exports_with_http_info(opts) data end |
#get_exports_with_http_info(opts = {}) ⇒ Array<(InlineResponse20028, Integer, Hash)>
Get Exports Get a list of all past exports
4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 |
# File 'lib/talon_one/api/management_api.rb', line 4119 def get_exports_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...' end allowable_values = ["Coupon", "Effect", "CustomerSession"] if @api_client.config.client_side_validation && opts[:'entity'] && !allowable_values.include?(opts[:'entity']) fail ArgumentError, "invalid value for \"entity\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/exports' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil? query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil? query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20028' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_imports(opts = {}) ⇒ InlineResponse20029
Get Imports Get a list of all past imports
4177 4178 4179 4180 |
# File 'lib/talon_one/api/management_api.rb', line 4177 def get_imports(opts = {}) data, _status_code, _headers = get_imports_with_http_info(opts) data end |
#get_imports_with_http_info(opts = {}) ⇒ Array<(InlineResponse20029, Integer, Hash)>
Get Imports Get a list of all past imports
4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 |
# File 'lib/talon_one/api/management_api.rb', line 4188 def get_imports_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_imports ...' end # resource path local_var_path = '/v1/imports' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20029' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_imports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_loyalty_points(program_id, integration_id, opts = {}) ⇒ LoyaltyLedger
get the Loyalty Ledger for this integrationID Get the Loyalty Ledger for this profile integration ID.
4239 4240 4241 4242 |
# File 'lib/talon_one/api/management_api.rb', line 4239 def get_loyalty_points(program_id, integration_id, opts = {}) data, _status_code, _headers = get_loyalty_points_with_http_info(program_id, integration_id, opts) data end |
#get_loyalty_points_with_http_info(program_id, integration_id, opts = {}) ⇒ Array<(LoyaltyLedger, Integer, Hash)>
get the Loyalty Ledger for this integrationID Get the Loyalty Ledger for this profile integration ID.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 |
# File 'lib/talon_one/api/management_api.rb', line 4250 def get_loyalty_points_with_http_info(program_id, integration_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_points ...' end # verify the required parameter 'program_id' is set if @api_client.config.client_side_validation && program_id.nil? fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.get_loyalty_points" end # verify the required parameter 'integration_id' is set if @api_client.config.client_side_validation && integration_id.nil? fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.get_loyalty_points" end # resource path local_var_path = '/v1/loyalty_programs/{programID}/profile/{integrationID}'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s)).sub('{' + 'integrationID' + '}', CGI.escape(integration_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'LoyaltyLedger' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_loyalty_program(program_id, opts = {}) ⇒ LoyaltyProgram
Get a loyalty program
4305 4306 4307 4308 |
# File 'lib/talon_one/api/management_api.rb', line 4305 def get_loyalty_program(program_id, opts = {}) data, _status_code, _headers = get_loyalty_program_with_http_info(program_id, opts) data end |
#get_loyalty_program_with_http_info(program_id, opts = {}) ⇒ Array<(LoyaltyProgram, Integer, Hash)>
Get a loyalty program
4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 |
# File 'lib/talon_one/api/management_api.rb', line 4314 def get_loyalty_program_with_http_info(program_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program ...' end # verify the required parameter 'program_id' is set if @api_client.config.client_side_validation && program_id.nil? fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.get_loyalty_program" end # resource path local_var_path = '/v1/loyalty_programs/{programID}'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'LoyaltyProgram' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_program\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_loyalty_programs(opts = {}) ⇒ InlineResponse2008
List all loyalty Programs
4364 4365 4366 4367 |
# File 'lib/talon_one/api/management_api.rb', line 4364 def get_loyalty_programs(opts = {}) data, _status_code, _headers = get_loyalty_programs_with_http_info(opts) data end |
#get_loyalty_programs_with_http_info(opts = {}) ⇒ Array<(InlineResponse2008, Integer, Hash)>
List all loyalty Programs
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 |
# File 'lib/talon_one/api/management_api.rb', line 4372 def get_loyalty_programs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...' end # resource path local_var_path = '/v1/loyalty_programs' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2008' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_loyalty_programs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_referrals(application_id, campaign_id, opts = {}) ⇒ InlineResponse2006
List Referrals (with total count)
4429 4430 4431 4432 |
# File 'lib/talon_one/api/management_api.rb', line 4429 def get_referrals(application_id, campaign_id, opts = {}) data, _status_code, _headers = get_referrals_with_http_info(application_id, campaign_id, opts) data end |
#get_referrals_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2006, Integer, Hash)>
List Referrals (with total count)
4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 |
# File 'lib/talon_one/api/management_api.rb', line 4448 def get_referrals_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_referrals" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_referrals" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'advocate'] = opts[:'advocate'] if !opts[:'advocate'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2006' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_referrals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_referrals_without_total_count(application_id, campaign_id, opts = {}) ⇒ InlineResponse2007
List Referrals
4530 4531 4532 4533 |
# File 'lib/talon_one/api/management_api.rb', line 4530 def get_referrals_without_total_count(application_id, campaign_id, opts = {}) data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts) data end |
#get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2007, Integer, Hash)>
List Referrals
4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 |
# File 'lib/talon_one/api/management_api.rb', line 4549 def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_referrals_without_total_count" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_referrals_without_total_count" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'advocate'] = opts[:'advocate'] if !opts[:'advocate'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2007' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_referrals_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_role(role_id, opts = {}) ⇒ Role
Get information for the specified role.
4621 4622 4623 4624 |
# File 'lib/talon_one/api/management_api.rb', line 4621 def get_role(role_id, opts = {}) data, _status_code, _headers = get_role_with_http_info(role_id, opts) data end |
#get_role_with_http_info(role_id, opts = {}) ⇒ Array<(Role, Integer, Hash)>
Get information for the specified role.
4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 |
# File 'lib/talon_one/api/management_api.rb', line 4630 def get_role_with_http_info(role_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_role ...' end # verify the required parameter 'role_id' is set if @api_client.config.client_side_validation && role_id.nil? fail ArgumentError, "Missing the required parameter 'role_id' when calling ManagementApi.get_role" end # resource path local_var_path = '/v1/roles/{roleId}'.sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Role' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_ruleset(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Ruleset
Get a Ruleset
4683 4684 4685 4686 |
# File 'lib/talon_one/api/management_api.rb', line 4683 def get_ruleset(application_id, campaign_id, ruleset_id, opts = {}) data, _status_code, _headers = get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts) data end |
#get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>
Get a Ruleset
4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 |
# File 'lib/talon_one/api/management_api.rb', line 4694 def get_ruleset_with_http_info(application_id, campaign_id, ruleset_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_ruleset ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_ruleset" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_ruleset" end # verify the required parameter 'ruleset_id' is set if @api_client.config.client_side_validation && ruleset_id.nil? fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling ManagementApi.get_ruleset" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'rulesetId' + '}', CGI.escape(ruleset_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Ruleset' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_rulesets(application_id, campaign_id, opts = {}) ⇒ InlineResponse2003
List Campaign Rulesets
4757 4758 4759 4760 |
# File 'lib/talon_one/api/management_api.rb', line 4757 def get_rulesets(application_id, campaign_id, opts = {}) data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts) data end |
#get_rulesets_with_http_info(application_id, campaign_id, opts = {}) ⇒ Array<(InlineResponse2003, Integer, Hash)>
List Campaign Rulesets
4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 |
# File 'lib/talon_one/api/management_api.rb', line 4770 def get_rulesets_with_http_info(application_id, campaign_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_rulesets ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.get_rulesets" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.get_rulesets" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse2003' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_user(user_id, opts = {}) ⇒ User
Get a single User Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves.
4829 4830 4831 4832 |
# File 'lib/talon_one/api/management_api.rb', line 4829 def get_user(user_id, opts = {}) data, _status_code, _headers = get_user_with_http_info(user_id, opts) data end |
#get_user_with_http_info(user_id, opts = {}) ⇒ Array<(User, Integer, Hash)>
Get a single User Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves.
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 |
# File 'lib/talon_one/api/management_api.rb', line 4839 def get_user_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_user ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.get_user" end # resource path local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'User' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_users(opts = {}) ⇒ InlineResponse20026
List Users in your account Retrieve all users in your account.
4893 4894 4895 4896 |
# File 'lib/talon_one/api/management_api.rb', line 4893 def get_users(opts = {}) data, _status_code, _headers = get_users_with_http_info(opts) data end |
#get_users_with_http_info(opts = {}) ⇒ Array<(InlineResponse20026, Integer, Hash)>
List Users in your account Retrieve all users in your account.
4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 |
# File 'lib/talon_one/api/management_api.rb', line 4905 def get_users_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...' end # resource path local_var_path = '/v1/users' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20026' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_webhook(webhook_id, opts = {}) ⇒ Webhook
Get Webhook Returns an webhook by its id.
4956 4957 4958 4959 |
# File 'lib/talon_one/api/management_api.rb', line 4956 def get_webhook(webhook_id, opts = {}) data, _status_code, _headers = get_webhook_with_http_info(webhook_id, opts) data end |
#get_webhook_activation_logs(opts = {}) ⇒ InlineResponse20023
List Webhook activation Log Entries Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
5026 5027 5028 5029 |
# File 'lib/talon_one/api/management_api.rb', line 5026 def get_webhook_activation_logs(opts = {}) data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts) data end |
#get_webhook_activation_logs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20023, Integer, Hash)>
List Webhook activation Log Entries Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 |
# File 'lib/talon_one/api/management_api.rb', line 5044 def get_webhook_activation_logs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...' end # resource path local_var_path = '/v1/webhook_activation_logs' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'integrationRequestUuid'] = opts[:'integration_request_uuid'] if !opts[:'integration_request_uuid'].nil? query_params[:'webhookId'] = opts[:'webhook_id'] if !opts[:'webhook_id'].nil? query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil? query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20023' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_webhook_activation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_webhook_logs(opts = {}) ⇒ InlineResponse20024
List Webhook Log Entries
5109 5110 5111 5112 |
# File 'lib/talon_one/api/management_api.rb', line 5109 def get_webhook_logs(opts = {}) data, _status_code, _headers = get_webhook_logs_with_http_info(opts) data end |
#get_webhook_logs_with_http_info(opts = {}) ⇒ Array<(InlineResponse20024, Integer, Hash)>
List Webhook Log Entries
5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 |
# File 'lib/talon_one/api/management_api.rb', line 5127 def get_webhook_logs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...' end allowable_values = ["success", "error"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/webhook_logs' # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'webhookId'] = opts[:'webhook_id'] if !opts[:'webhook_id'].nil? query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil? query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil? query_params[:'requestUuid'] = opts[:'request_uuid'] if !opts[:'request_uuid'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20024' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_webhook_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Get Webhook Returns an webhook by its id.
4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 |
# File 'lib/talon_one/api/management_api.rb', line 4966 def get_webhook_with_http_info(webhook_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook ...' end # verify the required parameter 'webhook_id' is set if @api_client.config.client_side_validation && webhook_id.nil? fail ArgumentError, "Missing the required parameter 'webhook_id' when calling ManagementApi.get_webhook" end # resource path local_var_path = '/v1/webhooks/{webhookId}'.sub('{' + 'webhookId' + '}', CGI.escape(webhook_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Webhook' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_webhooks(opts = {}) ⇒ InlineResponse20022
List Webhooks
5191 5192 5193 5194 |
# File 'lib/talon_one/api/management_api.rb', line 5191 def get_webhooks(opts = {}) data, _status_code, _headers = get_webhooks_with_http_info(opts) data end |
#get_webhooks_with_http_info(opts = {}) ⇒ Array<(InlineResponse20022, Integer, Hash)>
List Webhooks
5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 |
# File 'lib/talon_one/api/management_api.rb', line 5203 def get_webhooks_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...' end # resource path local_var_path = '/v1/webhooks' # query parameters query_params = opts[:query_params] || {} query_params[:'applicationIds'] = opts[:'application_ids'] if !opts[:'application_ids'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InlineResponse20022' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove_loyalty_points(program_id, integration_id, body, opts = {}) ⇒ nil
Deduct points in a certain loyalty program for the specified customer
5256 5257 5258 5259 |
# File 'lib/talon_one/api/management_api.rb', line 5256 def remove_loyalty_points(program_id, integration_id, body, opts = {}) remove_loyalty_points_with_http_info(program_id, integration_id, body, opts) nil end |
#remove_loyalty_points_with_http_info(program_id, integration_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Deduct points in a certain loyalty program for the specified customer
5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 |
# File 'lib/talon_one/api/management_api.rb', line 5267 def remove_loyalty_points_with_http_info(program_id, integration_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.remove_loyalty_points ...' end # verify the required parameter 'program_id' is set if @api_client.config.client_side_validation && program_id.nil? fail ArgumentError, "Missing the required parameter 'program_id' when calling ManagementApi.remove_loyalty_points" end # verify the required parameter 'integration_id' is set if @api_client.config.client_side_validation && integration_id.nil? fail ArgumentError, "Missing the required parameter 'integration_id' when calling ManagementApi.remove_loyalty_points" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.remove_loyalty_points" end # resource path local_var_path = '/v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points'.sub('{' + 'programID' + '}', CGI.escape(program_id.to_s)).sub('{' + 'integrationID' + '}', CGI.escape(integration_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#remove_loyalty_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#reset_password(body, opts = {}) ⇒ NewPassword
Reset password Consumes the supplied password reset token and updates the password for the associated account.
5327 5328 5329 5330 |
# File 'lib/talon_one/api/management_api.rb', line 5327 def reset_password(body, opts = {}) data, _status_code, _headers = reset_password_with_http_info(body, opts) data end |
#reset_password_with_http_info(body, opts = {}) ⇒ Array<(NewPassword, Integer, Hash)>
Reset password Consumes the supplied password reset token and updates the password for the associated account.
5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 |
# File 'lib/talon_one/api/management_api.rb', line 5337 def reset_password_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.reset_password ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.reset_password" end # resource path local_var_path = '/v1/reset_password' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'NewPassword' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#reset_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_coupons_advanced(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes (with total count) Gets a list of all the coupons with attributes matching the query criteria
5405 5406 5407 5408 |
# File 'lib/talon_one/api/management_api.rb', line 5405 def search_coupons_advanced(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = search_coupons_advanced_with_http_info(application_id, campaign_id, body, opts) data end |
#search_coupons_advanced_application_wide(application_id, body, opts = {}) ⇒ InlineResponse2004
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
5525 5526 5527 5528 |
# File 'lib/talon_one/api/management_api.rb', line 5525 def search_coupons_advanced_application_wide(application_id, body, opts = {}) data, _status_code, _headers = search_coupons_advanced_application_wide_with_http_info(application_id, body, opts) data end |
#search_coupons_advanced_application_wide_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count) Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 |
# File 'lib/talon_one/api/management_api.rb', line 5549 def search_coupons_advanced_application_wide_with_http_info(application_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_application_wide" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced_application_wide" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"] if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state']) fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/coupons_search_advanced'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2004' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced_application_wide\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {}) ⇒ InlineResponse2005
Get a list of the coupons that match the given attributes in all active campaigns of an application Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
5646 5647 5648 5649 |
# File 'lib/talon_one/api/management_api.rb', line 5646 def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {}) data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts) data end |
#search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>
Get a list of the coupons that match the given attributes in all active campaigns of an application Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 |
# File 'lib/talon_one/api/management_api.rb', line 5670 def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"] if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state']) fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/coupons_search_advanced/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2005' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced_application_wide_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_coupons_advanced_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2004, Integer, Hash)>
Get a list of the coupons that match the given attributes (with total count) Gets a list of all the coupons with attributes matching the query criteria
5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 |
# File 'lib/talon_one/api/management_api.rb', line 5429 def search_coupons_advanced_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.search_coupons_advanced" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2004' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {}) ⇒ InlineResponse2005
Get a list of the coupons that match the given attributes Gets a list of all the coupons with attributes matching the query criteria
5767 5768 5769 5770 |
# File 'lib/talon_one/api/management_api.rb', line 5767 def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts) data end |
#search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(InlineResponse2005, Integer, Hash)>
Get a list of the coupons that match the given attributes Gets a list of all the coupons with attributes matching the query criteria
5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 |
# File 'lib/talon_one/api/management_api.rb', line 5791 def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_without_total_count ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_without_total_count" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.search_coupons_advanced_without_total_count" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced_without_total_count" end allowable_values = ["expired", "validNow", "validFuture"] if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid']) fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}" end allowable_values = ["true", "false"] if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable']) fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil? query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil? query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil? query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil? query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil? query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'InlineResponse2005' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_additional_cost(additional_cost_id, body, opts = {}) ⇒ AccountAdditionalCost
Update an additional cost Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
5874 5875 5876 5877 |
# File 'lib/talon_one/api/management_api.rb', line 5874 def update_additional_cost(additional_cost_id, body, opts = {}) data, _status_code, _headers = update_additional_cost_with_http_info(additional_cost_id, body, opts) data end |
#update_additional_cost_with_http_info(additional_cost_id, body, opts = {}) ⇒ Array<(AccountAdditionalCost, Integer, Hash)>
Update an additional cost Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 |
# File 'lib/talon_one/api/management_api.rb', line 5885 def update_additional_cost_with_http_info(additional_cost_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.update_additional_cost ...' end # verify the required parameter 'additional_cost_id' is set if @api_client.config.client_side_validation && additional_cost_id.nil? fail ArgumentError, "Missing the required parameter 'additional_cost_id' when calling ManagementApi.update_additional_cost" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_additional_cost" end # resource path local_var_path = '/v1/additional_costs/{additionalCostId}'.sub('{' + 'additionalCostId' + '}', CGI.escape(additional_cost_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'AccountAdditionalCost' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#update_additional_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_attribute(attribute_id, body, opts = {}) ⇒ Attribute
Update a custom attribute Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name ‘region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you really need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
5944 5945 5946 5947 |
# File 'lib/talon_one/api/management_api.rb', line 5944 def update_attribute(attribute_id, body, opts = {}) data, _status_code, _headers = update_attribute_with_http_info(attribute_id, body, opts) data end |
#update_attribute_with_http_info(attribute_id, body, opts = {}) ⇒ Array<(Attribute, Integer, Hash)>
Update a custom attribute Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you really need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 |
# File 'lib/talon_one/api/management_api.rb', line 5955 def update_attribute_with_http_info(attribute_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.update_attribute ...' end # verify the required parameter 'attribute_id' is set if @api_client.config.client_side_validation && attribute_id.nil? fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ManagementApi.update_attribute" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_attribute" end # resource path local_var_path = '/v1/attributes/{attributeId}'.sub('{' + 'attributeId' + '}', CGI.escape(attribute_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Attribute' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#update_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_campaign(application_id, campaign_id, body, opts = {}) ⇒ Campaign
Update a Campaign
6014 6015 6016 6017 |
# File 'lib/talon_one/api/management_api.rb', line 6014 def update_campaign(application_id, campaign_id, body, opts = {}) data, _status_code, _headers = update_campaign_with_http_info(application_id, campaign_id, body, opts) data end |
#update_campaign_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(Campaign, Integer, Hash)>
Update a Campaign
6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 |
# File 'lib/talon_one/api/management_api.rb', line 6025 def update_campaign_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.update_campaign ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_campaign" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_campaign" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_campaign" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Campaign' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#update_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_coupon(application_id, campaign_id, coupon_id, body, opts = {}) ⇒ Coupon
Update a Coupon
6089 6090 6091 6092 |
# File 'lib/talon_one/api/management_api.rb', line 6089 def update_coupon(application_id, campaign_id, coupon_id, body, opts = {}) data, _status_code, _headers = update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts) data end |
#update_coupon_batch(application_id, campaign_id, body, opts = {}) ⇒ nil
Update a Batch of Coupons
6168 6169 6170 6171 |
# File 'lib/talon_one/api/management_api.rb', line 6168 def update_coupon_batch(application_id, campaign_id, body, opts = {}) update_coupon_batch_with_http_info(application_id, campaign_id, body, opts) nil end |
#update_coupon_batch_with_http_info(application_id, campaign_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update a Batch of Coupons
6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 |
# File 'lib/talon_one/api/management_api.rb', line 6179 def update_coupon_batch_with_http_info(application_id, campaign_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.update_coupon_batch ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_coupon_batch" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_coupon_batch" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_coupon_batch" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#update_coupon_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts = {}) ⇒ Array<(Coupon, Integer, Hash)>
Update a Coupon
6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 |
# File 'lib/talon_one/api/management_api.rb', line 6101 def update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.update_coupon ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_coupon" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_coupon" end # verify the required parameter 'coupon_id' is set if @api_client.config.client_side_validation && coupon_id.nil? fail ArgumentError, "Missing the required parameter 'coupon_id' when calling ManagementApi.update_coupon" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_coupon" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'couponId' + '}', CGI.escape(coupon_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Coupon' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#update_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_ruleset(application_id, campaign_id, ruleset_id, body, opts = {}) ⇒ Ruleset
Update a Ruleset
6241 6242 6243 6244 |
# File 'lib/talon_one/api/management_api.rb', line 6241 def update_ruleset(application_id, campaign_id, ruleset_id, body, opts = {}) data, _status_code, _headers = update_ruleset_with_http_info(application_id, campaign_id, ruleset_id, body, opts) data end |
#update_ruleset_with_http_info(application_id, campaign_id, ruleset_id, body, opts = {}) ⇒ Array<(Ruleset, Integer, Hash)>
Update a Ruleset
6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 |
# File 'lib/talon_one/api/management_api.rb', line 6253 def update_ruleset_with_http_info(application_id, campaign_id, ruleset_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ManagementApi.update_ruleset ...' end # verify the required parameter 'application_id' is set if @api_client.config.client_side_validation && application_id.nil? fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.update_ruleset" end # verify the required parameter 'campaign_id' is set if @api_client.config.client_side_validation && campaign_id.nil? fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.update_ruleset" end # verify the required parameter 'ruleset_id' is set if @api_client.config.client_side_validation && ruleset_id.nil? fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling ManagementApi.update_ruleset" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.update_ruleset" end # resource path local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'rulesetId' + '}', CGI.escape(ruleset_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:return_type] || 'Ruleset' # auth_names auth_names = opts[:auth_names] || ['manager_auth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ManagementApi#update_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |