Skip to content

Commit bcee96a

Browse files
update branding (#159)
* update branding
1 parent 49e1783 commit bcee96a

Some content is hidden

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

46 files changed

+121
-121
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License
22

3-
Copyright (c) 2018 DocuSign, Inc. (https://www.docusign.com)
3+
Copyright (c) 2024 Docusign, Inc. (https://www.docusign.com)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

PAYMENTS_INSTALLATION.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configure a payment gateway
22

3-
DocuSign offers built-in connections to multiple payment gateways. The payments code example uses a developer account via the Stripe gateway service.
3+
Docusign offers built-in connections to multiple payment gateways. The payments code example uses a developer account via the Stripe gateway service.
44

55

66
## Create a Stripe payment gateway
@@ -9,13 +9,13 @@ DocuSign offers built-in connections to multiple payment gateways. The payments
99

1010
1. For development, you can skip the Stripe account application by using the **Skip this account form** link at the top of the page.<br />
1111

12-
![Skipping the Stripe account form](docs/stripe_skip_account_form_link.png)
12+
![Skipping the Stripe account form](docs/stripe_skip_account_form_link.png)
1313

14-
An enabled Stripe payment gateway is now associated with your DocuSign developer account and is shown under **Payment Gateway**.
14+
An enabled Stripe payment gateway is now associated with your Docusign developer account and is shown under **Payment Gateway**.
1515

1616
1. Save the **Gateway Account ID** GUID to the code example launcher configuration file.
1717

1818

1919
## Additional documentation
2020
* [Managing Payment Gateways](https://support.docusign.com/en/guides/managing-payment-gateways)
21-
* [How to send a request for payment](https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment)
21+
* [How to send a request for payment](https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment)

README.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,64 @@
22

33
### GitHub repo: [code-examples-ruby](./README.md)
44

5-
This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `examples_API` setting in the appsettings.yml file. Set only one API type to `true` and set the remaining to `false`.
5+
This GitHub repo includes code examples for the Docusign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `examples_API` setting in the appsettings.yml file. Set only one API type to `true` and set the remaining to `false`.
66

7-
If none of the API types are set to `true`, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown.
7+
If none of the API types are set to `true`, the Docusign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown.
88

99
## Introduction
1010
This repo is a Ruby on Rails application that supports the following authentication workflows:
1111

12-
* Authentication with DocuSign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
12+
* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
1313
When the token expires, the user is asked to re-authenticate. The refresh token is not used.
1414

15-
* Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
15+
* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
1616
When the token expires, it updates automatically.
1717

1818
## eSignature API
1919

2020
For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes).
2121

22-
For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the DocuSign Developer Center.
22+
For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the Docusign Developer Center.
2323

2424

2525
## Rooms API
2626

27-
**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account.
27+
**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the Docusign Forms feature enabled in your Rooms for Real Estate account.
2828
For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/).
2929

30-
For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the DocuSign Developer Center.
30+
For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the Docusign Developer Center.
3131

3232

3333
## Click API
3434
For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes)
3535

36-
For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the DocuSign Developer Center.
36+
For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the Docusign Developer Center.
3737

3838

3939
## Monitor API
4040

41-
**Note:** To use the Monitor API, you must also [enable DocuSign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).
41+
**Note:** To use the Monitor API, you must also [enable Docusign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).
4242

4343
For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/).
4444

45-
For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the DocuSign Developer Center.
45+
For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the Docusign Developer Center.
4646

4747

4848
## Admin API
4949

50-
**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
50+
**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your Docusign developer account. Also, to run the Docusign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
5151

5252
For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).
5353

54-
For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the DocuSign Developer Center.
54+
For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the Docusign Developer Center.
5555

5656
## Installation
5757

5858
### Prerequisites
59-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip items 1 and 2 as they were automatically performed for you.
59+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip items 1 and 2 as they were automatically performed for you.
6060

61-
1. A free [DocuSign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
62-
1. A DocuSign app and integration key that is configured for authentication to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/).
61+
1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
62+
1. A Docusign app and integration key that is configured for authentication to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/).
6363

6464
This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key.
6565

@@ -89,7 +89,7 @@ For a list of code examples that use the Admin API, see the [How-to guides overv
8989

9090

9191
### Installation steps
92-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 4 as it was automatically performed for you.
92+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip step 4 as it was automatically performed for you.
9393

9494
1. Extract the Quickstart ZIP file, or download or clone the code-examples-ruby repository.
9595
1. In your command-line environment, switch to the folder:
@@ -106,7 +106,7 @@ For a list of code examples that use the Admin API, see the [How-to guides overv
106106

107107

108108
### Installation steps for JWT Grant authentication
109-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 4 as it was automatically performed for you.
109+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the Docusign Developer Center, skip step 4 as it was automatically performed for you.
110110
Also, in order to select JSON Web Token authentication in the launcher, in config/appsettings.yml, change `quickstart` to `false`.
111111

112112
1. Extract the Quickstart ZIP file or download or clone the code-examples-ruby repository.
@@ -123,11 +123,11 @@ Also, in order to select JSON Web Token authentication in the launcher, in confi
123123
1. Run the launcher: `rails s`
124124
1. Open a browser to http://localhost:3000
125125
1. If it is your first time using the app, grant consent by selecting **Accept**. On the black navigation bar, select **Logout**, then **Login**.
126-
1. From the picklist, select **JSON Web Token (JWT) grant** > **Authenticate with DocuSign**.
126+
1. From the picklist, select **JSON Web Token (JWT) grant** > **Authenticate with Docusign**.
127127
1. Select your desired code example.
128128

129129
## JWT grant remote signing and Authorization Code Grant embedded signing projects
130-
See [DocuSign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the DocuSign Developer Center for more information on how to run the JWT grant remote signing project and the Authorization Code Grant embedded signing project.
130+
See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing project and the Authorization Code Grant embedded signing project.
131131

132132

133133
### Troubleshooting Windows SSL issue
@@ -147,7 +147,7 @@ Find the root folder for your Ruby gems (in this case, a 64-bit version of Ruby
147147

148148
C:\Ruby27-x64\lib\ruby\gems\2.7.0\gems\
149149

150-
Find the relevant DocuSign Ruby SDK you are using. The name always starts with “docusign”; for instance, DocuSign Click SDK version 1.0.0:
150+
Find the relevant Docusign Ruby SDK you are using. The name always starts with “docusign”; for instance, Docusign Click SDK version 1.0.0:
151151

152152
C:\Ruby27-x64\lib\ruby\gems\2.7.0\gems\docusign_click-1.0.0\lib\docusign_click
153153

app/assets/images/favicon.ico

-32.5 KB
Binary file not shown.

app/assets/images/favicon.png

1.19 KB
Loading

app/controllers/ds_common_controller.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def render_examples
5858
def ds_return
5959
# To break out of the Quickstart loop an example has been completed
6060
session[:been_here] = true
61-
@title = 'Return from DocuSign'
61+
@title = 'Return from Docusign'
6262
@event = request.params['event']
6363
@state = request.params['state']
6464
@envelope_id = request.params['envelopeId']
@@ -69,7 +69,7 @@ def ds_must_authenticate
6969

7070
jwt_auth if session[:api] == 'Monitor'
7171
redirect_to '/auth/docusign' if Rails.configuration.quickstart && session[:been_here].nil?
72-
@title = 'Authenticate with DocuSign'
72+
@title = 'Authenticate with Docusign'
7373
@show_doc = Rails.application.config.documentation
7474

7575
case params[:auth]

app/controllers/session_controller.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ def create
1212
# reset the session
1313
internal_destroy
1414

15-
Rails.logger.debug "\n==> DocuSign callback Authentication response:\n#{auth_hash.to_yaml}\n"
15+
Rails.logger.debug "\n==> Docusign callback Authentication response:\n#{auth_hash.to_yaml}\n"
1616
Rails.logger.info "==> Login: New token for admin user which will expire at: #{Time.at(auth_hash.credentials['expires_at'])}"
1717
store_auth_hash_from_docusign_callback
1818
redirect_to redirect_url

app/services/e_sign/eg002_signing_via_email_service.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -51,21 +51,21 @@ def make_envelope(envelope_args)
5151

5252
# Create the document models
5353
document1 = DocuSign_eSign::Document.new(
54-
# Create the DocuSign document object
54+
# Create the Docusign document object
5555
documentBase64: doc1_b64,
5656
name: 'Order acknowledgement', # Can be different from actual file name
5757
fileExtension: 'html', # Many different document types are accepted
5858
documentId: '1' # A label used to reference the doc
5959
)
6060
document2 = DocuSign_eSign::Document.new(
61-
# Create the DocuSign document object
61+
# Create the Docusign document object
6262
documentBase64: doc2_b64,
6363
name: 'Battle Plan', # Can be different from actual file name
6464
fileExtension: 'docx', # Many different document types are accepted
6565
documentId: '2' # A label used to reference the do
6666
)
6767
document3 = DocuSign_eSign::Document.new(
68-
# Create the DocuSign document object
68+
# Create the Docusign document object
6969
documentBase64: doc3_b64,
7070
name: 'Lorem Ipsum', # Can be different from actual file name
7171
fileExtension: 'pdf', # Many different document types are accepted
@@ -95,7 +95,7 @@ def make_envelope(envelope_args)
9595
# Create signHere fields (also known as tabs) on the documents
9696
# We're using anchor (autoPlace) positioning
9797
#
98-
# The DocuSign platform searches throughout your envelope's documents for matching
98+
# The Docusign platform searches throughout your envelope's documents for matching
9999
# anchor strings. So the sign_here_2 tab will be used in both document 2 and 3
100100
# since they use the same anchor string for their "signer 1" tabs.
101101
sign_here1 = DocuSign_eSign::SignHere.new(

app/services/e_sign/eg008_create_template_service.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def make_template_req
5757

5858
# Create the document model
5959
document = DocuSign_eSign::Document.new({
60-
# Create the DocuSign document object
60+
# Create the Docusign document object
6161
'documentBase64' => base64_file_content,
6262
'name' => 'Lorem Ipsum', # Can be different from actual file name
6363
'fileExtension' => 'pdf', # Many different document types are accepted

app/services/e_sign/eg010_send_binary_docs_service.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ def make_envelope_json(envelope_args)
161161
# Create signHere fields (also known as tabs) on the documents,
162162
# We're using anchor (autoPlace) positioning
163163
#
164-
# The DocuSign platform searches throughout your envelope's documents for matching
164+
# The Docusign platform searches throughout your envelope's documents for matching
165165
# anchor strings. So the sign_here_2 tab will be used in both document 2 and 3
166166
# since they use the same anchor string for their "signer 1" tabs.
167167
sign_here1 = DocuSign_eSign::SignHere.new({

app/services/e_sign/eg011_embedded_sending_service.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -68,21 +68,21 @@ def make_envelope(envelope_args)
6868

6969
# Create the document models
7070
document1 = DocuSign_eSign::Document.new(
71-
# Create the DocuSign document object
71+
# Create the Docusign document object
7272
documentBase64: doc1_b64,
7373
name: 'Order acknowledgement', # Can be different from actual file name
7474
fileExtension: 'html', # Many different document types are accepted
7575
documentId: '1' # A label used to reference the doc
7676
)
7777
document2 = DocuSign_eSign::Document.new(
78-
# Create the DocuSign document object
78+
# Create the Docusign document object
7979
documentBase64: doc2_b64,
8080
name: 'Battle Plan', # Can be different from actual file name
8181
fileExtension: 'docx', # Many different document types are accepted
8282
documentId: '2' # A label used to reference the do
8383
)
8484
document3 = DocuSign_eSign::Document.new(
85-
# Create the DocuSign document object
85+
# Create the Docusign document object
8686
documentBase64: doc3_b64,
8787
name: 'Lorem Ipsum', # Can be different from actual file name
8888
fileExtension: 'pdf', # Many different document types are accepted
@@ -112,7 +112,7 @@ def make_envelope(envelope_args)
112112
# Create signHere fields (also known as tabs) on the documents
113113
# We're using anchor (autoPlace) positioning
114114
#
115-
# The DocuSign platform searches throughout your envelope's documents for matching
115+
# The Docusign platform searches throughout your envelope's documents for matching
116116
# anchor strings. So the sign_here_2 tab will be used in both document 2 and 3
117117
# since they use the same anchor string for their "signer 1" tabs.
118118
sign_here1 = DocuSign_eSign::SignHere.new(

app/services/e_sign/eg014_collect_payment_service.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def make_envelope(args)
4242
# # NOTA BENE: This method programmatically constructs the
4343
# # order form. For many use cases, it would be
4444
# # better to create the order form as a template
45-
# # using the DocuSign web tool as WYSIWYG
45+
# # using the Docusign web tool as WYSIWYG
4646
# # form designer.
4747
# #
4848
# #################################################################

0 commit comments

Comments
 (0)