@stigg/typescript 0.1.0-alpha.3 → 0.1.0-alpha.4

package/src/resources/v1/customers/customers.ts

@@ -3,8 +3,14 @@
 import { APIResource } from '../../../core/resource';
 import * as PaymentMethodAPI from './payment-method';
 import { PaymentMethod, PaymentMethodAttachParams } from './payment-method';
-import * as UsageAPI from './usage';
-import { Usage } from './usage';
+import * as PromotionalEntitlementsAPI from './promotional-entitlements';
+import {
+  PromotionalEntitlementGrantParams,
+  PromotionalEntitlementGrantResponse,
+  PromotionalEntitlementRevokeParams,
+  PromotionalEntitlementRevokeResponse,
+  PromotionalEntitlements,
+} from './promotional-entitlements';
 import { APIPromise } from '../../../core/api-promise';
 import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
@@ -12,14 +18,8 @@ import { path } from '../../../internal/utils/path';
 
 export class Customers extends APIResource {
   paymentMethod: PaymentMethodAPI.PaymentMethod = new PaymentMethodAPI.PaymentMethod(this._client);
-  usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
-
-  /**
-   * Provision customer
-   */
-  create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
-    return this._client.post('/api/v1/customers', { body, ...options });
-  }
+  promotionalEntitlements: PromotionalEntitlementsAPI.PromotionalEntitlements =
+    new PromotionalEntitlementsAPI.PromotionalEntitlements(this._client);
 
   /**
    * Get a single customer by ID
@@ -55,6 +55,20 @@ export class Customers extends APIResource {
     return this._client.post(path`/api/v1/customers/${id}/archive`, options);
   }
 
+  /**
+   * Bulk import customers
+   */
+  import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
+    return this._client.post('/api/v1/customers/import', { body, ...options });
+  }
+
+  /**
+   * Provision customer
+   */
+  provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse> {
+    return this._client.post('/api/v1/customers', { body, ...options });
+  }
+
   /**
    * Unarchive customer
    */
@@ -311,21 +325,33 @@ export namespace CustomerListResponse {
   }
 }
 
