@gr4vy/sdk 1.0.0-beta.7 → 1.0.0-beta.9

package/README.md

@@ -1,10 +1,57 @@
 # Gr4vy Typescript SDK (Beta)
 
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage the **Gr4vy** API.
+
+
 <div align="left">
     <a href="https://www.npmjs.com/package/@gr4vy/sdk"><img alt="NPM Version" src="https://img.shields.io/npm/v/%40gr4vy%2Fsdk?style=for-the-badge" /></a>
     <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
 </div>
 
+## Summary
+
+Gr4vy Typescript SDK
+
+The official Gr4vy SDK for Typescript provides a convenient way to interact with the Gr4vy API from your server-side application. This SDK allows you to seamlessly integrate Gr4vy's powerful payment orchestration capabilities, including:
+
+* Creating Transactions: Initiate and process payments with various payment methods and services.
+* Managing Buyers: Store and manage buyer information securely.
+* Storing Payment Methods: Securely store and tokenize payment methods for future use.
+* Handling Webhooks: Easily process and respond to webhook events from Gr4vy.
+* And much more: Access the full suite of Gr4vy API payment features.
+
+This SDK is designed to simplify development, reduce boilerplate code, and help you get up and running with Gr4vy quickly and efficiently. It handles authentication, request signing, and provides easy-to-use methods for most API endpoints.
+
+<!-- No Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Gr4vy Typescript SDK (Beta)](#gr4vy-typescript-sdk-beta)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Bearer token generation](#bearer-token-generation)
+  * [Embed token generation](#embed-token-generation)
+  * [Merchant account ID selection](#merchant-account-id-selection)
+  * [Webhooks verification](#webhooks-verification)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [SDK Installation](#sdk-installation-1)
+  * [SDK Example Usage](#sdk-example-usage-1)
+  * [Pagination](#pagination)
+  * [Retries](#retries)
+  * [Standalone functions](#standalone-functions)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Testing](#testing)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
 
 ## SDK Installation
 
@@ -1098,7 +1145,7 @@ You can also enable a default debug logger by setting an environment variable `G
 
 ## Testing
 
-To run the tests, install NPM and run the following.
+To run the tests, install NPM, ensure to download the `private_key.pem` for the test environment, and run the following.
 
 ```sh
 npm install

package/bin/mcp-server.js

@@ -4026,9 +4026,9 @@ var init_config = __esm(() => {
   SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1.0.0",
-    sdkVersion: "1.0.0-beta.7",
-    genVersion: "2.605.0",
-    userAgent: "speakeasy-sdk/typescript 1.0.0-beta.7 2.605.0 1.0.0 @gr4vy/sdk"
+    sdkVersion: "1.0.0-beta.9",
+    genVersion: "2.605.6",
+    userAgent: "speakeasy-sdk/typescript 1.0.0-beta.9 2.605.6 1.0.0 @gr4vy/sdk"
   };
 });
 
@@ -36385,18 +36385,6 @@ var init_avsresponsecode = __esm(() => {
   })(AVSResponseCode$ ||= {});
 });
 
-// src/models/components/basemodel.ts
-var BaseModel$inboundSchema, BaseModel$outboundSchema, BaseModel$;
-var init_basemodel = __esm(() => {
-  init_lib();
-  BaseModel$inboundSchema = objectType({});
-  BaseModel$outboundSchema = objectType({});
-  ((BaseModel$) => {
-    BaseModel$.inboundSchema = BaseModel$inboundSchema;
-    BaseModel$.outboundSchema = BaseModel$outboundSchema;
-  })(BaseModel$ ||= {});
-});
-
 // src/models/components/taxidkind.ts
 var TaxIdKind, TaxIdKind$inboundSchema, TaxIdKind$outboundSchema, TaxIdKind$;
 var init_taxidkind = __esm(() => {
@@ -37299,43 +37287,6 @@ var init_checkoutsession = __esm(() => {
   })(CheckoutSession$ ||= {});
 });
 
-// src/models/components/checkoutsessionpaymentmethodcreate.ts
-var CheckoutSessionPaymentMethodCreate$inboundSchema, CheckoutSessionPaymentMethodCreate$outboundSchema, CheckoutSessionPaymentMethodCreate$;
-var init_checkoutsessionpaymentmethodcreate = __esm(() => {
-  init_lib();
-  init_primitives();
-  CheckoutSessionPaymentMethodCreate$inboundSchema = objectType({
-    method: literalType("checkout-session").default("checkout-session"),
-    id: stringType(),
-    external_identifier: nullableType(stringType()).optional(),
-    buyer_id: nullableType(stringType()).optional(),
-    buyer_external_identifier: nullableType(stringType()).optional()
-  }).transform((v2) => {
-    return remap(v2, {
-      external_identifier: "externalIdentifier",
-      buyer_id: "buyerId",
-      buyer_external_identifier: "buyerExternalIdentifier"
-    });
-  });
-  CheckoutSessionPaymentMethodCreate$outboundSchema = objectType({
-    method: literalType("checkout-session").default("checkout-session"),
-    id: stringType(),
-    externalIdentifier: nullableType(stringType()).optional(),
-    buyerId: nullableType(stringType()).optional(),
-    buyerExternalIdentifier: nullableType(stringType()).optional()
-  }).transform((v2) => {
-    return remap(v2, {
-      externalIdentifier: "external_identifier",
-      buyerId: "buyer_id",
-      buyerExternalIdentifier: "buyer_external_identifier"
-    });
-  });
-  ((CheckoutSessionPaymentMethodCreate$) => {
-    CheckoutSessionPaymentMethodCreate$.inboundSchema = CheckoutSessionPaymentMethodCreate$inboundSchema;
-    CheckoutSessionPaymentMethodCreate$.outboundSchema = CheckoutSessionPaymentMethodCreate$outboundSchema;
-  })(CheckoutSessionPaymentMethodCreate$ ||= {});
-});
-
 // src/models/components/guestbuyerinput.ts
 var GuestBuyerInput$inboundSchema, GuestBuyerInput$outboundSchema, GuestBuyerInput$;
 var init_guestbuyerinput = __esm(() => {
@@ -37379,15 +37330,15 @@ var init_guestbuyerinput = __esm(() => {
   })(GuestBuyerInput$ ||= {});
 });
 
-// src/models/components/checkoutsessionupdate.ts
-var CheckoutSessionUpdate$inboundSchema, CheckoutSessionUpdate$outboundSchema, CheckoutSessionUpdate$;
-var init_checkoutsessionupdate = __esm(() => {
+// src/models/components/checkoutsessioncreate.ts
+var CheckoutSessionCreate$inboundSchema, CheckoutSessionCreate$outboundSchema, CheckoutSessionCreate$;
+var init_checkoutsessioncreate = __esm(() => {
   init_lib();
   init_primitives();
   init_airline();
   init_cartitem();
   init_guestbuyerinput();
-  CheckoutSessionUpdate$inboundSchema = objectType({
+  CheckoutSessionCreate$inboundSchema = objectType({
     cart_items: nullableType(arrayType(CartItem$inboundSchema)).optional(),
     metadata: nullableType(recordType(stringType())).optional(),
     buyer: nullableType(GuestBuyerInput$inboundSchema).optional(),
@@ -37399,7 +37350,7 @@ var init_checkoutsessionupdate = __esm(() => {
       expires_in: "expiresIn"
     });
   });
-  CheckoutSessionUpdate$outboundSchema = objectType({
+  CheckoutSessionCreate$outboundSchema = objectType({
     cartItems: nullableType(arrayType(CartItem$outboundSchema)).optional(),
     metadata: nullableType(recordType(stringType())).optional(),
     buyer: nullableType(GuestBuyerInput$outboundSchema).optional(),
@@ -37411,10 +37362,47 @@ var init_checkoutsessionupdate = __esm(() => {
       expiresIn: "expires_in"
     });
   });
-  ((CheckoutSessionUpdate$) => {
-    CheckoutSessionUpdate$.inboundSchema = CheckoutSessionUpdate$inboundSchema;
-    CheckoutSessionUpdate$.outboundSchema = CheckoutSessionUpdate$outboundSchema;
-  })(CheckoutSessionUpdate$ ||= {});
+  ((CheckoutSessionCreate$) => {
+    CheckoutSessionCreate$.inboundSchema = CheckoutSessionCreate$inboundSchema;
+    CheckoutSessionCreate$.outboundSchema = CheckoutSessionCreate$outboundSchema;
+  })(CheckoutSessionCreate$ ||= {});
+});
+
+// src/models/components/checkoutsessionpaymentmethodcreate.ts
+var CheckoutSessionPaymentMethodCreate$inboundSchema, CheckoutSessionPaymentMethodCreate$outboundSchema, CheckoutSessionPaymentMethodCreate$;
+var init_checkoutsessionpaymentmethodcreate = __esm(() => {
+  init_lib();
+  init_primitives();
+  CheckoutSessionPaymentMethodCreate$inboundSchema = objectType({
+    method: literalType("checkout-session").default("checkout-session"),
+    id: stringType(),
+    external_identifier: nullableType(stringType()).optional(),
+    buyer_id: nullableType(stringType()).optional(),
+    buyer_external_identifier: nullableType(stringType()).optional()
+  }).transform((v2) => {
+    return remap(v2, {
+      external_identifier: "externalIdentifier",
+      buyer_id: "buyerId",
+      buyer_external_identifier: "buyerExternalIdentifier"
+    });
+  });
+  CheckoutSessionPaymentMethodCreate$outboundSchema = objectType({
+    method: literalType("checkout-session").default("checkout-session"),
+    id: stringType(),
+    externalIdentifier: nullableType(stringType()).optional(),
+    buyerId: nullableType(stringType()).optional(),
+    buyerExternalIdentifier: nullableType(stringType()).optional()
+  }).transform((v2) => {
+    return remap(v2, {
+      externalIdentifier: "external_identifier",
+      buyerId: "buyer_id",
+      buyerExternalIdentifier: "buyer_external_identifier"
+    });
+  });
+  ((CheckoutSessionPaymentMethodCreate$) => {
+    CheckoutSessionPaymentMethodCreate$.inboundSchema = CheckoutSessionPaymentMethodCreate$inboundSchema;
+    CheckoutSessionPaymentMethodCreate$.outboundSchema = CheckoutSessionPaymentMethodCreate$outboundSchema;
+  })(CheckoutSessionPaymentMethodCreate$ ||= {});
 });
 
 // src/models/components/checkoutsessionwithurlpaymentmethodcreate.ts
@@ -43164,7 +43152,6 @@ var init_components = __esm(() => {
   init_auditlogentryresource();
   init_auditlogentryuser();
   init_avsresponsecode();
-  init_basemodel();
   init_billingdetailsinput();
   init_billingdetailsoutput();
   init_browserinfo();
@@ -43179,10 +43166,10 @@ var init_components = __esm(() => {
   init_cartitem();
   init_checkoutcardconnectionoptions();
   init_checkoutsession();
+  init_checkoutsessioncreate();
   init_checkoutsessionpaymentmethod();
   init_checkoutsessionpaymentmethodcreate();
   init_checkoutsessionpaymentmethoddetails();
-  init_checkoutsessionupdate();
   init_checkoutsessionwithurlpaymentmethodcreate();
   init_clicktopayfpanpaymentmethodcreate();
   init_clicktopaypaymentmethodcreate();
@@ -44161,7 +44148,7 @@ var init_createapplepaydigitalwalletsession = __esm(() => {
 });
 
 // src/models/operations/createcheckoutsession.ts
-var CreateCheckoutSessionGlobals$inboundSchema, CreateCheckoutSessionGlobals$outboundSchema, CreateCheckoutSessionGlobals$, CreateCheckoutSessionBody$inboundSchema, CreateCheckoutSessionBody$outboundSchema, CreateCheckoutSessionBody$, CreateCheckoutSessionRequest$inboundSchema, CreateCheckoutSessionRequest$outboundSchema, CreateCheckoutSessionRequest$;
+var CreateCheckoutSessionGlobals$inboundSchema, CreateCheckoutSessionGlobals$outboundSchema, CreateCheckoutSessionGlobals$, CreateCheckoutSessionRequest$inboundSchema, CreateCheckoutSessionRequest$outboundSchema, CreateCheckoutSessionRequest$;
 var init_createcheckoutsession = __esm(() => {
   init_lib();
   init_primitives();
@@ -44176,42 +44163,24 @@ var init_createcheckoutsession = __esm(() => {
     CreateCheckoutSessionGlobals$.inboundSchema = CreateCheckoutSessionGlobals$inboundSchema;
     CreateCheckoutSessionGlobals$.outboundSchema = CreateCheckoutSessionGlobals$outboundSchema;
   })(CreateCheckoutSessionGlobals$ ||= {});
-  CreateCheckoutSessionBody$inboundSchema = unionType([
-    CheckoutSessionUpdate$inboundSchema,
-    arrayType(BaseModel$inboundSchema)
-  ]);
-  CreateCheckoutSessionBody$outboundSchema = unionType([
-    CheckoutSessionUpdate$outboundSchema,
-    arrayType(BaseModel$outboundSchema)
-  ]);
-  ((CreateCheckoutSessionBody$) => {
-    CreateCheckoutSessionBody$.inboundSchema = CreateCheckoutSessionBody$inboundSchema;
-    CreateCheckoutSessionBody$.outboundSchema = CreateCheckoutSessionBody$outboundSchema;
-  })(CreateCheckoutSessionBody$ ||= {});
   CreateCheckoutSessionRequest$inboundSchema = objectType({
     timeout_in_seconds: numberType().default(1),
     merchantAccountId: nullableType(stringType()).optional(),
-    RequestBody: nullableType(unionType([
-      CheckoutSessionUpdate$inboundSchema,
-      arrayType(BaseModel$inboundSchema)
-    ])).optional()
+    CheckoutSessionCreate: CheckoutSessionCreate$inboundSchema.optional()
   }).transform((v2) => {
     return remap(v2, {
       timeout_in_seconds: "timeoutInSeconds",
-      RequestBody: "requestBody"
+      CheckoutSessionCreate: "checkoutSessionCreate"
     });
   });
   CreateCheckoutSessionRequest$outboundSchema = objectType({
     timeoutInSeconds: numberType().default(1),
     merchantAccountId: nullableType(stringType()).optional(),
-    requestBody: nullableType(unionType([
-      CheckoutSessionUpdate$outboundSchema,
-      arrayType(BaseModel$outboundSchema)
-    ])).optional()
+    checkoutSessionCreate: CheckoutSessionCreate$outboundSchema.optional()
   }).transform((v2) => {
     return remap(v2, {
       timeoutInSeconds: "timeout_in_seconds",
-      requestBody: "RequestBody"
+      checkoutSessionCreate: "CheckoutSessionCreate"
     });
   });
   ((CreateCheckoutSessionRequest$) => {
@@ -47076,24 +47045,24 @@ var init_updatecheckoutsession = __esm(() => {
     session_id: stringType(),
     timeout_in_seconds: numberType().default(1),
     merchantAccountId: nullableType(stringType()).optional(),
-    CheckoutSessionUpdate: CheckoutSessionUpdate$inboundSchema
+    CheckoutSessionCreate: CheckoutSessionCreate$inboundSchema
   }).transform((v2) => {
     return remap(v2, {
       session_id: "sessionId",
       timeout_in_seconds: "timeoutInSeconds",
-      CheckoutSessionUpdate: "checkoutSessionUpdate"
+      CheckoutSessionCreate: "checkoutSessionCreate"
     });
   });
   UpdateCheckoutSessionRequest$outboundSchema = objectType({
     sessionId: stringType(),
     timeoutInSeconds: numberType().default(1),
     merchantAccountId: nullableType(stringType()).optional(),
-    checkoutSessionUpdate: CheckoutSessionUpdate$outboundSchema
+    checkoutSessionCreate: CheckoutSessionCreate$outboundSchema
   }).transform((v2) => {
     return remap(v2, {
       sessionId: "session_id",
       timeoutInSeconds: "timeout_in_seconds",
-      checkoutSessionUpdate: "CheckoutSessionUpdate"
+      checkoutSessionCreate: "CheckoutSessionCreate"
     });
   });
   ((UpdateCheckoutSessionRequest$) => {
@@ -49511,12 +49480,12 @@ Fetch a list of the definitions of each card scheme.`,
 });
 
 // src/funcs/checkoutSessionsCreate.ts
-function checkoutSessionsCreate(client, requestBody, timeoutInSeconds, merchantAccountId, options) {
-  return new APIPromise($do16(client, requestBody, timeoutInSeconds, merchantAccountId, options));
+function checkoutSessionsCreate(client, checkoutSessionCreate, timeoutInSeconds, merchantAccountId, options) {
+  return new APIPromise($do16(client, checkoutSessionCreate, timeoutInSeconds, merchantAccountId, options));
 }
-async function $do16(client, requestBody, timeoutInSeconds, merchantAccountId, options) {
+async function $do16(client, checkoutSessionCreate, timeoutInSeconds, merchantAccountId, options) {
   const input = {
-    requestBody,
+    checkoutSessionCreate,
     timeoutInSeconds,
     merchantAccountId
   };
@@ -49525,7 +49494,9 @@ async function $do16(client, requestBody, timeoutInSeconds, merchantAccountId, o
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload?.RequestBody, { explode: true });
+  const body = encodeJSON("body", payload?.CheckoutSessionCreate, {
+    explode: true
+  });
   const path = pathToFunc("/checkout/sessions")();
   const query = encodeFormQuery({
     timeout_in_seconds: payload?.timeout_in_seconds
@@ -49613,10 +49584,10 @@ var args16, tool$checkoutSessionsCreate;
 var init_checkoutSessionsCreate2 = __esm(() => {
   init_lib();
   init_checkoutSessionsCreate();
-  init_operations();
+  init_components();
   init_tools();
   args16 = {
-    requestBody: nullableType(CreateCheckoutSessionBody$inboundSchema).optional(),
+    checkoutSessionCreate: CheckoutSessionCreate$inboundSchema.optional(),
     timeoutInSeconds: numberType().default(1),
     merchantAccountId: nullableType(stringType()).optional()
   };
@@ -49627,7 +49598,7 @@ var init_checkoutSessionsCreate2 = __esm(() => {
 Create a new checkout session.`,
     args: args16,
     tool: async (client, args17, ctx) => {
-      const [result, apiCall] = await checkoutSessionsCreate(client, args17.requestBody, args17.timeoutInSeconds, args17.merchantAccountId, { fetchOptions: { signal: ctx.signal } }).$inspect();
+      const [result, apiCall] = await checkoutSessionsCreate(client, args17.checkoutSessionCreate, args17.timeoutInSeconds, args17.merchantAccountId, { fetchOptions: { signal: ctx.signal } }).$inspect();
       if (!result.ok) {
         return {
           content: [{ type: "text", text: result.error.message }],
@@ -49917,12 +49888,12 @@ Retrieve the information stored on a checkout session.`,
 });
 
 // src/funcs/checkoutSessionsUpdate.ts
-function checkoutSessionsUpdate(client, checkoutSessionUpdate, sessionId, timeoutInSeconds, merchantAccountId, options) {
-  return new APIPromise($do19(client, checkoutSessionUpdate, sessionId, timeoutInSeconds, merchantAccountId, options));
+function checkoutSessionsUpdate(client, checkoutSessionCreate, sessionId, timeoutInSeconds, merchantAccountId, options) {
+  return new APIPromise($do19(client, checkoutSessionCreate, sessionId, timeoutInSeconds, merchantAccountId, options));
 }
-async function $do19(client, checkoutSessionUpdate, sessionId, timeoutInSeconds, merchantAccountId, options) {
+async function $do19(client, checkoutSessionCreate, sessionId, timeoutInSeconds, merchantAccountId, options) {
   const input = {
-    checkoutSessionUpdate,
+    checkoutSessionCreate,
     sessionId,
     timeoutInSeconds,
     merchantAccountId
@@ -49932,7 +49903,7 @@ async function $do19(client, checkoutSessionUpdate, sessionId, timeoutInSeconds,
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.CheckoutSessionUpdate, {
+  const body = encodeJSON("body", payload.CheckoutSessionCreate, {
     explode: true
   });
   const pathParams = {
@@ -50031,7 +50002,7 @@ var init_checkoutSessionsUpdate2 = __esm(() => {
   init_components();
   init_tools();
   args19 = {
-    checkoutSessionUpdate: CheckoutSessionUpdate$inboundSchema,
+    checkoutSessionCreate: CheckoutSessionCreate$inboundSchema,
     sessionId: stringType(),
     timeoutInSeconds: numberType().default(1),
     merchantAccountId: nullableType(stringType()).optional()
@@ -50043,7 +50014,7 @@ var init_checkoutSessionsUpdate2 = __esm(() => {
 Update the information stored on a checkout session.`,
     args: args19,
     tool: async (client, args20, ctx) => {
-      const [result, apiCall] = await checkoutSessionsUpdate(client, args20.checkoutSessionUpdate, args20.sessionId, args20.timeoutInSeconds, args20.merchantAccountId, { fetchOptions: { signal: ctx.signal } }).$inspect();
+      const [result, apiCall] = await checkoutSessionsUpdate(client, args20.checkoutSessionCreate, args20.sessionId, args20.timeoutInSeconds, args20.merchantAccountId, { fetchOptions: { signal: ctx.signal } }).$inspect();
       if (!result.ok) {
         return {
           content: [{ type: "text", text: result.error.message }],
@@ -57950,7 +57921,7 @@ Void a previously authorized transaction.`,
 function createMCPServer(deps) {
   const server = new McpServer({
     name: "Gr4vy",
-    version: "1.0.0-beta.7"
+    version: "1.0.0-beta.9"
   });
   const client = new Gr4vyCore({
     bearerAuth: deps.bearerAuth,
@@ -59336,7 +59307,7 @@ var routes = an({
 var app = He(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.0.0-beta.7"
+    currentVersion: "1.0.0-beta.9"
   }
 });
 zt(app, process3.argv.slice(2), buildContext(process3));
@@ -59344,5 +59315,5 @@ export {
   app
 };
 
-//# debugId=DD37E18A2F684BB364756E2164756E21
+//# debugId=F198218B002EF47D64756E2164756E21
 //# sourceMappingURL=mcp-server.js.map