feat(api): clean up ambiguous types, rm installment amounts (#7)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 1
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/flowglad%2Fflowglad-21870271879fc260da63af686a116fc7e99c28c684ca92c127d6d9cbbd456c46.yml
+configured_endpoints: 11
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/flowglad%2Fflowglad-f8356bf4639d34c01c43a6911b1076905884a152b63f60872f2db5b96bfb7169.yml

api.md

@@ -1,9 +1,61 @@
+# PurchaseSessions
+
+Types:
+
+- <code><a href="./src/resources/purchase-sessions.ts">PurchaseSessionCreateResponse</a></code>
+
+Methods:
+
+- <code title="post /api/v1/purchase-sessions">client.purchaseSessions.<a href="./src/resources/purchase-sessions.ts">create</a>({ ...params }) -> PurchaseSessionCreateResponse</code>
+
+# Products
+
+Types:
+
+- <code><a href="./src/resources/products.ts">ProductCreateResponse</a></code>
+- <code><a href="./src/resources/products.ts">ProductUpdateResponse</a></code>
+- <code><a href="./src/resources/products.ts">ProductListResponse</a></code>
+
+Methods:
+
+- <code title="post /api/v1/products">client.products.<a href="./src/resources/products.ts">create</a>({ ...params }) -> ProductCreateResponse</code>
+- <code title="put /api/v1/products/{id}">client.products.<a href="./src/resources/products.ts">update</a>(id, { ...params }) -> ProductUpdateResponse</code>
+- <code title="get /api/v1/products">client.products.<a href="./src/resources/products.ts">list</a>({ ...params }) -> ProductListResponse</code>
+
+# Variants
+
+Types:
+
+- <code><a href="./src/resources/variants.ts">VariantCreateResponse</a></code>
+- <code><a href="./src/resources/variants.ts">VariantUpdateResponse</a></code>
+- <code><a href="./src/resources/variants.ts">VariantListResponse</a></code>
+
+Methods:
+
+- <code title="post /api/v1/variants">client.variants.<a href="./src/resources/variants.ts">create</a>({ ...params }) -> VariantCreateResponse</code>
+- <code title="put /api/v1/variants/{id}">client.variants.<a href="./src/resources/variants.ts">update</a>(id, { ...params }) -> VariantUpdateResponse</code>
+- <code title="get /api/v1/variants">client.variants.<a href="./src/resources/variants.ts">list</a>({ ...params }) -> VariantListResponse</code>
+
 # CustomerProfiles
 
 Types:
 
-- <code><a href="./src/resources/customer-profiles.ts">CustomerProfileCreateResponse</a></code>
+- <code><a href="./src/resources/customer-profiles/customer-profiles.ts">CustomerProfileCreateResponse</a></code>
+- <code><a href="./src/resources/customer-profiles/customer-profiles.ts">CustomerProfileRetrieveResponse</a></code>
+- <code><a href="./src/resources/customer-profiles/customer-profiles.ts">CustomerProfileUpdateResponse</a></code>
+
+Methods:
+
+- <code title="post /api/v1/customer-profiles">client.customerProfiles.<a href="./src/resources/customer-profiles/customer-profiles.ts">create</a>({ ...params }) -> CustomerProfileCreateResponse</code>
+- <code title="get /api/v1/customer-profiles/{externalId}">client.customerProfiles.<a href="./src/resources/customer-profiles/customer-profiles.ts">retrieve</a>(externalId) -> CustomerProfileRetrieveResponse</code>
+- <code title="put /api/v1/customer-profiles/{externalId}">client.customerProfiles.<a href="./src/resources/customer-profiles/customer-profiles.ts">update</a>(externalId, { ...params }) -> CustomerProfileUpdateResponse</code>
+
+## Billing
+
+Types:
+
+- <code><a href="./src/resources/customer-profiles/billing.ts">BillingRetrieveResponse</a></code>
 
 Methods:
 
-- <code title="post /api/v1/customer-profiles">client.customerProfiles.<a href="./src/resources/customer-profiles.ts">create</a>({ ...params }) -> CustomerProfileCreateResponse</code>
+- <code title="get /api/v1/customer-profiles/{externalId}/billing">client.customerProfiles.billing.<a href="./src/resources/customer-profiles/billing.ts">retrieve</a>(externalId) -> BillingRetrieveResponse</code>

src/index.ts

@@ -5,11 +5,37 @@ import * as Core from './core';
 import * as Errors from './error';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
+import {
+  ProductCreateParams,
+  ProductCreateResponse,
+  ProductListParams,
+  ProductListResponse,
+  ProductUpdateParams,
+  ProductUpdateResponse,
+  Products,
+} from './resources/products';
+import {
+  PurchaseSessionCreateParams,
+  PurchaseSessionCreateResponse,
+  PurchaseSessions,
+} from './resources/purchase-sessions';
+import {
+  VariantCreateParams,
+  VariantCreateResponse,
+  VariantListParams,
+  VariantListResponse,
+  VariantUpdateParams,
+  VariantUpdateResponse,
+  Variants,
+} from './resources/variants';
 import {
   CustomerProfileCreateParams,
   CustomerProfileCreateResponse,
+  CustomerProfileRetrieveResponse,
+  CustomerProfileUpdateParams,
+  CustomerProfileUpdateResponse,
   CustomerProfiles,
-} from './resources/customer-profiles';
+} from './resources/customer-profiles/customer-profiles';
 
 const environments = {
   production: 'https://app.flowglad.com/api/v1',
@@ -19,7 +45,7 @@ type Environment = keyof typeof environments;
 
 export interface ClientOptions {
   /**
-   * API key used for authentication in the 'Authorization' header
+   * API key required for authentication, provided in the 'Authorization' header.
    */
   apiKey?: string | undefined;
 
@@ -100,7 +126,7 @@ export class Flowglad extends Core.APIClient {
   /**
    * API Client for interfacing with the Flowglad API.
    *
-   * @param {string | undefined} [opts.apiKey=process.env['FLOWGLAD_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.apiKey=process.env['AUTHORIZATION_KEY'] ?? undefined]
    * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
    * @param {string} [opts.baseURL=process.env['FLOWGLAD_BASE_URL'] ?? https://app.flowglad.com/api/v1] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
@@ -112,12 +138,12 @@ export class Flowglad extends Core.APIClient {
    */
   constructor({
     baseURL = Core.readEnv('FLOWGLAD_BASE_URL'),
-    apiKey = Core.readEnv('FLOWGLAD_API_KEY'),
+    apiKey = Core.readEnv('AUTHORIZATION_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Errors.FlowgladError(
-        "The FLOWGLAD_API_KEY environment variable is missing or empty; either provide it, or instantiate the Flowglad client with an apiKey option, like new Flowglad({ apiKey: 'My API Key' }).",
+        "The AUTHORIZATION_KEY environment variable is missing or empty; either provide it, or instantiate the Flowglad client with an apiKey option, like new Flowglad({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -147,6 +173,9 @@ export class Flowglad extends Core.APIClient {
     this.apiKey = apiKey;
   }
 
+  purchaseSessions: API.PurchaseSessions = new API.PurchaseSessions(this);
+  products: API.Products = new API.Products(this);
+  variants: API.Variants = new API.Variants(this);
   customerProfiles: API.CustomerProfiles = new API.CustomerProfiles(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
@@ -185,14 +214,46 @@ export class Flowglad extends Core.APIClient {
   static fileFromPath = Uploads.fileFromPath;
 }
 
+Flowglad.PurchaseSessions = PurchaseSessions;
+Flowglad.Products = Products;
+Flowglad.Variants = Variants;
 Flowglad.CustomerProfiles = CustomerProfiles;
 export declare namespace Flowglad {
   export type RequestOptions = Core.RequestOptions;
 
+  export {
+    PurchaseSessions as PurchaseSessions,
+    type PurchaseSessionCreateResponse as PurchaseSessionCreateResponse,
+    type PurchaseSessionCreateParams as PurchaseSessionCreateParams,
+  };
+
+  export {
+    Products as Products,
+    type ProductCreateResponse as ProductCreateResponse,
+    type ProductUpdateResponse as ProductUpdateResponse,
+    type ProductListResponse as ProductListResponse,
+    type ProductCreateParams as ProductCreateParams,
+    type ProductUpdateParams as ProductUpdateParams,
+    type ProductListParams as ProductListParams,
+  };
+
+  export {
+    Variants as Variants,
+    type VariantCreateResponse as VariantCreateResponse,
+    type VariantUpdateResponse as VariantUpdateResponse,
+    type VariantListResponse as VariantListResponse,
+    type VariantCreateParams as VariantCreateParams,
+    type VariantUpdateParams as VariantUpdateParams,
+    type VariantListParams as VariantListParams,
+  };
+
   export {
     CustomerProfiles as CustomerProfiles,
     type CustomerProfileCreateResponse as CustomerProfileCreateResponse,
+    type CustomerProfileRetrieveResponse as CustomerProfileRetrieveResponse,
+    type CustomerProfileUpdateResponse as CustomerProfileUpdateResponse,
     type CustomerProfileCreateParams as CustomerProfileCreateParams,
+    type CustomerProfileUpdateParams as CustomerProfileUpdateParams,
   };
 }