hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta

data/lib/hellosign-ruby-sdk.rb

@@ -1,4 +1,200 @@
-# A wrapper that allows requiring via the Gemfile name ('hellosign-ruby-sdk')
-# This allows you to require either 'hello_sign' (unchanged) or 'hellosign-ruby-sdk' in your code
+=begin
+#HelloSign API
 
-require 'hello_sign'
+#HelloSign v3 API
+
+The version of the OpenAPI document: 3.0.0
+Contact: apisupport@hellosign.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.0
+
+=end
+
+# Common files
+require 'hellosign-ruby-sdk/api_client'
+require 'hellosign-ruby-sdk/api_error'
+require 'hellosign-ruby-sdk/version'
+require 'hellosign-ruby-sdk/configuration'
+
+# Models
+require 'hellosign-ruby-sdk/models/account_create_request'
+require 'hellosign-ruby-sdk/models/account_create_response'
+require 'hellosign-ruby-sdk/models/account_get_response'
+require 'hellosign-ruby-sdk/models/account_response'
+require 'hellosign-ruby-sdk/models/account_response_quotas'
+require 'hellosign-ruby-sdk/models/account_update_request'
+require 'hellosign-ruby-sdk/models/account_verify_request'
+require 'hellosign-ruby-sdk/models/account_verify_response'
+require 'hellosign-ruby-sdk/models/account_verify_response_account'
+require 'hellosign-ruby-sdk/models/api_app_create_request'
+require 'hellosign-ruby-sdk/models/api_app_get_response'
+require 'hellosign-ruby-sdk/models/api_app_list_response'
+require 'hellosign-ruby-sdk/models/api_app_response'
+require 'hellosign-ruby-sdk/models/api_app_response_o_auth'
+require 'hellosign-ruby-sdk/models/api_app_response_options'
+require 'hellosign-ruby-sdk/models/api_app_response_owner_account'
+require 'hellosign-ruby-sdk/models/api_app_response_white_labeling_options'
+require 'hellosign-ruby-sdk/models/api_app_update_request'
+require 'hellosign-ruby-sdk/models/bulk_send_job_get_response'
+require 'hellosign-ruby-sdk/models/bulk_send_job_get_response_signature_requests'
+require 'hellosign-ruby-sdk/models/bulk_send_job_list_response'
+require 'hellosign-ruby-sdk/models/bulk_send_job_response'
+require 'hellosign-ruby-sdk/models/bulk_send_job_send_response'
+require 'hellosign-ruby-sdk/models/embedded_edit_url_request'
+require 'hellosign-ruby-sdk/models/embedded_edit_url_response'
+require 'hellosign-ruby-sdk/models/embedded_edit_url_response_embedded'
+require 'hellosign-ruby-sdk/models/embedded_sign_url_response'
+require 'hellosign-ruby-sdk/models/embedded_sign_url_response_embedded'
+require 'hellosign-ruby-sdk/models/error_response'
+require 'hellosign-ruby-sdk/models/error_response_error'
+require 'hellosign-ruby-sdk/models/event_callback_account_request'
+require 'hellosign-ruby-sdk/models/event_callback_account_request_payload'
+require 'hellosign-ruby-sdk/models/event_callback_api_app_request'
+require 'hellosign-ruby-sdk/models/event_callback_api_app_request_payload'
+require 'hellosign-ruby-sdk/models/event_callback_request_event'
+require 'hellosign-ruby-sdk/models/event_callback_request_event_metadata'
+require 'hellosign-ruby-sdk/models/file_response'
+require 'hellosign-ruby-sdk/models/list_info_response'
+require 'hellosign-ruby-sdk/models/o_auth_token_generate_request'
+require 'hellosign-ruby-sdk/models/o_auth_token_refresh_request'
+require 'hellosign-ruby-sdk/models/o_auth_token_response'
+require 'hellosign-ruby-sdk/models/report_create_request'
+require 'hellosign-ruby-sdk/models/report_create_response'
+require 'hellosign-ruby-sdk/models/report_response'
+require 'hellosign-ruby-sdk/models/signature_request_bulk_create_embedded_with_template_request'
+require 'hellosign-ruby-sdk/models/signature_request_bulk_send_with_template_request'
+require 'hellosign-ruby-sdk/models/signature_request_create_embedded_request'
+require 'hellosign-ruby-sdk/models/signature_request_create_embedded_with_template_request'
+require 'hellosign-ruby-sdk/models/signature_request_get_response'
+require 'hellosign-ruby-sdk/models/signature_request_list_response'
+require 'hellosign-ruby-sdk/models/signature_request_remind_request'
+require 'hellosign-ruby-sdk/models/signature_request_response'
+require 'hellosign-ruby-sdk/models/signature_request_response_attachment'
+require 'hellosign-ruby-sdk/models/signature_request_response_custom_field_base'
+require 'hellosign-ruby-sdk/models/signature_request_response_custom_field_type_enum'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_base'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_type_enum'
+require 'hellosign-ruby-sdk/models/signature_request_response_signatures'
+require 'hellosign-ruby-sdk/models/signature_request_send_request'
+require 'hellosign-ruby-sdk/models/signature_request_send_with_template_request'
+require 'hellosign-ruby-sdk/models/signature_request_update_request'
+require 'hellosign-ruby-sdk/models/sub_attachment'
+require 'hellosign-ruby-sdk/models/sub_bulk_signer_list'
+require 'hellosign-ruby-sdk/models/sub_bulk_signer_list_custom_field'
+require 'hellosign-ruby-sdk/models/sub_cc'
+require 'hellosign-ruby-sdk/models/sub_custom_field'
+require 'hellosign-ruby-sdk/models/sub_editor_options'
+require 'hellosign-ruby-sdk/models/sub_field_options'
+require 'hellosign-ruby-sdk/models/sub_form_field_group'
+require 'hellosign-ruby-sdk/models/sub_form_field_rule'
+require 'hellosign-ruby-sdk/models/sub_form_field_rule_action'
+require 'hellosign-ruby-sdk/models/sub_form_field_rule_trigger'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_base'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_type_enum'
+require 'hellosign-ruby-sdk/models/sub_merge_field'
+require 'hellosign-ruby-sdk/models/sub_o_auth'
+require 'hellosign-ruby-sdk/models/sub_options'
+require 'hellosign-ruby-sdk/models/sub_signature_request_signer'
+require 'hellosign-ruby-sdk/models/sub_signature_request_template_signer'
+require 'hellosign-ruby-sdk/models/sub_signing_options'
+require 'hellosign-ruby-sdk/models/sub_team_response'
+require 'hellosign-ruby-sdk/models/sub_template_role'
+require 'hellosign-ruby-sdk/models/sub_unclaimed_draft_signer'
+require 'hellosign-ruby-sdk/models/sub_unclaimed_draft_template_signer'
+require 'hellosign-ruby-sdk/models/sub_white_labeling_options'
+require 'hellosign-ruby-sdk/models/team_add_member_request'
+require 'hellosign-ruby-sdk/models/team_create_request'
+require 'hellosign-ruby-sdk/models/team_get_info_response'
+require 'hellosign-ruby-sdk/models/team_get_response'
+require 'hellosign-ruby-sdk/models/team_info_response'
+require 'hellosign-ruby-sdk/models/team_member_response'
+require 'hellosign-ruby-sdk/models/team_members_response'
+require 'hellosign-ruby-sdk/models/team_parent_response'
+require 'hellosign-ruby-sdk/models/team_remove_member_request'
+require 'hellosign-ruby-sdk/models/team_response'
+require 'hellosign-ruby-sdk/models/team_sub_teams_response'
+require 'hellosign-ruby-sdk/models/team_update_request'
+require 'hellosign-ruby-sdk/models/template_add_user_request'
+require 'hellosign-ruby-sdk/models/template_create_embedded_draft_request'
+require 'hellosign-ruby-sdk/models/template_create_embedded_draft_response'
+require 'hellosign-ruby-sdk/models/template_create_embedded_draft_response_template'
+require 'hellosign-ruby-sdk/models/template_edit_response'
+require 'hellosign-ruby-sdk/models/template_get_response'
+require 'hellosign-ruby-sdk/models/template_list_response'
+require 'hellosign-ruby-sdk/models/template_remove_user_request'
+require 'hellosign-ruby-sdk/models/template_response'
+require 'hellosign-ruby-sdk/models/template_response_account'
+require 'hellosign-ruby-sdk/models/template_response_account_quota'
+require 'hellosign-ruby-sdk/models/template_response_cc_role'
+require 'hellosign-ruby-sdk/models/template_response_custom_field'
+require 'hellosign-ruby-sdk/models/template_response_document'
+require 'hellosign-ruby-sdk/models/template_response_document_custom_field'
+require 'hellosign-ruby-sdk/models/template_response_document_field_group'
+require 'hellosign-ruby-sdk/models/template_response_document_form_field'
+require 'hellosign-ruby-sdk/models/template_response_document_static_field'
+require 'hellosign-ruby-sdk/models/template_response_field_avg_text_length'
+require 'hellosign-ruby-sdk/models/template_response_named_form_field'
+require 'hellosign-ruby-sdk/models/template_response_signer_role'
+require 'hellosign-ruby-sdk/models/template_update_files_request'
+require 'hellosign-ruby-sdk/models/template_update_files_response'
+require 'hellosign-ruby-sdk/models/template_update_files_response_template'
+require 'hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_request'
+require 'hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_with_template_request'
+require 'hellosign-ruby-sdk/models/unclaimed_draft_create_request'
+require 'hellosign-ruby-sdk/models/unclaimed_draft_create_response'
+require 'hellosign-ruby-sdk/models/unclaimed_draft_edit_and_resend_request'
+require 'hellosign-ruby-sdk/models/unclaimed_draft_response'
+require 'hellosign-ruby-sdk/models/warning_response'
+require 'hellosign-ruby-sdk/models/signature_request_response_custom_field_checkbox'
+require 'hellosign-ruby-sdk/models/signature_request_response_custom_field_text'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox_merge'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_date_signed'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_dropdown'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_initials'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_radio'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_signature'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_text'
+require 'hellosign-ruby-sdk/models/signature_request_response_data_value_text_merge'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox_merge'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_date_signed'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_dropdown'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_hyperlink'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_initials'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_radio'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_signature'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_text'
+require 'hellosign-ruby-sdk/models/sub_form_fields_per_document_text_merge'
+
+# APIs
+require 'hellosign-ruby-sdk/api/account_api'
+require 'hellosign-ruby-sdk/api/api_app_api'
+require 'hellosign-ruby-sdk/api/bulk_send_job_api'
+require 'hellosign-ruby-sdk/api/embedded_api'
+require 'hellosign-ruby-sdk/api/o_auth_api'
+require 'hellosign-ruby-sdk/api/report_api'
+require 'hellosign-ruby-sdk/api/signature_request_api'
+require 'hellosign-ruby-sdk/api/team_api'
+require 'hellosign-ruby-sdk/api/template_api'
+require 'hellosign-ruby-sdk/api/unclaimed_draft_api'
+
+require 'hellosign-ruby-sdk/event_callback_helper'
+
+module HelloSign
+  class << self
+    # Customize default settings for the SDK using block.
+    #   HelloSign.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/oas/.editorconfig

