Method: TalonOne::ManagementApi#export_coupons

Defined in:

lib/talon_one/api/management_api.rb

#export_coupons(application_id, opts = {}) ⇒ String

Export coupons Download a CSV file containing the coupons that match the given properties. Tip: If the exported CSV file is too large to view, you can [split it into multiple files](www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - ‘accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing custom referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.

Parameters:

• application_id (Integer) —

  The ID of the Application. It is displayed in your Talon.One deployment URL.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :campaign_id (Float) —

  Filter results by campaign ID.

• :sort (String) —

  The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: You may not be able to use all fields for sorting. This is due to performance limitations.

• :value (String) —

  Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

• :created_before (DateTime) —

  Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

• :created_after (DateTime) —

  Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

• :valid (String) —

  Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.

• :usable (String) —

  Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`.

• :referral_id (Integer) —

  Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

• :recipient_integration_id (String) —

  Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.

• :batch_id (String) —

  Filter results by batches of coupons

• :exact_match (Boolean) —

  Filter results to an exact case-insensitive matching against the coupon code. (default to false)

• :date_format (String) —

  Determines the format of dates in the export document.

• :campaign_state (String) —

  Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.

• :values_only (Boolean) —

  Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false)

Returns:

• (String)

# File 'lib/talon_one/api/management_api.rb', line 3094

def export_coupons(application_id, opts = {})
  data, _status_code, _headers = export_coupons_with_http_info(application_id, opts)
  data
end