Class: VoucherifySdk::PublicationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/api/publications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PublicationsApi

Returns a new instance of PublicationsApi.



19
20
21
 
# File 'lib/VoucherifySdk/api/publications_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/VoucherifySdk/api/publications_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_publication(opts = {}) ⇒ PublicationsCreateResponseBody

Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an auto-update campaign.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :join_once (Boolean) —

    Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer.

  • :publications_create_request_body (PublicationsCreateRequestBody) —

    Specify the publication parameters.

Returns:



28
29
30
31
 
# File 'lib/VoucherifySdk/api/publications_api.rb', line 28

def create_publication(opts = {})
  data, _status_code, _headers = create_publication_with_http_info(opts)
  data
end

#create_publication1(customer, opts = {}) ⇒ PublicationsCreateResponseBody

Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. ❗️ Limited access Access to this endpoint is limited. This endpoint is designed for specific integrations and the API keys need to be configured to access this endpoint. Navigate to the Dashboard → **Project Settings** → General → **Integration Keys** to set up a pair of API keys and use them to send the request. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers This endpoint does not support the publishing of multiple vouchers from a single campaign. In case you want to publish multiple vouchers within a single publication, you need to use a dedicated endpoint. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an auto-update campaign. # Example Request ❗️ Required Query param voucher OR campaign MUST be filled out. If you provide both, campaign param will be skipped.

Parameters:

  • customer (Customer) —

    Contains information about the customer to whom the publication was directed.

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

    the optional parameters

Options Hash (opts):

  • :join_once (Boolean) —

    Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer.

  • :voucher (String) —

    Code of voucher being published.

  • :campaign (CreatePublicationCampaign) —

    Create publication with campaign.

  • :source_id (String) —

    The merchant’s publication ID if it is different from the Voucherify publication ID. Its an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service. If source_id is provided only 1 voucher can be published per request.

  • :metadata (Object) —

    The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format.

Returns:



99
100
101
102
 
# File 'lib/VoucherifySdk/api/publications_api.rb', line 99

def create_publication1(customer, opts = {})
  data, _status_code, _headers = create_publication1_with_http_info(customer, opts)
  data
end

#list_publications(opts = {}) ⇒ PublicationsListResponseBody

List Publications Retrieve a list of publications. To return a particular publication, you can use the source_id query parameter and provide the source_id of the publication you are looking for specifically. # Pagination 🚧 Important! If you want to scroll through a huge set of records, it is recommended to use the Exports API. This API will return an error page_over_limit if you reach a page above 1000. # Filter Query The filters query parameter allows for joining multiple parameters with logical operators. The syntax looks as follows: ## Operators: ## Examples

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

  • :page (Integer) —

    Which page of results to return.

  • :order (ParameterOrderListPublications) —

    Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

  • :campaign (String) —

    Filters by a given campaign name.

  • :customer (String) —

    Filters by a unique customer ID.

  • :voucher (String) —

    Filters by a given voucher code.

  • :result (ParameterResultListPublications) —

    Filters by a publication result.

  • :voucher_type (ParameterVoucherTypeListPublications) —

    Filters by a voucher type.

  • :is_referral_code (Boolean) —

    This filter works only for the true option. If set to true, the query returns only publications of codes from referral campaigns.

  • :filters (String) —

    Allows for combining the filters mentioned in the endpoint description.

  • :source_id (String) —

    Using this endpoint with a particular publication source_id, which was sent with the original request to create a publication, returns in the response, exactly the same code published initially because the code was assigned to the given publication. As a result, you can use this endpoint as a reference and return a code that was assigned in a publication by using a particular source_id.

Returns:



183
184
185
186
 
# File 'lib/VoucherifySdk/api/publications_api.rb', line 183

def list_publications(opts = {})
  data, _status_code, _headers = list_publications_with_http_info(opts)
  data
end