-export interface CustomerCreateParams {
+/**
+ * Response object
+ */
+export interface CustomerImportResponse {
   /**
-   * Customer slug
+   * List of newly created customer IDs from the import operation.
    */
-  id: string;
+  data: CustomerImportResponse.Data;
+}
 
+export namespace CustomerImportResponse {
   /**
-   * Customer level coupon
+   * List of newly created customer IDs from the import operation.
    */
-  couponId?: string | null;
+  export interface Data {
+    /**
+     * Customer IDs created during import
+     */
+    newCustomers: Array<string>;
+  }
+}
 
+export interface CustomerUpdateParams {
   /**
-   * The default payment method details
+   * Customer level coupon
    */
-  defaultPaymentMethod?: CustomerCreateParams.DefaultPaymentMethod | null;
+  couponId?: string | null;
 
   /**
    * The email of the customer
@@ -335,7 +361,7 @@ export interface CustomerCreateParams {
   /**
    * List of integrations
    */
-  integrations?: Array<CustomerCreateParams.Integration>;
+  integrations?: Array<CustomerUpdateParams.Integration>;
 
   /**
    * Additional metadata
@@ -348,37 +374,7 @@ export interface CustomerCreateParams {
   name?: string | null;
 }
 
-export namespace CustomerCreateParams {
-  /**
-   * The default payment method details
-   */
-  export interface DefaultPaymentMethod {
-    /**
-     * The default payment method id
-     */
-    billingId: string | null;
-
-    /**
-     * The expiration month of the default payment method
-     */
-    cardExpiryMonth: number | null;
-
-    /**
-     * The expiration year of the default payment method
-     */
-    cardExpiryYear: number | null;
-
-    /**
-     * The last 4 digits of the default payment method
-     */
-    cardLast4Digits: string | null;
-
-    /**
-     * The default payment method type
-     */
-    type: 'CARD' | 'BANK' | 'CASH_APP';
-  }
-
+export namespace CustomerUpdateParams {
   /**
    * External billing or CRM integration link
    */
@@ -410,12 +406,65 @@ export namespace CustomerCreateParams {
   }
 }
 
-export interface CustomerUpdateParams {
+export interface CustomerListParams extends MyCursorIDPageParams {}
+
+export interface CustomerImportParams {
+  /**
+   * List of customer objects to import
+   */
+  customers: Array<CustomerImportParams.Customer>;
+}
+
+export namespace CustomerImportParams {
+  export interface Customer {
+    /**
+     * Customer slug
+     */
+    id: string;
+
+    /**
+     * The email of the customer
+     */
+    email: string | null;
+
+    /**
+     * The name of the customer
+     */
+    name: string | null;
+
+    /**
+     * Additional metadata
+     */
+    metadata?: { [key: string]: string };
+
+    /**
+     * Billing provider payment method id
+     */
+    paymentMethodId?: string;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt?: string;
+  }
+}
+
+export interface CustomerProvisionParams {
+  /**
+   * Customer slug
+   */
+  id: string;
+
   /**
    * Customer level coupon
    */
   couponId?: string | null;
 
+  /**
+   * The default payment method details
+   */
+  defaultPaymentMethod?: CustomerProvisionParams.DefaultPaymentMethod | null;
+
   /**
    * The email of the customer
    */
@@ -424,7 +473,7 @@ export interface CustomerUpdateParams {
   /**
    * List of integrations
    */
-  integrations?: Array<CustomerUpdateParams.Integration>;
+  integrations?: Array<CustomerProvisionParams.Integration>;
 
   /**
    * Additional metadata
@@ -437,7 +486,37 @@ export interface CustomerUpdateParams {
   name?: string | null;
 }
 
-export namespace CustomerUpdateParams {
+export namespace CustomerProvisionParams {
+  /**
+   * The default payment method details
+   */
+  export interface DefaultPaymentMethod {
+    /**
+     * The default payment method id
+     */
+    billingId: string | null;
+
+    /**
+     * The expiration month of the default payment method
+     */
+    cardExpiryMonth: number | null;
+
+    /**
+     * The expiration year of the default payment method
+     */
+    cardExpiryYear: number | null;
+
+    /**
+     * The last 4 digits of the default payment method
+     */
+    cardLast4Digits: string | null;
+
+    /**
+     * The default payment method type
+     */
+    type: 'CARD' | 'BANK' | 'CASH_APP';
+  }
+
   /**
    * External billing or CRM integration link
    */
@@ -469,22 +548,28 @@ export namespace CustomerUpdateParams {
   }
 }
 
-export interface CustomerListParams extends MyCursorIDPageParams {}
-
 Customers.PaymentMethod = PaymentMethod;
-Customers.Usage = Usage;
+Customers.PromotionalEntitlements = PromotionalEntitlements;
 
 export declare namespace Customers {
   export {
     type CustomerResponse as CustomerResponse,
     type CustomerListResponse as CustomerListResponse,
+    type CustomerImportResponse as CustomerImportResponse,
     type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
-    type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
     type CustomerListParams as CustomerListParams,
+    type CustomerImportParams as CustomerImportParams,
+    type CustomerProvisionParams as CustomerProvisionParams,
   };
 
   export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
 
-  export { Usage as Usage };
+  export {
+    PromotionalEntitlements as PromotionalEntitlements,
+    type PromotionalEntitlementGrantResponse as PromotionalEntitlementGrantResponse,
+    type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse,
+    type PromotionalEntitlementGrantParams as PromotionalEntitlementGrantParams,
+    type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
+  };
 }

package/src/resources/v1/customers/index.ts

@@ -4,10 +4,18 @@ export {
   Customers,
   type CustomerResponse,
   type CustomerListResponse,
-  type CustomerCreateParams,
+  type CustomerImportResponse,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerImportParams,
+  type CustomerProvisionParams,
   type CustomerListResponsesMyCursorIDPage,
 } from './customers';
 export { PaymentMethod, type PaymentMethodAttachParams } from './payment-method';
-export { Usage } from './usage';
+export {
+  PromotionalEntitlements,
+  type PromotionalEntitlementGrantResponse,
+  type PromotionalEntitlementRevokeResponse,
+  type PromotionalEntitlementGrantParams,
+  type PromotionalEntitlementRevokeParams,
+} from './promotional-entitlements';