Skip to content

Commit 36c4cad

Browse files
committed
Releasing Version 1.0.1
0 parents  commit 36c4cad

File tree

5,137 files changed

+359423
-0
lines changed

Some content is hidden

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

5,137 files changed

+359423
-0
lines changed

.gitignore

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
node_modules
2+
dist/
3+
.idea
4+
*.iml
5+
target/
6+
coverage
7+
*.bk
8+
.nyc_output
9+
*.orig
10+
*.log
11+
custom-packages/
12+
*.js.map
13+
lib/**/*.js
14+
*.auto.spec.js
15+
integration-test/*.js
16+
.vscode
17+
.DS_Store

.prettierrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"printWidth": 100,
3+
"quoteProps": "preserve"
4+
}

CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## 1.0.1 - 2020-05-27
2+
3+
### Added
4+
5+
- Initial Release

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to the Oracle Cloud Infrastructure SDK for TypeScript
2+
3+
_Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved._
4+
5+
Pull requests can be made under
6+
[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html)
7+
(OCA).
8+
9+
For pull requests to be accepted, the bottom of
10+
your commit message must have the following line using your name and
11+
e-mail address as it appears in the OCA Signatories list.
12+
13+
```
14+
Signed-off-by: Your Name <[email protected]>
15+
```
16+
17+
This can be automatically added to pull requests by committing with:
18+
19+
```
20+
git commit --signoff
21+
```
22+
23+
Only pull requests from committers that can be verified as having
24+
signed the OCA can be accepted.

LICENSE.txt

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
The Universal Permissive License (UPL), Version 1.0
2+
3+
Subject to the condition set forth below, permission is hereby granted to any
4+
person obtaining a copy of this software, associated documentation and/or data
5+
(collectively the "Software"), free of charge and under any and all copyright
6+
rights in the Software, and any and all patent rights owned or freely
7+
licensable by each licensor hereunder covering either (i) the unmodified
8+
Software as contributed to or provided by such licensor, or (ii) the Larger
9+
Works (as defined below), to deal in both
10+
11+
(a) the Software, and
12+
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
13+
one is included with the Software (each a "Larger Work" to which the Software
14+
is contributed by such licensors),
15+
16+
without restriction, including without limitation the rights to copy, create
17+
derivative works of, display, perform, and distribute the Software and make,
18+
use, sell, offer for sale, import, export, have made, and have sold the
19+
Software and the Larger Work(s), and to sublicense the foregoing rights on
20+
either these or other terms.
21+
22+
This license is subject to the following condition:
23+
24+
The above copyright notice and either this complete permission notice or at a
25+
minimum a reference to the UPL must be included in all copies or substantial
26+
portions of the Software.
27+
28+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29+
SOFTWARE.
30+
31+
Copyright (c) 2020, Oracle and/or its affiliates.
32+
Apache License
33+
34+
Version 2.0, January 2004
35+
36+
http://www.apache.org/licenses/
37+
38+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
39+
40+
1. Definitions.
41+
42+
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
43+
44+
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
45+
46+
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
47+
48+
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
49+
50+
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
51+
52+
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
53+
54+
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
55+
56+
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
57+
58+
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
59+
60+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
61+
62+
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
63+
64+
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
65+
66+
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
67+
• You must give any other recipients of the Work or Derivative Works a copy of this License; and
68+
• You must cause any modified files to carry prominent notices stating that You changed the files; and
69+
• You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
70+
• If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
71+
72+
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
73+
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
74+
75+
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
76+
77+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
78+
79+
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
80+
81+
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
82+
83+
END OF TERMS AND CONDITIONS

NOTICE.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Copyright (c) 2020, Oracle and/or its affiliates.

README-development.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Oracle Cloud Infrastructure SDK for TypeScript Development
2+
3+
## Getting Started
4+
5+
The following instructions assume that you have [typescript](https://www.npmjs.com/package/typescript) [node](https://nodejs.org) installed.
6+
7+
Now clone the repository to your machine:
8+
9+
```
10+
git clone https://github.com/oracle/oci-typescript-sdk.git
11+
cd oci-typescript-sdk
12+
```
13+
14+
### SDK Dependencies
15+
16+
```
17+
# npm install the dependencies
18+
npm install
19+
```
20+
21+
This will install all the dependencies of the SDK into your workspace.
22+
23+
### Building
24+
25+
```
26+
# compile the TypeScript files into JavaScript files
27+
npm run build
28+
```

README.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Oracle Cloud Infrastructure SDK for Typescript
2+
3+
[![wercker status](https://app.wercker.com/status/09bc4818e7b1d70b04285331a9bdbc41/s/master "wercker status")](https://app.wercker.com/project/byKey/09bc4818e7b1d70b04285331a9bdbc41)
4+
5+
This is Oracle Cloud Infrastructure SDK for TypeScript. This project is open source and maintained by Oracle Corp.
6+
The home page for the project is [Oracle Cloud Infrastructure SDK for TypeScript](https://github.com/oracle/oci-typescript-sdk/).
7+
8+
## Installing
9+
10+
Use the following command to install this SDK:
11+
12+
```
13+
npm install oci-sdk
14+
```
15+
16+
Alternatively you can git clone this repo.
17+
18+
## Working with the SDK for TypeScript
19+
20+
To start working with the SDK for TypeScript, you import the service package, create a client, and then use that client to make calls. [Refer to examples section](https://github.com/oracle/oci-typescript-sdk/tree/master/examples) for examples on how to make requests.
21+
22+
### Configuring
23+
24+
Before using the SDK, set up a config file with the required credentials. See [SDK and Tool Configuration](https://docs.cloud.oracle.com/Content/API/Concepts/sdkconfig.htm) for instructions.
25+
26+
## Organization of the SDK
27+
28+
The `oci-typescript-sdk` contains the following:
29+
30+
- **Service packages**: All packages except `common` and any other package found inside `lib`. These packages represent
31+
the Oracle Cloud Infrastructure services supported by the SDK for TypeScript. Each package represents a service.
32+
These packages include methods to interact with the service, structs that model
33+
input and output parameters, and a client struct that acts as receiver for the above methods.
34+
35+
- **Common package**: Found in the `common` directory. The common package provides supporting functions and structs used by service packages.
36+
Includes HTTP request/response (de)serialization, request signing, JSON parsing, pointer to reference and other helper functions. Most of the functions
37+
in this package are meant to be used by the service packages.
38+
39+
## Examples
40+
41+
Examples can be found [in the examples section](https://github.com/oracle/oci-typescript-sdk/tree/master/examples)
42+
43+
## Documentation
44+
45+
Full documentation can be found [on the typescript documentation site](https://docs.cloud.oracle.com/en-us/iaas/Content/API/SDKDocs/typescriptsdk.htm).
46+
47+
## Node & Browser Support
48+
49+
The SDK for TypeScript currently supports NodeJS but do not have browser support.
50+
51+
## Help
52+
53+
- The [Issues](https://github.com/oracle/oci-typescript-sdk/issues) page of this GitHub repository.
54+
- [Stack Overflow](https://stackoverflow.com/), use the [oracle-cloud-infrastructure](https://stackoverflow.com/questions/tagged/oracle-cloud-infrastructure) and [oci-typescript-sdk](https://stackoverflow.com/questions/tagged/oci-typescript-sdk) tags in your post.
55+
- [Developer Tools](https://community.oracle.com/community/cloud_computing/bare-metal/content?filterID=contentstatus%5Bpublished%5D~category%5Bdeveloper-tools%5D&filterID=contentstatus%5Bpublished%5D~objecttype~objecttype%5Bthread%5D) of the Oracle Cloud forums.
56+
- [My Oracle Support](https://support.oracle.com).
57+
58+
## Contributing
59+
60+
`oci-typescript-sdk` is an open source project. See [CONTRIBUTING](https://github.com/oracle/oci-typescript-sdk/tree/master/CONTRIBUTING.md) for details.
61+
62+
Oracle gratefully acknowledges the contributions to oci-typescript-sdk that have been made by the community.
63+
64+
## License
65+
66+
Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
67+
This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl
68+
or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
69+
70+
See [LICENSE](https://github.com/oracle/oci-typescript-sdk/tree/master/LICENSE.txt) for more details.
71+
72+
## Changes
73+
74+
See [CHANGELOG](https://github.com/oracle/oci-typescript-sdk/tree/master/CHANGELOG.md).
75+
76+
## Known Issues
77+
78+
You can find information on any known issues with the SDK at [Oracle Cloud Infrastructure Known Issues](https://docs.cloud.oracle.com/en-us/iaas/Content/knownissues.htm) and under the [Issues](https://github.com/oracle/oci-typescript-sdk/issues) tab of this project's GitHub repository.

0 commit comments

Comments
 (0)