@@ -0,0 +1,6 @@
+[{*.html,*.md,*.json,*.css,*.yml,*.yaml}]
+indent_style = space
+indent_size = 2
+
+[{*.java,*.php}]
+indent_size = 4

data/oas/.git

@@ -0,0 +1 @@
+gitdir: ../.git/modules/oas

data/oas/.github/workflows/github-actions.yml

@@ -0,0 +1,79 @@
+on: [push]
+jobs:
+  trigger-php-sdk-build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Invoke downstream workflow
+      uses: convictional/trigger-workflow-and-wait@v1.6.1
+      with:
+        owner: hellosign
+        repo: hellosign-php-sdk
+        workflow_file_name: github-actions.yml
+        github_token: ${{ secrets.PERSONAL_TOKEN }}
+        ref: openapi
+        client_payload: '{"branch_name": "${{ github.ref_name }}"}'
+
+  trigger-python-sdk-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Invoke downstream workflow
+        uses: convictional/trigger-workflow-and-wait@v1.6.1
+        with:
+          owner: hellosign
+          repo: hellosign-python-sdk
+          workflow_file_name: github-actions.yml
+          github_token: ${{ secrets.PERSONAL_TOKEN }}
+          ref: openapi
+          client_payload: '{"branch_name": "${{ github.ref_name }}"}'
+
+  trigger-ruby-sdk-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Invoke downstream workflow
+        uses: convictional/trigger-workflow-and-wait@v1.6.1
+        with:
+          owner: HelloFax
+          repo: hellosign-ruby-sdk
+          workflow_file_name: github-actions.yml
+          github_token: ${{ secrets.PERSONAL_TOKEN }}
+          ref: openapi
+          client_payload: '{"branch_name": "${{ github.ref_name }}"}'
+
+  trigger-nodejs-sdk-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Invoke downstream workflow
+        uses: convictional/trigger-workflow-and-wait@v1.6.1
+        with:
+          owner: HelloFax
+          repo: hellosign-nodejs-sdk
+          workflow_file_name: github-actions.yml
+          github_token: ${{ secrets.PERSONAL_TOKEN }}
+          ref: openapi
+          client_payload: '{"branch_name": "${{ github.ref_name }}"}'
+
+  trigger-java-sdk-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Invoke downstream workflow
+        uses: convictional/trigger-workflow-and-wait@v1.6.1
+        with:
+          owner: hellosign
+          repo: hellosign-java-sdk
+          workflow_file_name: github-actions.yml
+          github_token: ${{ secrets.PERSONAL_TOKEN }}
+          ref: openapi
+          client_payload: '{"branch_name": "${{ github.ref_name }}"}'
+
+  trigger-dotnet-sdk-build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Invoke downstream workflow
+        uses: convictional/trigger-workflow-and-wait@v1.6.1
+        with:
+          owner: hellosign
+          repo: hellosign-dotnet-sdk
+          workflow_file_name: github-actions.yml
+          github_token: ${{ secrets.PERSONAL_TOKEN }}
+          ref: openapi
+          client_payload: '{"branch_name": "${{ github.ref_name }}"}'

