dropbox-sign 1.0.0.pre.beta2301 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b162ad2b35753ad7b7d5990f3d5d1e212af25ede33c4f0aca2eae13c0490d34
-  data.tar.gz: e65432eebd4f3baa8131e3b2e37eb75c559d5487b586c78cc9ec7ec935cbbbf3
+  metadata.gz: a00ffe37b1c97e9977cfeaa6f04b676720cad031f3b0bd764be2db025cc1c3a1
+  data.tar.gz: 10f96f7af1b7a26f125d86e9ced22ac0db87c3f78311275353dd688dc42cdbe6
 SHA512:
-  metadata.gz: 3cdf1579d3fcecf69af52bc66f3a2681f297b675c0dfeaedc906cc253436b7af177a90cc3b54c552a960221ecde576b928efb840d99baf61f53c939050a616e7
-  data.tar.gz: 7f7c81cdb0b600fafe69baa4d8287e687152691dd733c0f179e887a95b741512d02cf8949e9805ba064de039f0a91eac372902dfa0120bcc4dd5b03c1002db79
+  metadata.gz: 664ca8924e0707330f433760cfc76188d3a8fe3919310508a271d2004ce05b227d3cca8295f12885f9a4087381cfcc11f8a4e2f8e51babd0abfc1bb1a3b6267e
+  data.tar.gz: 99f8508768449c93a8243f435fcdd72f1f223d482b4bbad3c0ffbade2bad7d82a2d6a7fb9a097f6cde1ee67eabbc56636ec511beac224b36bc036ddb76d94629

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropbox-sign (1.0.0.pre.beta2301)
+    dropbox-sign (1.0.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -6,7 +6,7 @@ Dropbox Sign v3 API
 
 ## Migrating from legacy SDK
 
-This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/development/openapi.yaml).
+This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml).
 We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK.
 However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK.
 Please refer to this [migration guide](https://developers.hellosign.com/docs/sdks/ruby/migration-guide/) for more information.
@@ -25,14 +25,14 @@ directory that corresponds to the file you want updated.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 3.0.0
-- Package version: 1.0.0-beta2301
+- Package version: 1.0.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
 
 ### Install gem
 ```shell
-gem install dropbox-sign --pre
+gem install dropbox-sign
 ```
 
 ### Build a gem
@@ -43,19 +43,17 @@ To build the Ruby code into a gem:
 gem build dropbox-sign.gemspec
 ```
 
-Then either install the gem locally:
+Then install the gem locally:
 
 ```shell
-gem install ./dropbox-sign-1.0.0-beta2301.gem
+gem install ./dropbox-sign-1.0.0.gem
 ```
 
-(for development, run `gem install --dev ./dropbox-sign-1.0.0-beta2301.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+(for development, run `gem install --dev ./dropbox-sign-1.0.0.gem` to install the development dependencies)
 
 Finally add this to the Gemfile:
 
-    gem 'dropbox-sign', '~> 1.0.0-beta2301'
+    gem 'dropbox-sign', '~> 1.0.0'
 
 ### Install from Git
 

data/bin/check-clean-git-status

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+if [[ $(git status --porcelain) != '' ]]; then
+  printf "Working directory is dirty.\n";
+  printf "Please check that you committed any changes after running.\n"
+  printf "You may need to rebuild the SDK by running:\n";
+  printf "\t./run-build\n"
+
+  git status
+
+  exit 1
+else
+  echo "Working directory is clean!"
+  exit 0
+fi

data/examples/EventCallback.rb

@@ -18,10 +18,7 @@ callback_data = {
   },
 }
 
-callback_event = Dropbox::Sign::ApiClient.new.convert_to_type(
-  callback_data,
-  "Dropbox::Sign::EventCallbackRequest"
-) || Dropbox::Sign::EventCallbackRequest.new
+callback_event = Dropbox::Sign::EventCallbackRequest.init(callback_data)
 
 # verify that a callback came from HelloSign.com
 if Dropbox::Sign::EventCallbackHelper.is_valid(api_key, callback_event)

data/lib/dropbox-sign/models/account_create_request.rb

@@ -19,15 +19,19 @@ end
 module Dropbox::Sign
   class AccountCreateRequest
     # The email address which will be associated with the new Account.
+    # @return [String]
     attr_accessor :email_address
 
     # Used when creating a new account with OAuth authorization.  See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
+    # @return [String]
     attr_accessor :client_id
 
     # Used when creating a new account with OAuth authorization.  See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
+    # @return [String]
     attr_accessor :client_secret
 
     # The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
+    # @return [String]
     attr_accessor :locale
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_create_response.rb

@@ -18,11 +18,14 @@ end
 
 module Dropbox::Sign
   class AccountCreateResponse
+    # @return [AccountResponse]
     attr_accessor :account
 
+    # @return [OAuthTokenResponse]
     attr_accessor :oauth_data
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_get_response.rb

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class AccountGetResponse
+    # @return [AccountResponse]
     attr_accessor :account
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_response.rb

@@ -19,32 +19,42 @@ end
 module Dropbox::Sign
   class AccountResponse
     # The ID of the Account
+    # @return [String]
     attr_accessor :account_id
 
     # The email address associated with the Account.
+    # @return [String]
     attr_accessor :email_address
 
     # Returns `true` if the user has been locked out of their account by a team admin.
+    # @return [Boolean]
     attr_accessor :is_locked
 
     # Returns `true` if the user has a paid Dropbox Sign account.
+    # @return [Boolean]
     attr_accessor :is_paid_hs
 
     # Returns `true` if the user has a paid HelloFax account.
+    # @return [Boolean]
     attr_accessor :is_paid_hf
 
+    # @return [AccountResponseQuotas]
     attr_accessor :quotas
 
     # The URL that Dropbox Sign events will `POST` to.
+    # @return [String, nil]
     attr_accessor :callback_url
 
     # The membership role for the team.
+    # @return [String, nil]
     attr_accessor :role_code
 
     # The id of the team account belongs to.
+    # @return [String, nil]
     attr_accessor :team_id
 
     # The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
+    # @return [String, nil]
     attr_accessor :locale
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_response_quotas.rb

@@ -20,18 +20,23 @@ module Dropbox::Sign
   # Details concerning remaining monthly quotas.
   class AccountResponseQuotas
     # API signature requests remaining.
+    # @return [Integer, nil]
     attr_accessor :api_signature_requests_left
 
     # Signature requests remaining.
+    # @return [Integer, nil]
     attr_accessor :documents_left
 
     # Total API templates allowed.
+    # @return [Integer, nil]
     attr_accessor :templates_total
 
     # API templates remaining.
+    # @return [Integer, nil]
     attr_accessor :templates_left
 
     # SMS verifications  remaining.
+    # @return [Integer, nil]
     attr_accessor :sms_verifications_left
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_update_request.rb

@@ -19,12 +19,15 @@ end
 module Dropbox::Sign
   class AccountUpdateRequest
     # The ID of the Account
+    # @return [String, nil]
     attr_accessor :account_id
 
     # The URL that Dropbox Sign should POST events to.
+    # @return [String]
     attr_accessor :callback_url
 
     # The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
+    # @return [String]
     attr_accessor :locale
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_verify_request.rb

@@ -19,6 +19,7 @@ end
 module Dropbox::Sign
   class AccountVerifyRequest
     # Email address to run the verification for.
+    # @return [String]
     attr_accessor :email_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_verify_response.rb

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class AccountVerifyResponse
+    # @return [AccountVerifyResponseAccount]
     attr_accessor :account
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/account_verify_response_account.rb

@@ -19,6 +19,7 @@ end
 module Dropbox::Sign
   class AccountVerifyResponseAccount
     # The email address associated with the Account.
+    # @return [String]
     attr_accessor :email_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_create_request.rb

@@ -19,21 +19,28 @@ end
 module Dropbox::Sign
   class ApiAppCreateRequest
     # The domain names the ApiApp will be associated with.
+    # @return [Array<String>]
     attr_accessor :domains
 
     # The name you want to assign to the ApiApp.
+    # @return [String]
     attr_accessor :name
 
     # The URL at which the ApiApp should receive event callbacks.
+    # @return [String]
     attr_accessor :callback_url
 
     # An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
+    # @return [File]
     attr_accessor :custom_logo_file
 
+    # @return [SubOAuth]
     attr_accessor :oauth
 
+    # @return [SubOptions]
     attr_accessor :options
 
+    # @return [SubWhiteLabelingOptions]
     attr_accessor :white_labeling_options
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_get_response.rb

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class ApiAppGetResponse
+    # @return [ApiAppResponse]
     attr_accessor :api_app
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_list_response.rb

@@ -19,11 +19,14 @@ end
 module Dropbox::Sign
   class ApiAppListResponse
     # Contains information about API Apps.
+    # @return [Array<ApiAppResponse>]
     attr_accessor :api_apps
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_response.rb

@@ -20,29 +20,39 @@ module Dropbox::Sign
   # Contains information about an API App.
   class ApiAppResponse
     # The app's callback URL (for events)
+    # @return [String, nil]
     attr_accessor :callback_url
 
     # The app's client id
+    # @return [String]
     attr_accessor :client_id
 
     # The time that the app was created
+    # @return [Integer]
     attr_accessor :created_at
 
     # The domain name(s) associated with the app
+    # @return [Array<String>]
     attr_accessor :domains
 
     # The name of the app
+    # @return [String]
     attr_accessor :name
 
     # Boolean to indicate if the app has been approved
+    # @return [Boolean]
     attr_accessor :is_approved
 
+    # @return [ApiAppResponseOAuth, nil]
     attr_accessor :oauth
 
+    # @return [ApiAppResponseOptions, nil]
     attr_accessor :options
 
+    # @return [ApiAppResponseOwnerAccount]
     attr_accessor :owner_account
 
+    # @return [ApiAppResponseWhiteLabelingOptions, nil]
     attr_accessor :white_labeling_options
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_response_o_auth.rb

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
   class ApiAppResponseOAuth
     # The app's OAuth callback URL.
+    # @return [String]
     attr_accessor :callback_url
 
     # The app's OAuth secret, or null if the app does not belong to user.
+    # @return [String]
     attr_accessor :secret
 
     # Array of OAuth scopes used by the app.
+    # @return [Array<String>]
     attr_accessor :scopes
 
     # Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.
+    # @return [Boolean]
     attr_accessor :charges_users
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_response_options.rb

@@ -20,6 +20,7 @@ module Dropbox::Sign
   # An object with options that override account settings.
   class ApiAppResponseOptions
     # Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document
+    # @return [Boolean]
     attr_accessor :can_insert_everywhere
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_response_owner_account.rb

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # An object describing the app's owner
   class ApiAppResponseOwnerAccount
     # The owner account's ID
+    # @return [String]
     attr_accessor :account_id
 
     # The owner account's email address
+    # @return [String]
     attr_accessor :email_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb

@@ -19,32 +19,46 @@ end
 module Dropbox::Sign
   # An object with options to customize the app's signer page
   class ApiAppResponseWhiteLabelingOptions
+    # @return [String]
     attr_accessor :header_background_color
 
+    # @return [String]
     attr_accessor :legal_version
 
+    # @return [String]
     attr_accessor :link_color
 
+    # @return [String]
     attr_accessor :page_background_color
 
+    # @return [String]
     attr_accessor :primary_button_color
 
+    # @return [String]
     attr_accessor :primary_button_color_hover
 
+    # @return [String]
     attr_accessor :primary_button_text_color
 
+    # @return [String]
     attr_accessor :primary_button_text_color_hover
 
+    # @return [String]
     attr_accessor :secondary_button_color
 
+    # @return [String]
     attr_accessor :secondary_button_color_hover
 
+    # @return [String]
     attr_accessor :secondary_button_text_color
 
+    # @return [String]
     attr_accessor :secondary_button_text_color_hover
 
+    # @return [String]
     attr_accessor :text_color1
 
+    # @return [String]
     attr_accessor :text_color2
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/api_app_update_request.rb

@@ -19,21 +19,28 @@ end
 module Dropbox::Sign
   class ApiAppUpdateRequest
     # The URL at which the API App should receive event callbacks.
+    # @return [String]
     attr_accessor :callback_url
 
     # An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
+    # @return [File]
     attr_accessor :custom_logo_file
 
     # The domain names the ApiApp will be associated with.
+    # @return [Array<String>]
     attr_accessor :domains
 
     # The name you want to assign to the ApiApp.
+    # @return [String]
     attr_accessor :name
 
+    # @return [SubOAuth]
     attr_accessor :oauth
 
+    # @return [SubOptions]
     attr_accessor :options
 
+    # @return [SubWhiteLabelingOptions]
     attr_accessor :white_labeling_options
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/bulk_send_job_get_response.rb

@@ -18,14 +18,18 @@ end
 
 module Dropbox::Sign
   class BulkSendJobGetResponse
+    # @return [BulkSendJobResponse]
     attr_accessor :bulk_send_job
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
     # Contains information about the Signature Requests sent in bulk.
+    # @return [Array<BulkSendJobGetResponseSignatureRequests>]
     attr_accessor :signature_requests
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb

@@ -19,75 +19,99 @@ end
 module Dropbox::Sign
   class BulkSendJobGetResponseSignatureRequests
     # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
+    # @return [Boolean, nil]
     attr_accessor :test_mode
 
     # The id of the SignatureRequest.
+    # @return [String]
     attr_accessor :signature_request_id
 
     # The email address of the initiator of the SignatureRequest.
+    # @return [String]
     attr_accessor :requester_email_address
 
     # The title the specified Account uses for the SignatureRequest.
+    # @return [String]
     attr_accessor :title
 
     # Default Label for account.
+    # @return [String]
     attr_accessor :original_title
 
     # The subject in the email that was initially sent to the signers.
+    # @return [String, nil]
     attr_accessor :subject
 
     # The custom message in the email that was initially sent to the signers.
+    # @return [String, nil]
     attr_accessor :message
 
     # The metadata attached to the signature request.
+    # @return [Object]
     attr_accessor :metadata
 
     # Time the signature request was created.
+    # @return [Integer]
     attr_accessor :created_at
 
     # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # Whether or not the SignatureRequest has been fully executed by all signers.
+    # @return [Boolean]
     attr_accessor :is_complete
 
     # Whether or not the SignatureRequest has been declined by a signer.
+    # @return [Boolean]
     attr_accessor :is_declined
 
     # Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
+    # @return [Boolean]
     attr_accessor :has_error
 
     # The URL where a copy of the request's documents can be downloaded.
+    # @return [String]
     attr_accessor :files_url
 
     # The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.
+    # @return [String, nil]
     attr_accessor :signing_url
 
     # The URL where the requester and the signers can view the current status of the SignatureRequest.
+    # @return [String]
     attr_accessor :details_url
 
     # A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
+    # @return [Array<String>]
     attr_accessor :cc_email_addresses
 
     # The URL you want the signer redirected to after they successfully sign.
+    # @return [String, nil]
     attr_accessor :signing_redirect_url
 
     # Templates IDs used in this SignatureRequest (if any).
+    # @return [Array<String>, nil]
     attr_accessor :template_ids
 
     # An array of Custom Field objects containing the name and type of each custom field.  * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
+    # @return [Array<SignatureRequestResponseCustomFieldBase>, nil]
     attr_accessor :custom_fields
 
     # Signer attachments.
+    # @return [Array<SignatureRequestResponseAttachment>, nil]
     attr_accessor :attachments
 
     # An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
+    # @return [Array<SignatureRequestResponseDataBase>, nil]
     attr_accessor :response_data
 
     # An array of signature objects, 1 for each signer.
+    # @return [Array<SignatureRequestResponseSignatures>]
     attr_accessor :signatures
 
     # The id of the BulkSendJob.
+    # @return [String]
     attr_accessor :bulk_send_job_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/bulk_send_job_list_response.rb

@@ -19,11 +19,14 @@ end
 module Dropbox::Sign
   class BulkSendJobListResponse
     # Contains a list of BulkSendJobs that the API caller has access to.
+    # @return [Array<BulkSendJobResponse>]
     attr_accessor :bulk_send_jobs
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/bulk_send_job_response.rb

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
   class BulkSendJobResponse
     # The id of the BulkSendJob.
+    # @return [String, nil]
     attr_accessor :bulk_send_job_id
 
     # The total amount of Signature Requests queued for sending.
+    # @return [Integer]
     attr_accessor :total
 
     # True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.
+    # @return [Boolean]
     attr_accessor :is_creator
 
     # Time that the BulkSendJob was created.
+    # @return [Integer]
     attr_accessor :created_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/bulk_send_job_send_response.rb

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class BulkSendJobSendResponse
+    # @return [BulkSendJobResponse]
     attr_accessor :bulk_send_job
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.