Alycat-test NPM

alycat-test

AlycatTest - JavaScript client for alycat-test This SDK is automatically generated by the OpenAPI Generator project:

API version: 6.0.0-alpha.7
Package version: 9.0.0-alpha.3
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install alycat-test --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your alycat-test from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('alycat-test') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AlycatTest = require('alycat-test');

var defaultClient = AlycatTest.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new AlycatTest.ActivitiesApi()
var appId = 5d8cff3cd55b040010928b5b; // {String} Identifies the app.
var conversationId = 029c31f25a21b47effd7be90; // {String} Identifies the conversation.
var activityPost = new AlycatTest.ActivityPost(); // {ActivityPost} 
api.postActivity(appId, conversationId, activityPost).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.smooch.io

Class	Method	HTTP request	Description
AlycatTest.ActivitiesApi	postActivity	POST /v2/apps/{appId}/conversations/{conversationId}/activity	Post Activity
AlycatTest.AppKeysApi	createAppKey	POST /v2/apps/{appId}/keys	Create App Key
AlycatTest.AppKeysApi	deleteAppKey	DELETE /v2/apps/{appId}/keys/{keyId}	Delete App Key
AlycatTest.AppKeysApi	getAppKey	GET /v2/apps/{appId}/keys/{keyId}	Get App Key
AlycatTest.AppKeysApi	listAppKeys	GET /v2/apps/{appId}/keys	List App Keys
AlycatTest.AppsApi	createApp	POST /v2/apps	Create App
AlycatTest.AppsApi	deleteApp	DELETE /v2/apps/{appId}	Delete App
AlycatTest.AppsApi	getApp	GET /v2/apps/{appId}	Get App
AlycatTest.AppsApi	listApps	GET /v2/apps	List Apps
AlycatTest.AppsApi	updateApp	PATCH /v2/apps/{appId}	Update App
AlycatTest.AttachmentsApi	deleteAttachment	POST /v2/apps/{appId}/attachments/remove	Delete Attachment
AlycatTest.AttachmentsApi	generateMediaJsonWebToken	POST /v2/apps/{appId}/attachments/token	Generate Media Token
AlycatTest.AttachmentsApi	setCookie	POST /v2/apps/{appId}/attachments/cookie	Set Cookie
AlycatTest.AttachmentsApi	uploadAttachment	POST /v2/apps/{appId}/attachments	Upload Attachment
AlycatTest.ClientsApi	createClient	POST /v2/apps/{appId}/users/{userIdOrExternalId}/clients	Create Client
AlycatTest.ClientsApi	listClients	GET /v2/apps/{appId}/users/{userIdOrExternalId}/clients	List Clients
AlycatTest.ClientsApi	removeClient	DELETE /v2/apps/{appId}/users/{userIdOrExternalId}/clients/{clientId}	Remove Client
AlycatTest.ConversationsApi	createConversation	POST /v2/apps/{appId}/conversations	Create Conversation
AlycatTest.ConversationsApi	deleteConversation	DELETE /v2/apps/{appId}/conversations/{conversationId}	Delete Conversation
AlycatTest.ConversationsApi	getConversation	GET /v2/apps/{appId}/conversations/{conversationId}	Get Conversation
AlycatTest.ConversationsApi	listConversations	GET /v2/apps/{appId}/conversations	List Conversations
AlycatTest.ConversationsApi	updateConversation	PATCH /v2/apps/{appId}/conversations/{conversationId}	Update Conversation
AlycatTest.CustomIntegrationApiKeysApi	createCustomIntegrationKey	POST /v2/apps/{appId}/integrations/{integrationId}/keys	Create Integration Key
AlycatTest.CustomIntegrationApiKeysApi	deleteCustomIntegrationKey	DELETE /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}	Delete Integration Key
AlycatTest.CustomIntegrationApiKeysApi	getCustomIntegrationKey	GET /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}	Get Integration Key
AlycatTest.CustomIntegrationApiKeysApi	listCustomIntegrationKeys	GET /v2/apps/{appId}/integrations/{integrationId}/keys	List Integration Keys
AlycatTest.IntegrationsApi	createIntegration	POST /v2/apps/{appId}/integrations	Create Integration
AlycatTest.IntegrationsApi	deleteIntegration	DELETE /v2/apps/{appId}/integrations/{integrationId}	Delete Integration
AlycatTest.IntegrationsApi	getIntegration	GET /v2/apps/{appId}/integrations/{integrationId}	Get Integration
AlycatTest.IntegrationsApi	listIntegrations	GET /v2/apps/{appId}/integrations	List Integrations
AlycatTest.IntegrationsApi	updateIntegration	PATCH /v2/apps/{appId}/integrations/{integrationId}	Update Integration
AlycatTest.MessagesApi	deleteAllMessages	DELETE /v2/apps/{appId}/conversations/{conversationId}/messages	Delete All Messages
AlycatTest.MessagesApi	deleteMessage	DELETE /v2/apps/{appId}/conversations/{conversationId}/messages/{messageId}	Delete Message
AlycatTest.MessagesApi	listMessages	GET /v2/apps/{appId}/conversations/{conversationId}/messages	List Messages
AlycatTest.MessagesApi	postMessage	POST /v2/apps/{appId}/conversations/{conversationId}/messages	Post Message
AlycatTest.ParticipantsApi	joinConversation	POST /v2/apps/{appId}/conversations/{conversationId}/join	Join Conversation
AlycatTest.ParticipantsApi	leaveConversation	POST /v2/apps/{appId}/conversations/{conversationId}/leave	Leave Conversation
AlycatTest.ParticipantsApi	listParticipants	GET /v2/apps/{appId}/conversations/{conversationId}/participants	List Participants
AlycatTest.SwitchboardActionsApi	acceptControl	POST /v2/apps/{appId}/conversations/{conversationId}/acceptControl	Accept Control
AlycatTest.SwitchboardActionsApi	offerControl	POST /v2/apps/{appId}/conversations/{conversationId}/offerControl	Offer Control
AlycatTest.SwitchboardActionsApi	passControl	POST /v2/apps/{appId}/conversations/{conversationId}/passControl	Pass Control
AlycatTest.SwitchboardIntegrationsApi	createSwitchboardIntegration	POST /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations	Create Switchboard Integration
AlycatTest.SwitchboardIntegrationsApi	deleteSwitchboardIntegration	DELETE /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId}	Delete Switchboard Integration
AlycatTest.SwitchboardIntegrationsApi	listSwitchboardIntegrations	GET /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations	List Switchboard Integrations
AlycatTest.SwitchboardIntegrationsApi	updateSwitchboardIntegration	PATCH /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId}	Update Switchboard Integration
AlycatTest.SwitchboardsApi	createSwitchboard	POST /v2/apps/{appId}/switchboards	Create Switchboard
AlycatTest.SwitchboardsApi	deleteSwitchboard	DELETE /v2/apps/{appId}/switchboards/{switchboardId}	Delete Switchboard
AlycatTest.SwitchboardsApi	listSwitchboards	GET /v2/apps/{appId}/switchboards	List Switchboards
AlycatTest.SwitchboardsApi	updateSwitchboard	PATCH /v2/apps/{appId}/switchboards/{switchboardId}	Update Switchboard
AlycatTest.UsersApi	createUser	POST /v2/apps/{appId}/users/	Create User
AlycatTest.UsersApi	deleteUser	DELETE /v2/apps/{appId}/users/{userIdOrExternalId}	Delete User
AlycatTest.UsersApi	deleteUserPersonalInformation	DELETE /v2/apps/{appId}/users/{userIdOrExternalId}/personalinformation	Delete User Personal Information
AlycatTest.UsersApi	getUser	GET /v2/apps/{appId}/users/{userIdOrExternalId}	Get User
AlycatTest.UsersApi	updateUser	PATCH /v2/apps/{appId}/users/{userIdOrExternalId}	Update User
AlycatTest.WebhooksApi	createWebhook	POST /v2/apps/{appId}/integrations/{integrationId}/webhooks	Create Webhook
AlycatTest.WebhooksApi	deleteWebhook	DELETE /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}	Delete Webhook
AlycatTest.WebhooksApi	getWebhook	GET /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}	Get Webhook
AlycatTest.WebhooksApi	listWebhooks	GET /v2/apps/{appId}/integrations/{integrationId}/webhooks	List Webhooks
AlycatTest.WebhooksApi	updateWebhook	PATCH /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}	Update Webhook

Documentation for Models

Documentation for Authorization

basicAuth

Type: HTTP basic authentication

bearerAuth

Type: Bearer authentication (JWT)

@babel/cli superagent

9.0.0-alpha.3

4 years ago