data/oas/.gitignore

@@ -0,0 +1,2 @@
+vendor
+.idea

data/oas/.redocly.lint-ignore.yaml

@@ -0,0 +1,5 @@
+# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
+# See https://redoc.ly/docs/cli/ for more information.
+openapi.yaml:
+  path-not-include-query:
+    - '#/paths/~1oauth~1token?refresh'

data/oas/.redocly.yaml

@@ -0,0 +1,11 @@
+# Need some of this config because we're using API Registry
+apiDefinitions: 
+  hellosign: ./openapi.yaml
+
+lint:
+  plugins:
+    - 'bin/plugins/set-beta-plugin.js'
+  extends:
+    - recommended
+  decorators:
+    hs-beta-fields/check-schema-for-beta-features: error

data/oas/LICENSE

@@ -0,0 +1,68 @@
+Copyright (c) 2022 Dropbox, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"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.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"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.
+
+"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).
+
+"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.
+
+"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."
+
+"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.
+
+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.
+
+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.
+
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+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
+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. 
+
+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.
+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.
+
+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.
+
+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.
+
+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.
+
+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.
+
+END OF TERMS AND CONDITIONS

data/oas/README.md

@@ -0,0 +1,107 @@
+# hellosign-openapi · [![License for GitHub](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/hellosign/hellosign-openapi/blob/main/LICENSE) [![OpenAPI badge](https://img.shields.io/badge/openapi-v3.0.3-orange)](https://spec.openapis.org/oas/v3.0.1) [![PRs and Issues](https://img.shields.io/badge/prs%20&%20issues-Welcome-brightgreen)](#contributing)
+
+This repository contains all source material used for HelloSign's [API Reference Documentation](https://developers.hellosign.com/api/reference/overview/) and official SDKs (work in progress, currently in beta). The docs and SDKs are both powered by the [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml), which also keeps them in sync with our API development.  
+
+This repo is actively maintained by HelloSign's API Engineering team, but you can help us improve these resources for everyone by [contributing](#contributing).
+
+## ⚠ Important: work in progress ⚠
+
+The state of tooling based on this repo:
+- HelloSign's [API reference documentation](https://developers.hellosign.com/api/reference/overview/) - launched in production.
+- HelloSign [SDKs](#sdk-coverage) - available in beta only. See the "openapi" branch of your preferred SDK.
+
+Warnings:
+- Think twice before using the OpenAPI-powered SDKs for anything critical.
+- The interfaces may change without warning. Backwards compatibility is not yet guaranteed nor implied.
+
+## Overview
+
+HelloSign's [API Reference Documentation](https://developers.hellosign.com/api/reference/overview/) is built using [openapi.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml) and the SDKs are built using [openapi-sdk.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/openapi-sdk.yaml). Both of those files are **generated** as part of a build process. 
+These are the main parts of this repo you'll need to know about:
+- [openapi-raw.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/openapi-raw.yaml) -- The functional implementation of the HelloSign API as an OpenAPI spec. This file reflects all public-facing work from HelloSign's API Engineering team and is kept up-to-date.
+- [en.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/translations/en.yaml) -- Contains all copy used for the API reference documentation. That includes descriptions for endpoints, parameters, schemas, and more. 
+- [/json](https://github.com/hellosign/hellosign-openapi/tree/main/examples/json) -- Contains example request and response payloads for the HelloSign API.
+- [/examples](https://github.com/hellosign/hellosign-openapi/tree/main/examples) -- Contains SDK-specific example requests for each endpoint.
+
+**Note:** Our API reference documentation supports having multiple examples for requests, responses, and SDK implementations for every endpoint. But we need your help to get there! Contributions that help us grow our example coverage are highly valuable at this stage.
+
+## Contributing
+
+We accept contributions and feedback that help us provide a better a developer experience for users of the HelloSign API. Our OpenAPI-based tooling relies on multiple build processes, so we offer the following guidelines around contributing:
+
+### SDKs
+All SDK-specific feedback or requests around functionality should be submitted as an Issue in that [SDK's](#sdk-coverage) respective repo. However, SDK-specific code examples should be submitted as a Pull Request to this repo. 
+
+### Issues
+Use GitHub issues to report problems or gaps in our documentation, request sample coverage for a specific API feature, or ask for an update to an endpoint description that you think needs attention. Any feedback that will help us create a better experience in our documentation is appreciated. 
+
+### Pull Requests
+We welcome pull requests with enhancements to copy or examples in our API reference documentation. Please follow the [development flow](#development-flow-for-contributors) for submitting PRs. The table below contains information about the types of pull requests we're able to support:
+
+| Type of PR  | File(s) to change | Merge requirements |
+| ------------- | ------------- | ------------- |
+| Changes to existing code examples | <ul><li>Req/res payloads: [/examples/json](https://github.com/hellosign/hellosign-openapi/tree/main/examples/json)</li><li>SDK requests: [/examples](https://github.com/hellosign/hellosign-openapi/tree/main/examples)</li></ul> | No local build process needed before PR |
+| Adding *new* code examples | <ul><li>Req/res payloads: [/examples/json](https://github.com/hellosign/hellosign-openapi/tree/main/examples/json)</li><li>SDK requests: [/examples](https://github.com/hellosign/hellosign-openapi/tree/main/examples)</li><li>OAS: [openapi-raw.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/openapi-raw.yaml) </li></ul>| User must manually add reference to new examples in the `openapi-raw.yaml` file then [generate new OpenAPI spec](#development-flow-for-contributors) before submitting PR |
+| Copy changes: descriptions for endpoints, parameters, schemas, or properties | [/translations/en.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/translations/en.yaml) | User must [generate new OpenAPI spec](#development-flow-for-contributors) before submitting PR |
+
+## License
+This repo is published under the Apache 2.0 license. Please see [LICENSE](https://github.com/hellosign/hellosign-api/blob/main/LICENSE) for more information.
+
+## Thank you
+There's a wide world of APIs out there and we (HelloSign's API Engineering team) wanted to thank you for using ours. We've been working hard to improve our developer experience and have some big releases planned for this year (2022). We look forward to showing you that your trust is well placed. 
+
+# Appendix 
+Additional information about this repo, OpenAPI, and/or related tooling. May not be sequential.
+
+## Migrating to OpenAPI
+The API Engineering team at HelloSign adopted the [OpenAPI specification](https://oai.github.io/Documentation/introduction.html) in order to provide a better experience to HelloSign developers in a way that was scalable and sustainable. We're using it as the source of our [API Reference Documentation](https://developers.hellosign.com/api/reference/overview/) and [SDKs](#sdk-coverage), which means both tools stay in total parity with the HelloSign API. 
+
+## Architectural Overview 
+We've made multiple references to build systems throughout this repo. So let's take a step back to examine how the different pieces fit together to make this setup possible. 
+
+**HelloSign API to Raw OpenAPI Spec**  
+
+When a new feature is added or a change is made to the HelloSign API, a new `openapi-raw.yaml` file is created in the hellosign-openapi repo. This file contains the final _structure_ of our OpenAPI spec, but the strings are placeholders (see [translations](#translations)).  
+
+**Strings and Samples**  
+
+This repo (hellosign-openapi) contains _all_ copy and examples used in [HelloSign's API reference documentation](https://developers.hellosign.com/api/reference/overview/). These resources are maintained separately from the OpenAPI spec's structure and can be improved by anyone willing to [contribute](#contributing).  
+
+**Generating the OpenAPI Spec**  
+
+When the build script in this repo runs (`./build`), the placeholder strings in `openapi-raw.yaml` file are replaced by the values in [en.yaml](https://github.com/hellosign/hellosign-openapi/blob/main/translations/en.yaml) to generate the `openapi.yaml` and `openapi-sdk.yaml` files.  
+
+**OpenAPI to Documentation**  
+
+When a new `openapi.yaml` file is pushed to the main branch of this repo, HelloSign's developer documentation is automatically rebuilt. During that process, the external references inside `openapi.yaml` resolve to their corresponding [examples](https://github.com/hellosign/hellosign-openapi/tree/main/examples) in the documentation.  
+
+**OpenAPI to SDKs**. 
+
+Each respective SDK has it's own repository where the hellosign-openapi repo serves as a submodule. When the `./build` script runs in the SDK's repo, the `openapi-sdk.yaml` file is used to generate a new SDK. The SDKs are currently in beta, but we intend to automate the build process as test coverage grows and we're able to rebuild with minimal risk. 
+
+## SDK Coverage  
+
+The SDKs based on our OpenAPI spec are a work in progress and none have moved past beta quite yet. They're currently available as an "openapi" branch in each respective repo.
+
+| Link to SDK | Status |
+| --- | --- |
+| [NodeJS](https://github.com/HelloFax/hellosign-nodejs-sdk) | [![beta badge](https://img.shields.io/badge/status-beta-red)](https://github.com/HelloFax/hellosign-nodejs-sdk) |
+| [PHP](https://github.com/hellosign/hellosign-php-sdk/tree/openapi) | [![beta badge](https://img.shields.io/badge/status-beta-red)](https://github.com/hellosign/hellosign-php-sdk/tree/openapi) |
+| C# [dotnet](https://github.com/hellosign/hellosign-dotnet-sdk/tree/openapi) | [![beta badge](https://img.shields.io/badge/status-beta-red)](https://github.com/hellosign/hellosign-dotnet-sdk/tree/openapi) |
+| [Python](https://github.com/hellosign/hellosign-python-sdk/tree/openapi) | [![beta badge](https://img.shields.io/badge/status-beta-red)](https://github.com/hellosign/hellosign-python-sdk/tree/openapi) |
+| [Ruby](https://github.com/HelloFax/hellosign-ruby-sdk) | [![beta badge](https://img.shields.io/badge/status-beta-red)](https://github.com/HelloFax/hellosign-ruby-sdk) |
+| [Java](https://github.com/hellosign/hellosign-java-sdk/tree/openapi) | [![beta badge](https://img.shields.io/badge/status-beta-red)](https://github.com/hellosign/hellosign-java-sdk/tree/openapi) |
+
+**Note:** You can help us accelerate the launch of an SDK by being an early adopter. Please jump right in and start using it, then open an Issue in that SDK's GitHub repo when you find something that needs to be fixed. 
+
+## Development Flow for Contributors
+
+1. Clone repo and create branch with unique name (i.e. `sig-request-java-sample`).
+2. Make change to copy or code samples.
+3. Run build script with `./build`*.
+4. [Optional] Preview API reference locally by running `openapi preview-docs openapi.yaml`. This requires the [Redocly CLI](https://redocly.com/docs/cli/).
+5. Push branch and create pull request. A preview build will automatically complete in ~5 minutes. 
+6. Your PR will be reviewed and processed by the API team. 
+
+*You'll need Docker running locally to run the build script.
+

data/oas/bin/generate-sdk-oas.php

@@ -0,0 +1,75 @@
+#!/usr/bin/env php
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Hello\OpenApi\RawFile;
+use Symfony\Component\Yaml\Yaml;
+
+ini_set('display_errors', 1);
+ini_set('display_startup_errors', 1);
+error_reporting(E_ALL);
+
+set_error_handler(function ($level, $msg) {
+    echo "Error: {$msg}";
+    exit(1);
+});
+
+class GenerateSdkOas
+{
+    private const SURFACE_ID = 'sdk';
+
+    /**
+     * Contains the OpenAPI spec, in array form
+     *
+     * @var array
+     */
+    protected array $openapi;
+
+    public function run(): void
+    {
+        $raw_file = new RawFile(__DIR__ . '/../openapi-raw.yaml');
+        $translation_file = __DIR__ . '/../translations/en.yaml';
+        $this->openapi = $raw_file->translate(
+            self::SURFACE_ID,
+            $translation_file,
+            $translation_file
+        );
+        $this->remove();
+        $this->saveOpenAPIFile();
+    }
+
+    protected function remove(): void
+    {
+        unset($this->openapi['tags']);
+    }
+
+    /**
+     * Takes the translated OpenAPI data and saves it to language-specific
+     * YAML file
+     */
+    protected function saveOpenAPIFile(): void
+    {
+        $file = __DIR__ . '/../openapi-sdk.yaml';
+
+        $yaml = Yaml::dump(
+            $this->openapi,
+            10,
+            2,
+            Yaml::DUMP_OBJECT_AS_MAP
+            ^ Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE
+            ^ Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK
+        );
+
+        // An empty JSON response of `{}` can't be represented as a PHP array
+        $yaml = str_replace('value: []', 'value: {}', $yaml);
+        $yaml = str_replace('metadata: []', 'metadata: {}', $yaml);
+        $yaml = str_replace('additionalProperties: []', 'additionalProperties: {}', $yaml);
+        $yaml = str_replace('application/json: []', 'application/json: {}', $yaml);
+
+        file_put_contents($file, $yaml);
+    }
+}
+
+$generate = new GenerateSdkOas();
+$generate->run();