@teemill/countries 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/README.md +40 -3
  2. package/api.ts +185 -0
  3. package/base.ts +86 -0
  4. package/common.ts +150 -0
  5. package/configuration.ts +115 -0
  6. package/dist/api.d.ts +121 -0
  7. package/dist/api.js +133 -0
  8. package/dist/base.d.ts +66 -0
  9. package/dist/base.js +65 -0
  10. package/dist/common.d.ts +65 -0
  11. package/dist/common.js +161 -0
  12. package/dist/configuration.d.ts +91 -0
  13. package/dist/configuration.js +44 -0
  14. package/dist/esm/api.d.ts +121 -0
  15. package/dist/esm/api.js +126 -0
  16. package/dist/esm/base.d.ts +66 -0
  17. package/dist/esm/base.js +60 -0
  18. package/dist/esm/common.d.ts +65 -0
  19. package/dist/esm/common.js +149 -0
  20. package/dist/esm/configuration.d.ts +91 -0
  21. package/dist/esm/configuration.js +40 -0
  22. package/dist/esm/index.d.ts +13 -0
  23. package/dist/esm/index.js +15 -0
  24. package/dist/index.d.ts +13 -3
  25. package/dist/index.js +15 -5
  26. package/docs/ApiError.md +22 -0
  27. package/docs/CountriesApi.md +55 -0
  28. package/docs/Country.md +22 -0
  29. package/docs/InlineObject.md +20 -0
  30. package/git_push.sh +57 -0
  31. package/index.ts +18 -0
  32. package/package.json +18 -4
  33. package/tsconfig.esm.json +7 -0
  34. package/tsconfig.json +4 -6
  35. package/.openapi-generator/FILES +0 -13
  36. package/.openapi-generator/VERSION +0 -1
  37. package/.openapi-generator-ignore +0 -23
  38. package/dist/apis/CountriesApi.d.ts +0 -28
  39. package/dist/apis/CountriesApi.js +0 -136
  40. package/dist/apis/index.d.ts +0 -1
  41. package/dist/apis/index.js +0 -19
  42. package/dist/models/ApiError.d.ts +0 -37
  43. package/dist/models/ApiError.js +0 -53
  44. package/dist/models/Country.d.ts +0 -37
  45. package/dist/models/Country.js +0 -53
  46. package/dist/models/GetCountries200Response.d.ts +0 -32
  47. package/dist/models/GetCountries200Response.js +0 -51
  48. package/dist/models/index.d.ts +0 -3
  49. package/dist/models/index.js +0 -21
  50. package/dist/runtime.d.ts +0 -187
  51. package/dist/runtime.js +0 -565
  52. package/src/apis/CountriesApi.ts +0 -77
  53. package/src/apis/index.ts +0 -3
  54. package/src/index.ts +0 -5
  55. package/src/models/ApiError.ts +0 -74
  56. package/src/models/Country.ts +0 -75
  57. package/src/models/GetCountries200Response.ts +0 -72
  58. package/src/models/index.ts +0 -5
  59. package/src/runtime.ts +0 -441
