Skip to content

Commit d254e46

Browse files
committed
Update image
1 parent 4f26fec commit d254e46

File tree

2 files changed

+142
-1
lines changed

2 files changed

+142
-1
lines changed

README.md

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ $ npm install -g @gr4vy/cli
2222
$ gr4vy COMMAND
2323
running command...
2424
$ gr4vy (--version)
25-
@gr4vy/cli/0.1.4 darwin-arm64 node-v22.15.0
25+
@gr4vy/cli/0.2.0 darwin-arm64 node-v22.15.0
2626
$ gr4vy --help [COMMAND]
2727
USAGE
2828
$ gr4vy COMMAND
@@ -59,7 +59,11 @@ More details on each command is available below.
5959
# Commands
6060
<!-- commands -->
6161
* [`gr4vy autocomplete [SHELL]`](#gr4vy-autocomplete-shell)
62+
* [`gr4vy checkout-session --merchant-account-id=default`](#gr4vy-checkout-session---merchant-account-iddefault)
63+
* [`gr4vy embed 1299 USD buyer_external_identifier=user-123`](#gr4vy-embed-1299-usd-buyer_external_identifieruser-123)
6264
* [`gr4vy help [COMMAND]`](#gr4vy-help-command)
65+
* [`gr4vy init acme sandbox private_key.pem`](#gr4vy-init-acme-sandbox-private_keypem)
66+
* [`gr4vy token expiresIn=10d --scope=buyers.read --scope=buyers.write`](#gr4vy-token-expiresin10d---scopebuyersread---scopebuyerswrite)
6367

6468
## `gr4vy autocomplete [SHELL]`
6569

@@ -92,6 +96,70 @@ EXAMPLES
9296

9397
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.31/src/commands/autocomplete/index.ts)_
9498

99+
## `gr4vy checkout-session --merchant-account-id=default`
100+
101+
Generate a checkout session ID.
102+
103+
```
104+
USAGE
105+
$ gr4vy checkout-session --merchant-account-id=default
106+
107+
FLAGS
108+
-m, --mid=<value> The merchant account ID to generate a checkout session for.
109+
--debug Returns the raw header and claim for the token
110+
111+
DESCRIPTION
112+
Generate a checkout session ID.
113+
114+
This ID can be used with Secure Fields and our native mobile SDKs.
115+
116+
117+
FLAG DESCRIPTIONS
118+
-m, --mid=<value> The merchant account ID to generate a checkout session for.
119+
120+
This default to no value if not provided.
121+
122+
--debug Returns the raw header and claim for the token
123+
124+
Returns the decoded header and claim from the JWT token without the signature
125+
```
126+
127+
_See code: [src/commands/checkout-session.ts](https://github.com/gr4vy/gr4vy-cli/blob/v0.2.0/src/commands/checkout-session.ts)_
128+
129+
## `gr4vy embed 1299 USD buyer_external_identifier=user-123`
130+
131+
Generate a token for use with Gr4vy Embed.
132+
133+
```
134+
USAGE
135+
$ gr4vy embed 1299 USD buyer_external_identifier=user-123
136+
137+
ARGUMENTS
138+
AMOUNT... The amount to generate a token for. This amount needs to be in the smallest denomination for the
139+
currency, e.g. 1299 for $12.99
140+
CURRENCY... The 3 digit currency code to generate a token for.
141+
142+
FLAGS
143+
--debug Returns the raw header and claim for the token
144+
145+
DESCRIPTION
146+
Generate a token for use with Gr4vy Embed.
147+
148+
This token can be used with Embed as it is
149+
restricted to frontend scopes only.
150+
151+
It accepts any number of key=value pairs as additional data to be
152+
pinned in the token.
153+
154+
155+
FLAG DESCRIPTIONS
156+
--debug Returns the raw header and claim for the token
157+
158+
Returns the decoded header and claim from the JWT token without the signature
159+
```
160+
161+
_See code: [src/commands/embed.ts](https://github.com/gr4vy/gr4vy-cli/blob/v0.2.0/src/commands/embed.ts)_
162+
95163
## `gr4vy help [COMMAND]`
96164

97165
Display help for gr4vy.
@@ -111,4 +179,76 @@ DESCRIPTION
111179
```
112180

113181
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts)_
182+
183+
## `gr4vy init acme sandbox private_key.pem`
184+
185+
Store configuration into a .gr4vyrc.json file
186+
187+
```
188+
USAGE
189+
$ gr4vy init acme sandbox private_key.pem
190+
191+
ARGUMENTS
192+
GR4VYID The ID of your instance.
193+
ENVIRONMENT (production|sandbox) The environment of your instance.
194+
PRIVATEKEY The filename of the private key to add to the config.
195+
196+
DESCRIPTION
197+
Store configuration into a .gr4vyrc.json file
198+
199+
Generates a config file that can be used to generate the token.
200+
```
201+
202+
_See code: [src/commands/init.ts](https://github.com/gr4vy/gr4vy-cli/blob/v0.2.0/src/commands/init.ts)_
203+
204+
## `gr4vy token expiresIn=10d --scope=buyers.read --scope=buyers.write`
205+
206+
Generate a bearer token for server-to-server API calls.
207+
208+
```
209+
USAGE
210+
$ gr4vy token expiresIn=10d --scope=buyers.read --scope=buyers.write
211+
212+
FLAGS
213+
-e, --expiresIn=<value>
214+
[default: 1h] The expiry of the token
215+
216+
-s, --scope=<option>...
217+
[default: *.read,*.write] A scope to add to this flag
218+
<options: all.read|all.write|*.read|*.write|anti-fraud-service-definitions.read|anti-fraud-service-definitions.write
219+
|anti-fraud-services.read|anti-fraud-services.write|buyers.read|buyers.write|buyers.billing-details.read|buyers.bill
220+
ing-details.write|connections.read|connections.write|digital-wallets.read|digital-wallets.write|flows.read|flows.wri
221+
te|payment-methods.read|payment-methods.write|payment-options.read|payment-options.write|payment-service-definitions
222+
.read|payment-service-definitions.write|payment-services.read|payment-services.write|reports.read|reports.write|role
223+
s.read|roles.write|transactions.read|transactions.write|audit-logs.read|audit-logs.write|checkout-sessions.read|chec
224+
kout-sessions.write|card-scheme-definitions.read|card-scheme-definitions.write|payment-method-definitions.read|payme
225+
nt-method-definitions.write|reset.read|reset.write|merchant-accounts.read|merchant-accounts.write>
226+
227+
--debug
228+
Returns the raw header and claim for the token
229+
230+
DESCRIPTION
231+
Generate a bearer token for server-to-server API calls.
232+
233+
This token should be used with care as it is not
234+
restricted to any specific frontend scopes only.
235+
236+
237+
FLAG DESCRIPTIONS
238+
-e, --expiresIn=<value> The expiry of the token
239+
240+
The expiration expressed in seconds or a string describing a time span vercel/ms.
241+
242+
-s, --scope=all.read|all.write|*.read|*.write|anti-fraud-service-definitions.read|anti-fraud-service-definitions.write|anti-fraud-services.read|anti-fraud-services.write|buyers.read|buyers.write|buyers.billing-details.read|buyers.billing-details.write|connections.read|connections.write|digital-wallets.read|digital-wallets.write|flows.read|flows.write|payment-methods.read|payment-methods.write|payment-options.read|payment-options.write|payment-service-definitions.read|payment-service-definitions.write|payment-services.read|payment-services.write|reports.read|reports.write|roles.read|roles.write|transactions.read|transactions.write|audit-logs.read|audit-logs.write|checkout-sessions.read|checkout-sessions.write|card-scheme-definitions.read|card-scheme-definitions.write|payment-method-definitions.read|payment-method-definitions.write|reset.read|reset.write|merchant-accounts.read|merchant-accounts.write...
243+
244+
A scope to add to this flag
245+
246+
A single scope to add to this JWT
247+
248+
--debug Returns the raw header and claim for the token
249+
250+
Returns the decoded header and claim from the JWT token without the signature
251+
```
252+
253+
_See code: [src/commands/token.ts](https://github.com/gr4vy/gr4vy-cli/blob/v0.2.0/src/commands/token.ts)_
114254
<!-- commandsstop -->

tsconfig.tsbuildinfo

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"root":["./src/base.ts","./src/commands/checkout-session.ts","./src/commands/embed.ts","./src/commands/init.ts","./src/commands/token.ts","./src/helpers/decode.ts","./src/helpers/parse-embed-data.ts"],"version":"5.8.3"}

0 commit comments

Comments
 (0)