Jsflagr.VariantApi

February 12, 2019 ยท View on GitHub

All URIs are relative to http://localhost/api/v1

MethodHTTP requestDescription
createVariantPOST /flags/{flagID}/variants
deleteVariantDELETE /flags/{flagID}/variants/{variantID}
findVariantsGET /flags/{flagID}/variants
putVariantPUT /flags/{flagID}/variants/{variantID}

createVariant

Variant createVariant(flagID, body)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.VariantApi();

var flagID = 789; // Number | numeric ID of the flag

var body = new Jsflagr.CreateVariantRequest(); // CreateVariantRequest | create a variant


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createVariant(flagID, body, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
bodyCreateVariantRequestcreate a variant

Return type

Variant

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteVariant

deleteVariant(flagID, variantID)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.VariantApi();

var flagID = 789; // Number | numeric ID of the flag

var variantID = 789; // Number | numeric ID of the variant


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteVariant(flagID, variantID, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
variantIDNumbernumeric ID of the variant

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

findVariants

[Variant] findVariants(flagID)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.VariantApi();

var flagID = 789; // Number | numeric ID of the flag


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.findVariants(flagID, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag

Return type

[Variant]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

putVariant

Variant putVariant(flagID, variantID, body)

Example

var Jsflagr = require('jsflagr');

var apiInstance = new Jsflagr.VariantApi();

var flagID = 789; // Number | numeric ID of the flag

var variantID = 789; // Number | numeric ID of the variant

var body = new Jsflagr.PutVariantRequest(); // PutVariantRequest | update a variant


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putVariant(flagID, variantID, body, callback);

Parameters

NameTypeDescriptionNotes
flagIDNumbernumeric ID of the flag
variantIDNumbernumeric ID of the variant
bodyPutVariantRequestupdate a variant

Return type

Variant

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json