Skip to content

Commit 71a9376

Browse files
author
Bassem Dghaidi
committed
Add default auto-generated client
0 parents  commit 71a9376

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+4360
-0
lines changed

‎.gitignore

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
2+
3+
# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,node
4+
# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,node
5+
6+
### macOS ###
7+
# General
8+
.DS_Store
9+
.AppleDouble
10+
.LSOverride
11+
12+
# Icon must end with two \r
13+
Icon
14+
15+
# Thumbnails
16+
._*
17+
18+
# Files that might appear in the root of a volume
19+
.DocumentRevisions-V100
20+
.fseventsd
21+
.Spotlight-V100
22+
.TemporaryItems
23+
.Trashes
24+
.VolumeIcon.icns
25+
.com.apple.timemachine.donotpresent
26+
27+
# Directories potentially created on remote AFP share
28+
.AppleDB
29+
.AppleDesktop
30+
Network Trash Folder
31+
Temporary Items
32+
.apdisk
33+
34+
### Node ###
35+
# Logs
36+
logs
37+
*.log
38+
npm-debug.log*
39+
yarn-debug.log*
40+
yarn-error.log*
41+
lerna-debug.log*
42+
43+
# Diagnostic reports (https://nodejs.org/api/report.html)
44+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
45+
46+
# Runtime data
47+
pids
48+
*.pid
49+
*.seed
50+
*.pid.lock
51+
52+
# Directory for instrumented libs generated by jscoverage/JSCover
53+
lib-cov
54+
55+
# Coverage directory used by tools like istanbul
56+
coverage
57+
*.lcov
58+
59+
# nyc test coverage
60+
.nyc_output
61+
62+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
63+
.grunt
64+
65+
# Bower dependency directory (https://bower.io/)
66+
bower_components
67+
68+
# node-waf configuration
69+
.lock-wscript
70+
71+
# Compiled binary addons (https://nodejs.org/api/addons.html)
72+
build/Release
73+
74+
# Dependency directories
75+
node_modules/
76+
jspm_packages/
77+
78+
# TypeScript v1 declaration files
79+
typings/
80+
81+
# TypeScript cache
82+
*.tsbuildinfo
83+
84+
# Optional npm cache directory
85+
.npm
86+
87+
# Optional eslint cache
88+
.eslintcache
89+
90+
# Microbundle cache
91+
.rpt2_cache/
92+
.rts2_cache_cjs/
93+
.rts2_cache_es/
94+
.rts2_cache_umd/
95+
96+
# Optional REPL history
97+
.node_repl_history
98+
99+
# Output of 'npm pack'
100+
*.tgz
101+
102+
# Yarn Integrity file
103+
.yarn-integrity
104+
105+
# dotenv environment variables file
106+
.env
107+
.env.test
108+
109+
# parcel-bundler cache (https://parceljs.org/)
110+
.cache
111+
112+
# Next.js build output
113+
.next
114+
115+
# Nuxt.js build / generate output
116+
.nuxt
117+
dist
118+
119+
# Gatsby files
120+
.cache/
121+
# Comment in the public line in if your project uses Gatsby and not Next.js
122+
# https://nextjs.org/blog/next-9-1#public-directory-support
123+
# public
124+
125+
# vuepress build output
126+
.vuepress/dist
127+
128+
# Serverless directories
129+
.serverless/
130+
131+
# FuseBox cache
132+
.fusebox/
133+
134+
# DynamoDB Local files
135+
.dynamodb/
136+
137+
# TernJS port file
138+
.tern-port
139+
140+
# Stores VSCode versions used for testing VSCode extensions
141+
.vscode-test
142+
143+
### VisualStudioCode ###
144+
.vscode/*
145+
!.vscode/settings.json
146+
!.vscode/tasks.json
147+
!.vscode/launch.json
148+
!.vscode/extensions.json
149+
*.code-workspace
150+
151+
### VisualStudioCode Patch ###
152+
# Ignore all local history of files
153+
.history
154+
155+
# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,node
156+
157+
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
158+

‎README.md

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# api_v1
2+
3+
ApiV1 - JavaScript client for api_v1
4+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
6+
7+
- API version: v1
8+
- Package version: v1
9+
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
10+
11+
## Installation
12+
13+
### For [Node.js](https://nodejs.org/)
14+
15+
#### npm
16+
17+
To publish the library as a [npm](https://www.npmjs.com/),
18+
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
19+
20+
Then install it via:
21+
22+
```shell
23+
npm install api_v1 --save
24+
```
25+
26+
#### git
27+
#
28+
If the library is hosted at a git repository, e.g.
29+
https://github.com/GIT_USER_ID/GIT_REPO_ID
30+
then install it via:
31+
32+
```shell
33+
npm install GIT_USER_ID/GIT_REPO_ID --save
34+
```
35+
36+
### For browser
37+
38+
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
39+
the above steps with Node.js and installing browserify with `npm install -g browserify`,
40+
perform the following (assuming *main.js* is your entry file):
41+
42+
```shell
43+
browserify main.js > bundle.js
44+
```
45+
46+
Then include *bundle.js* in the HTML pages.
47+
48+
### Webpack Configuration
49+
50+
Using Webpack you may encounter the following error: "Module not found: Error:
51+
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
52+
the following section to your webpack config:
53+
54+
```javascript
55+
module: {
56+
rules: [
57+
{
58+
parser: {
59+
amd: false
60+
}
61+
}
62+
]
63+
}
64+
```
65+
66+
## Getting Started
67+
68+
Please follow the [installation](#installation) instruction and execute the following JS code:
69+
70+
```javascript
71+
var ApiV1 = require('api_v1');
72+
var defaultClient = ApiV1.ApiClient.instance;
73+
74+
// Configure API key authorization: Bearer
75+
var Bearer = defaultClient.authentications['Bearer'];
76+
Bearer.apiKey = "YOUR API KEY"
77+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
78+
//Bearer.apiKeyPrefix['Authorization'] = "Token"
79+
80+
var api = new ApiV1.InvitationsApi()
81+
var callback = function(error, data, response) {
82+
if (error) {
83+
console.error(error);
84+
} else {
85+
console.log('API called successfully.');
86+
}
87+
};
88+
api.apiV1InvitationsGet(callback);
89+
```
90+
91+
## Documentation for API Endpoints
92+
93+
All URIs are relative to *https://menadevs.com/api/v1/*
94+
95+
Class | Method | HTTP request | Description
96+
------------ | ------------- | ------------- | -------------
97+
*ApiV1.InvitationsApi* | [**apiV1InvitationsGet**](docs/InvitationsApi.md#apiV1InvitationsGet) | **GET** /api/v1/invitations | Invitation
98+
*ApiV1.InvitationsApi* | [**createNewInvitation**](docs/InvitationsApi.md#createNewInvitation) | **POST** /api/v1/invitations | Invitation
99+
*ApiV1.JobApi* | [**apiV1JobsIdGet**](docs/JobApi.md#apiV1JobsIdGet) | **GET** /api/v1/jobs/{id} | Retrieves a job
100+
*ApiV1.JobsApi* | [**apiV1JobsGet**](docs/JobsApi.md#apiV1JobsGet) | **GET** /api/v1/jobs | All jobs
101+
*ApiV1.UserApi* | [**apiV1UsersIdGet**](docs/UserApi.md#apiV1UsersIdGet) | **GET** /api/v1/users/{id} | Retrieves a user
102+
*ApiV1.UserApi* | [**apiV1UsersSearchGet**](docs/UserApi.md#apiV1UsersSearchGet) | **GET** /api/v1/users/search | Searches for a user using an incorrect query parameter
103+
*ApiV1.UsersApi* | [**apiV1UsersGet**](docs/UsersApi.md#apiV1UsersGet) | **GET** /api/v1/users | All users
104+
105+
## Documentation for Models
106+
107+
- [ApiV1.ErrorsMap](docs/ErrorsMap.md)
108+
- [ApiV1.ErrorsObject](docs/ErrorsObject.md)
109+
- [ApiV1.Invitation](docs/Invitation.md)
110+
- [ApiV1.InvitationInvitation](docs/InvitationInvitation.md)
111+
- [ApiV1.Jobs](docs/Jobs.md)
112+
- [ApiV1.JobsAttributes](docs/JobsAttributes.md)
113+
- [ApiV1.JobsData](docs/JobsData.md)
114+
- [ApiV1.JobsMeta](docs/JobsMeta.md)
115+
- [ApiV1.JobsPagination](docs/JobsPagination.md)
116+
- [ApiV1.User](docs/User.md)
117+
- [ApiV1.Users](docs/Users.md)
118+
- [ApiV1.UsersAttributes](docs/UsersAttributes.md)
119+
- [ApiV1.UsersData](docs/UsersData.md)
120+
121+
## Documentation for Authorization
122+
123+
124+
### Bearer
125+
126+
- **Type**: API key
127+
- **API key parameter name**: Authorization
128+
- **Location**: HTTP header
129+

‎docs/ErrorsMap.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ApiV1.ErrorsMap
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------

‎docs/ErrorsObject.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# ApiV1.ErrorsObject
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**errors** | [**ErrorsMap**](ErrorsMap.md) | | [optional]

‎docs/Invitation.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# ApiV1.Invitation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**invitation** | [**InvitationInvitation**](InvitationInvitation.md) | | [optional]

‎docs/InvitationInvitation.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ApiV1.InvitationInvitation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**inviteeTitle** | **String** | | [optional]
7+
**inviteeName** | **String** | |
8+
**inviteeEmail** | **String** | |
9+
**slackUid** | **String** | | [optional]
10+
**inviteeCompany** | **String** | | [optional]

0 commit comments

Comments
 (0)