Skip to content

Latest commit

 

History

History
156 lines (101 loc) · 3.76 KB

ClientsApi.md

File metadata and controls

156 lines (101 loc) · 3.76 KB
Raw

Flipdish.ClientsApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
getClient GET /api/v1.0/clients/{clientId}
setSalesForceContactId POST /api/v1.0/clients/{clientId}/salesforcecontactid
setStripeCustomerId POST /api/v1.0/clients/{clientId}/stripecustomerid

getClient

getClient(clientId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ClientsApi();
let clientId = 56; // Number | 
apiInstance.getClient(clientId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
clientId Number

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

setSalesForceContactId

setSalesForceContactId(clientId, salesForceContactId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ClientsApi();
let clientId = 56; // Number | 
let salesForceContactId = "salesForceContactId_example"; // String | 
apiInstance.setSalesForceContactId(clientId, salesForceContactId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
clientId Number
salesForceContactId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

setStripeCustomerId

setStripeCustomerId(clientId, stripeCustomerId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.ClientsApi();
let clientId = 56; // Number | 
let stripeCustomerId = "stripeCustomerId_example"; // String | 
apiInstance.setStripeCustomerId(clientId, stripeCustomerId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
clientId Number
stripeCustomerId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml