docusign_esign 1.0.0 → 1.0.1

data/docs/AuthenticationMethod.md

@@ -1,11 +0,0 @@
-# DocuSign_eSign::AuthenticationMethod
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authentication_type** | **String** | Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth.  | [optional] 
-**last_provider** | **String** | The last provider that authenticated the user.  | [optional] 
-**last_timestamp** | **String** |  The data and time the user last used the authentication method.  | [optional] 
-**total_count** | **Integer** | The number of times the authentication method was used.  | [optional] 
-
-

data/docs/AuthenticationStatus.md

@@ -1,24 +0,0 @@
-# DocuSign_eSign::AuthenticationStatus
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**access_code_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**age_verify_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**any_social_id_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**facebook_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**google_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**id_lookup_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**id_questions_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**linkedin_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**live_id_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**ofac_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**open_id_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**phone_auth_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**salesforce_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**sms_auth_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**s_tan_pin_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**twitter_result** | [**EventResult**](EventResult.md) |  | [optional] 
-**yahoo_result** | [**EventResult**](EventResult.md) |  | [optional] 
-
-

data/docs/BccEmailAddress.md

@@ -1,9 +0,0 @@
-# DocuSign_eSign::BccEmailAddress
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bcc_email_address_id** | **String** | Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email.    Example: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address. | [optional] 
-**email** | **String** | Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.  Maximum of length: 100 characters.  | [optional] 
-
-

data/docs/BillingApi.md

@@ -1,569 +0,0 @@
-# DocuSign_eSign::BillingApi
-
-All URIs are relative to *https://www.docusign.net/restapi*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_billing_plan**](BillingApi.md#get_billing_plan) | **GET** /v2/billing_plans/{billingPlanId} | Get the billing plan details.
-[**get_invoice**](BillingApi.md#get_invoice) | **GET** /v2/accounts/{accountId}/billing_invoices/{invoiceId} | Retrieves a billing invoice.
-[**get_payment**](BillingApi.md#get_payment) | **GET** /v2/accounts/{accountId}/billing_payments/{paymentId} | Gets billing payment information for a specific payment.
-[**get_plan**](BillingApi.md#get_plan) | **GET** /v2/accounts/{accountId}/billing_plan | Get Account Billing Plan
-[**list_billing_plans**](BillingApi.md#list_billing_plans) | **GET** /v2/billing_plans | Gets the list of available billing plans.
-[**list_invoices**](BillingApi.md#list_invoices) | **GET** /v2/accounts/{accountId}/billing_invoices | Get a List of Billing Invoices
-[**list_invoices_past_due**](BillingApi.md#list_invoices_past_due) | **GET** /v2/accounts/{accountId}/billing_invoices_past_due | Get a list of past due invoices.
-[**list_payments**](BillingApi.md#list_payments) | **GET** /v2/accounts/{accountId}/billing_payments | Gets payment information for one or more payments.
-[**make_payment**](BillingApi.md#make_payment) | **POST** /v2/accounts/{accountId}/billing_payments | Posts a payment to a past due invoice.
-[**purchase_envelopes**](BillingApi.md#purchase_envelopes) | **PUT** /v2/accounts/{accountId}/billing_plan/purchased_envelopes | Reserverd: Purchase additional envelopes.
-[**update_plan**](BillingApi.md#update_plan) | **PUT** /v2/accounts/{accountId}/billing_plan | Updates the account billing plan.
-
-
-# **get_billing_plan**
-> BillingPlanResponse get_billing_plan(billing_plan_id)
-
-Get the billing plan details.
-
-Retrieves the billing plan details for the specified billing plan ID.
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-billing_plan_id = "billing_plan_id_example" # String | The ID of the billing plan being accessed.
-
-
-begin
-  #Get the billing plan details.
-  result = api_instance.get_billing_plan(billing_plan_id)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->get_billing_plan: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **billing_plan_id** | **String**| The ID of the billing plan being accessed. | 
-
-### Return type
-
-[**BillingPlanResponse**](BillingPlanResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_invoice**
-> BillingInvoice get_invoice(account_id, invoice_id)
-
-Retrieves a billing invoice.
-
-Retrieves the specified invoice.   ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.  Privileges required: account administrator  The response returns a list of charges and information about the charges. Quantities are usually shown as ‘unlimited’ or an integer. Amounts are shown in the currency set for the account.  **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.  | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | 
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-invoice_id = "invoice_id_example" # String | 
-
-
-begin
-  #Retrieves a billing invoice.
-  result = api_instance.get_invoice(account_id, invoice_id)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->get_invoice: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **invoice_id** | **String**|  | 
-
-### Return type
-
-[**BillingInvoice**](BillingInvoice.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_payment**
-> BillingPaymentItem get_payment(account_id, payment_id)
-
-Gets billing payment information for a specific payment.
-
-Retrieves the information for a specified payment.   Privileges required: account administrator 
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-payment_id = "payment_id_example" # String | 
-
-
-begin
-  #Gets billing payment information for a specific payment.
-  result = api_instance.get_payment(account_id, payment_id)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->get_payment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **payment_id** | **String**|  | 
-
-### Return type
-
-[**BillingPaymentItem**](BillingPaymentItem.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_plan**
-> AccountBillingPlanResponse get_plan(account_id, opts)
-
-Get Account Billing Plan
-
-Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.  By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to **false**.   Response  The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference.  ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible. 
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-opts = { 
-  include_credit_card_information: "include_credit_card_information_example", # String | When set to **true**, excludes credit card information from the response.
-  include_metadata: "include_metadata_example", # String | When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information. 
-  include_successor_plans: "include_successor_plans_example" # String | When set to **true**, excludes successor information from the response.
-}
-
-begin
-  #Get Account Billing Plan
-  result = api_instance.get_plan(account_id, opts)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->get_plan: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **include_credit_card_information** | **String**| When set to **true**, excludes credit card information from the response. | [optional] 
- **include_metadata** | **String**| When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information.  | [optional] 
- **include_successor_plans** | **String**| When set to **true**, excludes successor information from the response. | [optional] 
-
-### Return type
-
-[**AccountBillingPlanResponse**](AccountBillingPlanResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **list_billing_plans**
-> BillingPlansResponse list_billing_plans
-
-Gets the list of available billing plans.
-
-Retrieves a list of the billing plans associated with a distributor.
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-begin
-  #Gets the list of available billing plans.
-  result = api_instance.list_billing_plans
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->list_billing_plans: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**BillingPlansResponse**](BillingPlansResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **list_invoices**
-> BillingInvoicesResponse list_invoices(account_id, opts)
-
-Get a List of Billing Invoices
-
-Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.  Privileges required: account administrator 
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-opts = { 
-  from_date: "from_date_example", # String | Specifies the date/time of the earliest invoice in the account to retrieve.
-  to_date: "to_date_example" # String | Specifies the date/time of the latest invoice in the account to retrieve.
-}
-
-begin
-  #Get a List of Billing Invoices
-  result = api_instance.list_invoices(account_id, opts)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->list_invoices: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **from_date** | **String**| Specifies the date/time of the earliest invoice in the account to retrieve. | [optional] 
- **to_date** | **String**| Specifies the date/time of the latest invoice in the account to retrieve. | [optional] 
-
-### Return type
-
-[**BillingInvoicesResponse**](BillingInvoicesResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **list_invoices_past_due**
-> BillingInvoicesSummary list_invoices_past_due(account_id)
-
-Get a list of past due invoices.
-
-Returns a list past due invoices for the account and notes if payment can be made through the REST API.   Privileges Required: account administrator
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-
-begin
-  #Get a list of past due invoices.
-  result = api_instance.list_invoices_past_due(account_id)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->list_invoices_past_due: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
-
-### Return type
-
-[**BillingInvoicesSummary**](BillingInvoicesSummary.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **list_payments**
-> BillingPaymentsResponse list_payments(account_id, opts)
-
-Gets payment information for one or more payments.
-
-Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.   Privileges required: account administrator 
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-opts = { 
-  from_date: "from_date_example", # String | Specifies the date/time of the earliest payment in the account to retrieve.
-  to_date: "to_date_example" # String | Specifies the date/time of the latest payment in the account to retrieve.
-}
-
-begin
-  #Gets payment information for one or more payments.
-  result = api_instance.list_payments(account_id, opts)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->list_payments: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **from_date** | **String**| Specifies the date/time of the earliest payment in the account to retrieve. | [optional] 
- **to_date** | **String**| Specifies the date/time of the latest payment in the account to retrieve. | [optional] 
-
-### Return type
-
-[**BillingPaymentsResponse**](BillingPaymentsResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **make_payment**
-> BillingPaymentResponse make_payment(account_id, opts)
-
-Posts a payment to a past due invoice.
-
-Posts a payment to a past due invoice.   ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue].  The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.  Privileges required: account administrator
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-opts = { 
-  billing_payment_request: DocuSign_eSign::BillingPaymentRequest.new # BillingPaymentRequest | 
-}
-
-begin
-  #Posts a payment to a past due invoice.
-  result = api_instance.make_payment(account_id, opts)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->make_payment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **billing_payment_request** | [**BillingPaymentRequest**](BillingPaymentRequest.md)|  | [optional] 
-
-### Return type
-
-[**BillingPaymentResponse**](BillingPaymentResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **purchase_envelopes**
-> purchase_envelopes(account_id, opts)
-
-Reserverd: Purchase additional envelopes.
-
-Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-opts = { 
-  purchased_envelopes_information: DocuSign_eSign::PurchasedEnvelopesInformation.new # PurchasedEnvelopesInformation | 
-}
-
-begin
-  #Reserverd: Purchase additional envelopes.
-  api_instance.purchase_envelopes(account_id, opts)
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->purchase_envelopes: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **purchased_envelopes_information** | [**PurchasedEnvelopesInformation**](PurchasedEnvelopesInformation.md)|  | [optional] 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **update_plan**
-> BillingPlanUpdateResponse update_plan(account_id, opts)
-
-Updates the account billing plan.
-
-Updates the billing plan information, billing address, and credit card information for the specified account.
-
-### Example
-```ruby
-# load the gem
-require 'docusign_esign'
-
-api_instance = DocuSign_eSign::BillingApi.new
-
-account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
-
-opts = { 
-  preview_billing_plan: "preview_billing_plan_example", # String | When set to **true**, updates the account using a preview billing plan.
-  billing_plan_information: DocuSign_eSign::BillingPlanInformation.new # BillingPlanInformation | 
-}
-
-begin
-  #Updates the account billing plan.
-  result = api_instance.update_plan(account_id, opts)
-  p result
-rescue DocuSign_eSign::ApiError => e
-  puts "Exception when calling BillingApi->update_plan: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **account_id** | **String**| The external account number (int) or account ID Guid. | 
- **preview_billing_plan** | **String**| When set to **true**, updates the account using a preview billing plan. | [optional] 
- **billing_plan_information** | [**BillingPlanInformation**](BillingPlanInformation.md)|  | [optional] 
-
-### Return type
-
-[**BillingPlanUpdateResponse**](BillingPlanUpdateResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-