@@ -0,0 +1,91 @@
1
+ /**
2
+ * Countries API
3
+ * Manage PodOS Countries
4
+ *
5
+ * The version of the OpenAPI document: 0.1.2
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface ConfigurationParameters {
13
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
+ username?: string;
15
+ password?: string;
16
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
17
+ basePath?: string;
18
+ serverIndex?: number;
19
+ baseOptions?: any;
20
+ formDataCtor?: new () => any;
21
+ }
22
+ export declare class Configuration {
23
+ /**
24
+ * parameter for apiKey security
25
+ * @param name security name
26
+ * @memberof Configuration
27
+ */
28
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
+ /**
30
+ * parameter for basic security
31
+ *
32
+ * @type {string}
33
+ * @memberof Configuration
34
+ */
35
+ username?: string;
36
+ /**
37
+ * parameter for basic security
38
+ *
39
+ * @type {string}
40
+ * @memberof Configuration
41
+ */
42
+ password?: string;
43
+ /**
44
+ * parameter for oauth2 security
45
+ * @param name security name
46
+ * @param scopes oauth2 scope
47
+ * @memberof Configuration
48
+ */
49
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
+ /**
51
+ * override base path
52
+ *
53
+ * @type {string}
54
+ * @memberof Configuration
55
+ */
56
+ basePath?: string;
57
+ /**
58
+ * override server index
59
+ *
60
+ * @type {number}
61
+ * @memberof Configuration
62
+ */
63
+ serverIndex?: number;
64
+ /**
65
+ * base options for axios calls
66
+ *
67
+ * @type {any}
68
+ * @memberof Configuration
69
+ */
70
+ baseOptions?: any;
71
+ /**
72
+ * The FormData constructor that will be used to create multipart form data
73
+ * requests. You can inject this here so that execution environments that
74
+ * do not support the FormData class can still run the generated client.
75
+ *
76
+ * @type {new () => FormData}
77
+ */
78
+ formDataCtor?: new () => any;
79
+ constructor(param?: ConfigurationParameters);
80
+ /**
81
+ * Check if the given MIME is a JSON MIME.
82
+ * JSON MIME examples:
83
+ * application/json
84
+ * application/json; charset=UTF8
85
+ * APPLICATION/JSON
86
+ * application/vnd.company+json
87
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
88
+ * @return True if the given MIME is JSON, false otherwise.
89
+ */
90
+ isJsonMime(mime: string): boolean;
91
+ }
@@ -0,0 +1,40 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Countries API
5
+ * Manage PodOS Countries
6
+ *
7
+ * The version of the OpenAPI document: 0.1.2
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export class Configuration {
15
+ constructor(param = {}) {
16
+ var _a;
17
+ this.apiKey = param.apiKey;
18
+ this.username = param.username;
19
+ this.password = param.password;
20
+ this.accessToken = param.accessToken;
21
+ this.basePath = param.basePath;
22
+ this.serverIndex = param.serverIndex;
23
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
24
+ this.formDataCtor = param.formDataCtor;
25
+ }
26
+ /**
27
+ * Check if the given MIME is a JSON MIME.
28
+ * JSON MIME examples:
29
+ * application/json
30
+ * application/json; charset=UTF8
31
+ * APPLICATION/JSON
32
+ * application/vnd.company+json
33
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
34
+ * @return True if the given MIME is JSON, false otherwise.
35
+ */
36
+ isJsonMime(mime) {
37
+ const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
38
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
39
+ }
40
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Countries API
3
+ * Manage PodOS Countries
4
+ *
5
+ * The version of the OpenAPI document: 0.1.2
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export * from "./api";
13
+ export * from "./configuration";
@@ -0,0 +1,15 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Countries API
5
+ * Manage PodOS Countries
6
+ *
7
+ * The version of the OpenAPI document: 0.1.2
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export * from "./api";
15
+ export * from "./configuration";
package/dist/index.d.ts CHANGED
@@ -1,3 +1,13 @@
1
- export * from './runtime';
2
- export * from './apis/index';
3
- export * from './models/index';
1
+ /**
2
+ * Countries API
3
+ * Manage PodOS Countries
4
+ *
5
+ * The version of the OpenAPI document: 0.1.2
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export * from "./api";
13
+ export * from "./configuration";
package/dist/index.js CHANGED
@@ -1,4 +1,17 @@
1
1
  "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Countries API
6
+ * Manage PodOS Countries
7
+ *
8
+ * The version of the OpenAPI document: 0.1.2
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
2
15
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
16
  if (k2 === undefined) k2 = k;
4
17
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,8 +27,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
27
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
28
  };
16
29
  Object.defineProperty(exports, "__esModule", { value: true });
17
- /* tslint:disable */
18
- /* eslint-disable */
19
- __exportStar(require("./runtime"), exports);
20
- __exportStar(require("./apis/index"), exports);
21
- __exportStar(require("./models/index"), exports);
30
+ __exportStar(require("./api"), exports);
31
+ __exportStar(require("./configuration"), exports);
@@ -0,0 +1,22 @@
1
+ # ApiError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [optional] [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ApiError } from '@teemill/countries';
15
+
16
+ const instance: ApiError = {
17
+ code,
18
+ message,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,55 @@
1
+ # CountriesApi
2
+
3
+ All URIs are relative to *https://localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getCountries**](#getcountries) | **GET** /v1/countries | List countries|
8
+
9
+ # **getCountries**
10
+ > InlineObject getCountries()
11
+
12
+ List all countries
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ CountriesApi,
19
+ Configuration
20
+ } from '@teemill/countries';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new CountriesApi(configuration);
24
+
25
+ const { status, data } = await apiInstance.getCountries();
26
+ ```
27
+
28
+ ### Parameters
29
+ This endpoint does not have any parameters.
30
+
31
+
32
+ ### Return type
33
+
34
+ **InlineObject**
35
+
36
+ ### Authorization
37
+
38
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
39
+
40
+ ### HTTP request headers
41
+
42
+ - **Content-Type**: Not defined
43
+ - **Accept**: application/json
44
+
45
+
46
+ ### HTTP response details
47
+ | Status code | Description | Response headers |
48
+ |-------------|-------------|------------------|
49
+ |**200** | List of available countries | - |
50
+ |**401** | Not authorised to access this resource | - |
51
+ |**403** | Refuse to authorize | - |
52
+ |**500** | Unknown server error | - |
53
+
54
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
55
+
@@ -0,0 +1,22 @@
1
+ # Country
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | The unique identifier for the country | [default to undefined]
9
+ **name** | **string** | The name of the country | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { Country } from '@teemill/countries';
15
+
16
+ const instance: Country = {
17
+ id,
18
+ name,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # InlineObject
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **countries** | [**Array&lt;Country&gt;**](Country.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { InlineObject } from '@teemill/countries';
14
+
15
+ const instance: InlineObject = {
16
+ countries,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/git_push.sh ADDED
@@ -0,0 +1,57 @@
1
+ #!/bin/sh
2
+ # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3
+ #
4
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5
+
6
+ git_user_id=$1
7
+ git_repo_id=$2
8
+ release_note=$3
9
+ git_host=$4
10
+
11
+ if [ "$git_host" = "" ]; then
12
+ git_host="github.com"
13
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
+ fi
15
+
16
+ if [ "$git_user_id" = "" ]; then
17
+ git_user_id="Teemill"
18
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19
+ fi
20
+
21
+ if [ "$git_repo_id" = "" ]; then
22
+ git_repo_id="public-api"
23
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24
+ fi
25
+
26
+ if [ "$release_note" = "" ]; then
27
+ release_note="Minor update"
28
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29
+ fi
30
+
31
+ # Initialize the local directory as a Git repository
32
+ git init
33
+
34
+ # Adds the files in the local repository and stages them for commit.
35
+ git add .
36
+
37
+ # Commits the tracked changes and prepares them to be pushed to a remote repository.
38
+ git commit -m "$release_note"
39
+
40
+ # Sets the new remote
41
+ git_remote=$(git remote)
42
+ if [ "$git_remote" = "" ]; then # git remote not defined
43
+
44
+ if [ "$GIT_TOKEN" = "" ]; then
45
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47
+ else
48
+ git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
49
+ fi
50
+
51
+ fi
52
+
53
+ git pull origin master
54
+
55
+ # Pushes (Forces) the changes in the local repository up to the remote repository
56
+ echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57
+ git push origin master 2>&1 | grep -v 'To https'
package/index.ts ADDED
@@ -0,0 +1,18 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Countries API
5
+ * Manage PodOS Countries
6
+ *
7
+ * The version of the OpenAPI document: 0.1.2
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ export * from "./api";
17
+ export * from "./configuration";
18
+
package/package.json CHANGED
@@ -1,19 +1,33 @@
1
1
  {
2
2
  "name": "@teemill/countries",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "OpenAPI client for @teemill/countries",
5
- "author": "OpenAPI-Generator",
5
+ "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "https://github.com/Teemill/public-api.git"
9
9
  },
10
+ "keywords": [
11
+ "axios",
12
+ "typescript",
13
+ "openapi-client",
14
+ "openapi-generator",
15
+ "@teemill/countries"
16
+ ],
17
+ "license": "Unlicense",
10
18
  "main": "./dist/index.js",
11
19
  "typings": "./dist/index.d.ts",
20
+ "module": "./dist/esm/index.js",
21
+ "sideEffects": false,
12
22
  "scripts": {
13
- "build": "tsc",
23
+ "build": "tsc && tsc -p tsconfig.esm.json",
14
24
  "prepare": "npm run build"
15
25
  },
26
+ "dependencies": {
27
+ "axios": "^1.6.1"
28
+ },
16
29
  "devDependencies": {
17
- "typescript": "^4.0"
30
+ "@types/node": "12.11.5 - 12.20.42",
31
+ "typescript": "^4.0 || ^5.0"
18
32
  }
19
33
  }
@@ -0,0 +1,7 @@
1
+ {
2
+ "extends": "./tsconfig.json",
3
+ "compilerOptions": {
4
+ "module": "esnext",
5
+ "outDir": "dist/esm"
6
+ }
7
+ }
package/tsconfig.json CHANGED
@@ -1,14 +1,12 @@
1
1
  {
2
2
  "compilerOptions": {
3
3
  "declaration": true,
4
- "target": "es5",
4
+ "target": "ES6",
5
5
  "module": "commonjs",
6
- "moduleResolution": "node",
6
+ "noImplicitAny": true,
7
7
  "outDir": "dist",
8
- "lib": [
9
- "es6",
10
- "dom"
11
- ],
8
+ "rootDir": ".",
9
+ "moduleResolution": "node",
12
10
  "typeRoots": [
13
11
  "node_modules/@types"
14
12
  ]
@@ -1,13 +0,0 @@
1
- .gitignore
2
- .npmignore
3
- README.md
4
- package.json
5
- src/apis/CountriesApi.ts
6
- src/apis/index.ts
7
- src/index.ts
8
- src/models/ApiError.ts
9
- src/models/Country.ts
10
- src/models/GetCountries200Response.ts
11
- src/models/index.ts
12
- src/runtime.ts
13
- tsconfig.json
@@ -1 +0,0 @@
1
- 7.3.0
@@ -1,23 +0,0 @@
1
- # OpenAPI Generator Ignore
2
- # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
-
4
- # Use this file to prevent files from being overwritten by the generator.
5
- # The patterns follow closely to .gitignore or .dockerignore.
6
-
7
- # As an example, the C# client generator defines ApiClient.cs.
8
- # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
- #ApiClient.cs
10
-
11
- # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
- #foo/*/qux
13
- # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
-
15
- # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
- #foo/**/qux
17
- # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
-
19
- # You can also negate patterns with an exclamation (!).
20
- # For example, you can ignore all files in a docs folder with the file extension .md:
21
- #docs/*.md
22
- # Then explicitly reverse the ignore rule for a single file:
23
- #!docs/README.md
@@ -1,28 +0,0 @@
1
- /**
2
- * Countries API
3
- * Manage Teemill Countries. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- * Contact: hello@teemill.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { GetCountries200Response } from '../models/index';
14
- /**
15
- *
16
- */
17
- export declare class CountriesApi extends runtime.BaseAPI {
18
- /**
19
- * List all countries
20
- * List countries
21
- */
22
- getCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCountries200Response>>;
23
- /**
24
- * List all countries
25
- * List countries
26
- */
27
- getCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCountries200Response>;
28
- }