@snagsolutions/sdk 0.1.0-alpha.10

package/src/resources/loyalty/multipliers.ts

@@ -0,0 +1,238 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+
+export class Multipliers extends APIResource {
+  /**
+   * Create a new loyalty multiplier for a wallet.
+   */
+  create(
+    body: MultiplierCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MultiplierCreateResponse> {
+    return this._client.post('/api/loyalty/multipliers', { body, ...options });
+  }
+
+  /**
+   * Update an existing loyalty multiplier.
+   */
+  update(
+    multiplierId: string,
+    body?: MultiplierUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MultiplierUpdateResponse>;
+  update(multiplierId: string, options?: Core.RequestOptions): Core.APIPromise<MultiplierUpdateResponse>;
+  update(
+    multiplierId: string,
+    body: MultiplierUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MultiplierUpdateResponse> {
+    if (isRequestOptions(body)) {
+      return this.update(multiplierId, {}, body);
+    }
+    return this._client.post(`/api/loyalty/multipliers/${multiplierId}`, { body, ...options });
+  }
+
+  /**
+   * Get Loyalty Multipliers
+   */
+  list(query?: MultiplierListParams, options?: Core.RequestOptions): Core.APIPromise<MultiplierListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<MultiplierListResponse>;
+  list(
+    query: MultiplierListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MultiplierListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/api/loyalty/multipliers', { query, ...options });
+  }
+
+  /**
+   * Delete a loyalty multiplier by its ID.
+   */
+  delete(multiplierId: string, options?: Core.RequestOptions): Core.APIPromise<MultiplierDeleteResponse> {
+    return this._client.delete(`/api/loyalty/multipliers/${multiplierId}`, options);
+  }
+}
+
+/**
+ * Schema for loyalty multiplier
+ */
+export interface MultiplierCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  deletedAt: string | null;
+
+  description: string | null;
+
+  externalIdentifier: string | null;
+
+  multiplier: number;
+
+  organizationId: string;
+
+  title: string | null;
+
+  updatedAt: string;
+
+  user: MultiplierCreateResponse.User;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export namespace MultiplierCreateResponse {
+  export interface User {
+    id: string;
+
+    walletAddress: string;
+  }
+}
+
+/**
+ * Schema for loyalty multiplier
+ */
+export interface MultiplierUpdateResponse {
+  id: string;
+
+  createdAt: string;
+
+  deletedAt: string | null;
+
+  description: string | null;
+
+  externalIdentifier: string | null;
+
+  multiplier: number;
+
+  organizationId: string;
+
+  title: string | null;
+
+  updatedAt: string;
+
+  user: MultiplierUpdateResponse.User;
+
+  userId: string;
+
+  websiteId: string;
+}
+
+export namespace MultiplierUpdateResponse {
+  export interface User {
+    id: string;
+
+    walletAddress: string;
+  }
+}
+
+export interface MultiplierListResponse {
+  data: Array<MultiplierListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace MultiplierListResponse {
+  /**
+   * Schema for loyalty multiplier
+   */
+  export interface Data {
+    id: string;
+
+    createdAt: string;
+
+    deletedAt: string | null;
+
+    description: string | null;
+
+    externalIdentifier: string | null;
+
+    multiplier: number;
+
+    organizationId: string;
+
+    title: string | null;
+
+    updatedAt: string;
+
+    user: Data.User;
+
+    userId: string;
+
+    websiteId: string;
+  }
+
+  export namespace Data {
+    export interface User {
+      id: string;
+
+      walletAddress: string;
+    }
+  }
+}
+
+export interface MultiplierDeleteResponse {
+  id: string;
+}
+
+export interface MultiplierCreateParams {
+  multiplier: number;
+
+  walletAddress: string;
+
+  description?: string | null;
+
+  externalIdentifier?: string | null;
+
+  title?: string | null;
+}
+
+export interface MultiplierUpdateParams {
+  description?: string | null;
+
+  multiplier?: number;
+
+  title?: string | null;
+}
+
+export interface MultiplierListParams {
+  discordUser?: string;
+
+  externalIdentifier?: string;
+
+  includeDeleted?: boolean;
+
+  limit?: number;
+
+  organizationId?: string;
+
+  startingAfter?: string;
+
+  twitterUser?: string;
+
+  userId?: string | Array<string>;
+
+  walletAddress?: string | Array<string>;
+
+  walletGroupIdentifier?: string;
+
+  websiteId?: string;
+}
+
+export declare namespace Multipliers {
+  export {
+    type MultiplierCreateResponse as MultiplierCreateResponse,
+    type MultiplierUpdateResponse as MultiplierUpdateResponse,
+    type MultiplierListResponse as MultiplierListResponse,
+    type MultiplierDeleteResponse as MultiplierDeleteResponse,
+    type MultiplierCreateParams as MultiplierCreateParams,
+    type MultiplierUpdateParams as MultiplierUpdateParams,
+    type MultiplierListParams as MultiplierListParams,
+  };
+}

package/src/resources/loyalty/rule-edits.ts

@@ -0,0 +1,421 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class RuleEdits extends APIResource {
+  /**
+   * Retrieve configured loyalty rule edits with optional pagination and filters
+   */
+  retrieve(
+    query: RuleEditRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleEditRetrieveResponse> {
+    return this._client.get('/api/loyalty/rule_edits', { query, ...options });
+  }
+
+  /**
+   * Restore a loyalty rule from a rule edit
+   */
+  restore(
+    id: string,
+    body?: RuleEditRestoreParams | null | undefined,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleEditRestoreResponse> {
+    return this._client.post(`/api/api/loyalty/rule_edits/${id}/restore`, { body, ...options });
+  }
+}
+
+export interface RuleEditRetrieveResponse {
+  data: Array<RuleEditRetrieveResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace RuleEditRetrieveResponse {
+  export interface Data {
+    /**
+     * Unique identifier for the rule edit
+     */
+    id: string;
+
+    /**
+     * Type of action that was made on the rule
+     */
+    action: 'create' | 'update' | 'delete' | 'restore';
+
+    /**
+     * Data that was changed on the rule
+     */
+    data: Data.Data;
+
+    /**
+     * Timestamp of when the rule edit was made
+     */
+    editedAt: string;
+
+    /**
+     * User ID of the user who made the edit
+     */
+    editedByUserId: string;
+
+    /**
+     * ID of the loyalty rule
+     */
+    loyaltyRuleId: string;
+
+    /**
+     * Unique identifier for the organization
+     */
+    organizationId: string;
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+
+    /**
+     * Comment that was made on the edit
+     */
+    comment?: string;
+
+    /**
+     * Previous data of the rule before the edit
+     */
+    previousData?: Data.PreviousData;
+  }
+
+  export namespace Data {
+    /**
+     * Data that was changed on the rule
+     */
+    export interface Data {
+      /**
+       * Unique identifier for the loyalty rule
+       */
+      id: string;
+
+      /**
+       * Amount associated with the loyalty rule
+       */
+      amount: number;
+
+      /**
+       * Timestamp when the loyalty rule was created
+       */
+      createdAt: string;
+
+      /**
+       * Timestamp when the loyalty rule was deleted (if applicable)
+       */
+      deletedAt: string | null;
+
+      /**
+       * Frequency of the loyalty rule
+       */
+      frequency: string;
+
+      /**
+       * Unique identifier for the organization
+       */
+      organizationId: string;
+
+      /**
+       * Type of the loyalty rule
+       */
+      type: string;
+
+      /**
+       * Timestamp when the loyalty rule was last updated
+       */
+      updatedAt: string;
+
+      /**
+       * Unique identifier for the website
+       */
+      websiteId: string;
+
+      /**
+       * Optional address of the collection
+       */
+      collectionAddress?: string;
+
+      /**
+       * Optional metadata for the loyalty rule
+       */
+      metadata?: Record<string, unknown>;
+    }
+
+    /**
+     * Previous data of the rule before the edit
+     */
+    export interface PreviousData {
+      /**
+       * Unique identifier for the loyalty rule
+       */
+      id: string;
+
+      /**
+       * Amount associated with the loyalty rule
+       */
+      amount: number;
+
+      /**
+       * Timestamp when the loyalty rule was created
+       */
+      createdAt: string;
+
+      /**
+       * Timestamp when the loyalty rule was deleted (if applicable)
+       */
+      deletedAt: string | null;
+
+      /**
+       * Frequency of the loyalty rule
+       */
+      frequency: string;
+
+      /**
+       * Unique identifier for the organization
+       */
+      organizationId: string;
+
+      /**
+       * Type of the loyalty rule
+       */
+      type: string;
+
+      /**
+       * Timestamp when the loyalty rule was last updated
+       */
+      updatedAt: string;
+
+      /**
+       * Unique identifier for the website
+       */
+      websiteId: string;
+
+      /**
+       * Optional address of the collection
+       */
+      collectionAddress?: string;
+
+      /**
+       * Optional metadata for the loyalty rule
+       */
+      metadata?: Record<string, unknown>;
+    }
+  }
+}
+
+export interface RuleEditRestoreResponse {
+  /**
+   * Unique identifier for the rule edit
+   */
+  id: string;
+
+  /**
+   * Type of action that was made on the rule
+   */
+  action: 'create' | 'update' | 'delete' | 'restore';
+
+  /**
+   * Data that was changed on the rule
+   */
+  data: RuleEditRestoreResponse.Data;
+
+  /**
+   * Timestamp of when the rule edit was made
+   */
+  editedAt: string;
+
+  /**
+   * User ID of the user who made the edit
+   */
+  editedByUserId: string;
+
+  /**
+   * ID of the loyalty rule
+   */
+  loyaltyRuleId: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  /**
+   * Comment that was made on the edit
+   */
+  comment?: string;
+
+  /**
+   * Previous data of the rule before the edit
+   */
+  previousData?: RuleEditRestoreResponse.PreviousData;
+}
+
+export namespace RuleEditRestoreResponse {
+  /**
+   * Data that was changed on the rule
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the loyalty rule
+     */
+    id: string;
+
+    /**
+     * Amount associated with the loyalty rule
+     */
+    amount: number;
+
+    /**
+     * Timestamp when the loyalty rule was created
+     */
+    createdAt: string;
+
+    /**
+     * Timestamp when the loyalty rule was deleted (if applicable)
+     */
+    deletedAt: string | null;
+
+    /**
+     * Frequency of the loyalty rule
+     */
+    frequency: string;
+
+    /**
+     * Unique identifier for the organization
+     */
+    organizationId: string;
+
+    /**
+     * Type of the loyalty rule
+     */
+    type: string;
+
+    /**
+     * Timestamp when the loyalty rule was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+
+    /**
+     * Optional address of the collection
+     */
+    collectionAddress?: string;
+
+    /**
+     * Optional metadata for the loyalty rule
+     */
+    metadata?: Record<string, unknown>;
+  }
+
+  /**
+   * Previous data of the rule before the edit
+   */
+  export interface PreviousData {
+    /**
+     * Unique identifier for the loyalty rule
+     */
+    id: string;
+
+    /**
+     * Amount associated with the loyalty rule
+     */
+    amount: number;
+
+    /**
+     * Timestamp when the loyalty rule was created
+     */
+    createdAt: string;
+
+    /**
+     * Timestamp when the loyalty rule was deleted (if applicable)
+     */
+    deletedAt: string | null;
+
+    /**
+     * Frequency of the loyalty rule
+     */
+    frequency: string;
+
+    /**
+     * Unique identifier for the organization
+     */
+    organizationId: string;
+
+    /**
+     * Type of the loyalty rule
+     */
+    type: string;
+
+    /**
+     * Timestamp when the loyalty rule was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+
+    /**
+     * Optional address of the collection
+     */
+    collectionAddress?: string;
+
+    /**
+     * Optional metadata for the loyalty rule
+     */
+    metadata?: Record<string, unknown>;
+  }
+}
+
+export interface RuleEditRetrieveParams {
+  /**
+   * ID of the loyalty rule
+   */
+  loyaltyRuleId: boolean;
+
+  /**
+   * Maximum number of edits to return
+   */
+  limit?: number | null;
+
+  /**
+   * Unique identifier for the organization to filter by
+   */
+  organizationId?: string;
+
+  /**
+   * Pagination cursor to start after a specific rule edit ID
+   */
+  startingAfter?: string;
+
+  /**
+   * Unique identifier for the website to filter by
+   */
+  websiteId?: string;
+}
+
+export interface RuleEditRestoreParams {}
+
+export declare namespace RuleEdits {
+  export {
+    type RuleEditRetrieveResponse as RuleEditRetrieveResponse,
+    type RuleEditRestoreResponse as RuleEditRestoreResponse,
+    type RuleEditRetrieveParams as RuleEditRetrieveParams,
+    type RuleEditRestoreParams as RuleEditRestoreParams,
+  };
+}