@snagsolutions/sdk 0.1.0-alpha.10

package/src/resources/loyalty/currencies.ts

@@ -0,0 +1,321 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Currencies extends APIResource {
+  /**
+   * Create a loyalty currency
+   */
+  create(body: CurrencyCreateParams, options?: Core.RequestOptions): Core.APIPromise<CurrencyCreateResponse> {
+    return this._client.post('/api/loyalty/currencies', { body, ...options });
+  }
+
+  /**
+   * Get loyalty currencies
+   */
+  list(query: CurrencyListParams, options?: Core.RequestOptions): Core.APIPromise<CurrencyListResponse> {
+    return this._client.get('/api/loyalty/currencies', { query, ...options });
+  }
+}
+
+/**
+ * Schema for a loyalty currency
+ */
+export interface CurrencyCreateResponse {
+  /**
+   * Unique identifier for the loyalty currency
+   */
+  id: string;
+
+  /**
+   * Authentication key for API
+   */
+  apiAuthKey: string | null;
+
+  /**
+   * Type of authentication used for API
+   */
+  apiAuthType: 'none' | 'basic' | 'bearer' | 'apiKey' | null;
+
+  /**
+   * Authentication value for API
+   */
+  apiAuthValue: string | null;
+
+  /**
+   * API GET URL for fetching transaction entry data
+   */
+  apiGetTransactionEntryUrl: string | null;
+
+  /**
+   * API GET URL for fetching data
+   */
+  apiGetUrl: string | null;
+
+  /**
+   * API POST URL for sending data
+   */
+  apiPostUrl: string | null;
+
+  /**
+   * Timestamp when the currency was created
+   */
+  createdAt: string;
+
+  /**
+   * ID of the user who created the currency
+   */
+  createdById: string | null;
+
+  /**
+   * Number of decimal places for the currency
+   */
+  decimals: number;
+
+  /**
+   * Timestamp when the currency was deleted, if applicable
+   */
+  deletedAt: string | null;
+
+  /**
+   * URL of the image
+   */
+  imageUrl: string | null;
+
+  /**
+   * Name of the loyalty currency
+   */
+  name: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Sorting identifier
+   */
+  sortId: number | null;
+
+  /**
+   * Symbol representing the loyalty currency
+   */
+  symbol: string;
+
+  /**
+   * Timestamp when the currency was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+}
+
+export interface CurrencyListResponse {
+  data: Array<CurrencyListResponse.Data>;
+
+  hasNextPage: boolean;
+}
+
+export namespace CurrencyListResponse {
+  /**
+   * Schema for a loyalty currency
+   */
+  export interface Data {
+    /**
+     * Unique identifier for the loyalty currency
+     */
+    id: string;
+
+    /**
+     * Authentication key for API
+     */
+    apiAuthKey: string | null;
+
+    /**
+     * Type of authentication used for API
+     */
+    apiAuthType: 'none' | 'basic' | 'bearer' | 'apiKey' | null;
+
+    /**
+     * Authentication value for API
+     */
+    apiAuthValue: string | null;
+
+    /**
+     * API GET URL for fetching transaction entry data
+     */
+    apiGetTransactionEntryUrl: string | null;
+
+    /**
+     * API GET URL for fetching data
+     */
+    apiGetUrl: string | null;
+
+    /**
+     * API POST URL for sending data
+     */
+    apiPostUrl: string | null;
+
+    /**
+     * Timestamp when the currency was created
+     */
+    createdAt: string;
+
+    /**
+     * ID of the user who created the currency
+     */
+    createdById: string | null;
+
+    /**
+     * Number of decimal places for the currency
+     */
+    decimals: number;
+
+    /**
+     * Timestamp when the currency was deleted, if applicable
+     */
+    deletedAt: string | null;
+
+    /**
+     * URL of the image
+     */
+    imageUrl: string | null;
+
+    /**
+     * Name of the loyalty currency
+     */
+    name: string;
+
+    /**
+     * Unique identifier for the organization
+     */
+    organizationId: string;
+
+    /**
+     * Sorting identifier
+     */
+    sortId: number | null;
+
+    /**
+     * Symbol representing the loyalty currency
+     */
+    symbol: string;
+
+    /**
+     * Timestamp when the currency was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+  }
+}
+
+export interface CurrencyCreateParams {
+  /**
+   * Number of decimal places for the currency
+   */
+  decimals: number;
+
+  /**
+   * Name of the loyalty currency
+   */
+  name: string;
+
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Symbol representing the loyalty currency
+   */
+  symbol: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  /**
+   * Authentication key for API
+   */
+  apiAuthKey?: string | null;
+
+  /**
+   * Type of authentication used for API
+   */
+  apiAuthType?: 'none' | 'basic' | 'bearer' | 'apiKey' | null;
+
+  /**
+   * Authentication value for API
+   */
+  apiAuthValue?: string | null;
+
+  /**
+   * Optional API GET URL for fetching transaction entry data
+   */
+  apiGetTransactionEntryUrl?: string | null;
+
+  /**
+   * Optional API GET URL for fetching data
+   */
+  apiGetUrl?: string | null;
+
+  /**
+   * Optional API POST URL for sending data
+   */
+  apiPostUrl?: string | null;
+
+  /**
+   * URL of the image; must start with AWS S3 asset URL base
+   */
+  imageUrl?: string | null;
+
+  /**
+   * Optional sorting identifier
+   */
+  sortId?: number;
+}
+
+export interface CurrencyListParams {
+  /**
+   * Unique identifier for the organization
+   */
+  organizationId: string;
+
+  /**
+   * Unique identifier for the website
+   */
+  websiteId: string;
+
+  /**
+   * Whether to include deleted currencies
+   */
+  includeDeleted?: string;
+
+  /**
+   * Maximum number of records to return
+   */
+  limit?: number | null;
+
+  /**
+   * Cursor for pagination; start after this ID
+   */
+  startingAfter?: string;
+}
+
+export declare namespace Currencies {
+  export {
+    type CurrencyCreateResponse as CurrencyCreateResponse,
+    type CurrencyListResponse as CurrencyListResponse,
+    type CurrencyCreateParams as CurrencyCreateParams,
+    type CurrencyListParams as CurrencyListParams,
+  };
+}

package/src/resources/loyalty/index.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Accounts, type AccountListResponse, type AccountListParams } from './accounts';
+export {
+  Badges,
+  type BadgeCreateResponse,
+  type BadgeUpdateResponse,
+  type BadgeListResponse,
+  type BadgeDeleteResponse,
+  type BadgeRevokeResponse,
+  type BadgeRewardResponse,
+  type BadgeCreateParams,
+  type BadgeUpdateParams,
+  type BadgeListParams,
+  type BadgeRevokeParams,
+  type BadgeRewardParams,
+} from './badges';
+export {
+  Currencies,
+  type CurrencyCreateResponse,
+  type CurrencyListResponse,
+  type CurrencyCreateParams,
+  type CurrencyListParams,
+} from './currencies';
+export { Loyalty } from './loyalty';
+export {
+  Multipliers,
+  type MultiplierCreateResponse,
+  type MultiplierUpdateResponse,
+  type MultiplierListResponse,
+  type MultiplierDeleteResponse,
+  type MultiplierCreateParams,
+  type MultiplierUpdateParams,
+  type MultiplierListParams,
+} from './multipliers';
+export {
+  RuleEdits,
+  type RuleEditRetrieveResponse,
+  type RuleEditRestoreResponse,
+  type RuleEditRetrieveParams,
+  type RuleEditRestoreParams,
+} from './rule-edits';
+export {
+  Rules,
+  type RuleCreateResponse,
+  type RuleUpdateResponse,
+  type RuleListResponse,
+  type RuleDeleteResponse,
+  type RuleCompleteResponse,
+  type RuleStatusResponse,
+  type RuleCreateParams,
+  type RuleUpdateParams,
+  type RuleListParams,
+  type RuleCompleteParams,
+  type RuleStatusParams,
+} from './rules';
+export {
+  TransactionEntries,
+  type TransactionEntryListResponse,
+  type TransactionEntryListParams,
+} from './transaction-entries';

package/src/resources/loyalty/loyalty.ts

@@ -0,0 +1,159 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as AccountsAPI from './accounts';
+import { AccountListParams, AccountListResponse, Accounts } from './accounts';
+import * as BadgesAPI from './badges';
+import {
+  BadgeCreateParams,
+  BadgeCreateResponse,
+  BadgeDeleteResponse,
+  BadgeListParams,
+  BadgeListResponse,
+  BadgeRevokeParams,
+  BadgeRevokeResponse,
+  BadgeRewardParams,
+  BadgeRewardResponse,
+  BadgeUpdateParams,
+  BadgeUpdateResponse,
+  Badges,
+} from './badges';
+import * as CurrenciesAPI from './currencies';
+import {
+  Currencies,
+  CurrencyCreateParams,
+  CurrencyCreateResponse,
+  CurrencyListParams,
+  CurrencyListResponse,
+} from './currencies';
+import * as MultipliersAPI from './multipliers';
+import {
+  MultiplierCreateParams,
+  MultiplierCreateResponse,
+  MultiplierDeleteResponse,
+  MultiplierListParams,
+  MultiplierListResponse,
+  MultiplierUpdateParams,
+  MultiplierUpdateResponse,
+  Multipliers,
+} from './multipliers';
+import * as RuleEditsAPI from './rule-edits';
+import {
+  RuleEditRestoreParams,
+  RuleEditRestoreResponse,
+  RuleEditRetrieveParams,
+  RuleEditRetrieveResponse,
+  RuleEdits,
+} from './rule-edits';
+import * as RulesAPI from './rules';
+import {
+  RuleCompleteParams,
+  RuleCompleteResponse,
+  RuleCreateParams,
+  RuleCreateResponse,
+  RuleDeleteResponse,
+  RuleListParams,
+  RuleListResponse,
+  RuleStatusParams,
+  RuleStatusResponse,
+  RuleUpdateParams,
+  RuleUpdateResponse,
+  Rules,
+} from './rules';
+import * as TransactionEntriesAPI from './transaction-entries';
+import {
+  TransactionEntries,
+  TransactionEntryListParams,
+  TransactionEntryListResponse,
+} from './transaction-entries';
+
+export class Loyalty extends APIResource {
+  rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
+  currencies: CurrenciesAPI.Currencies = new CurrenciesAPI.Currencies(this._client);
+  transactionEntries: TransactionEntriesAPI.TransactionEntries = new TransactionEntriesAPI.TransactionEntries(
+    this._client,
+  );
+  ruleEdits: RuleEditsAPI.RuleEdits = new RuleEditsAPI.RuleEdits(this._client);
+  accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
+  multipliers: MultipliersAPI.Multipliers = new MultipliersAPI.Multipliers(this._client);
+  badges: BadgesAPI.Badges = new BadgesAPI.Badges(this._client);
+}
+
+Loyalty.Rules = Rules;
+Loyalty.Currencies = Currencies;
+Loyalty.TransactionEntries = TransactionEntries;
+Loyalty.RuleEdits = RuleEdits;
+Loyalty.Accounts = Accounts;
+Loyalty.Multipliers = Multipliers;
+Loyalty.Badges = Badges;
+
+export declare namespace Loyalty {
+  export {
+    Rules as Rules,
+    type RuleCreateResponse as RuleCreateResponse,
+    type RuleUpdateResponse as RuleUpdateResponse,
+    type RuleListResponse as RuleListResponse,
+    type RuleDeleteResponse as RuleDeleteResponse,
+    type RuleCompleteResponse as RuleCompleteResponse,
+    type RuleStatusResponse as RuleStatusResponse,
+    type RuleCreateParams as RuleCreateParams,
+    type RuleUpdateParams as RuleUpdateParams,
+    type RuleListParams as RuleListParams,
+    type RuleCompleteParams as RuleCompleteParams,
+    type RuleStatusParams as RuleStatusParams,
+  };
+
+  export {
+    Currencies as Currencies,
+    type CurrencyCreateResponse as CurrencyCreateResponse,
+    type CurrencyListResponse as CurrencyListResponse,
+    type CurrencyCreateParams as CurrencyCreateParams,
+    type CurrencyListParams as CurrencyListParams,
+  };
+
+  export {
+    TransactionEntries as TransactionEntries,
+    type TransactionEntryListResponse as TransactionEntryListResponse,
+    type TransactionEntryListParams as TransactionEntryListParams,
+  };
+
+  export {
+    RuleEdits as RuleEdits,
+    type RuleEditRetrieveResponse as RuleEditRetrieveResponse,
+    type RuleEditRestoreResponse as RuleEditRestoreResponse,
+    type RuleEditRetrieveParams as RuleEditRetrieveParams,
+    type RuleEditRestoreParams as RuleEditRestoreParams,
+  };
+
+  export {
+    Accounts as Accounts,
+    type AccountListResponse as AccountListResponse,
+    type AccountListParams as AccountListParams,
+  };
+
+  export {
+    Multipliers as Multipliers,
+    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,
+  };
+
+  export {
+    Badges as Badges,
+    type BadgeCreateResponse as BadgeCreateResponse,
+    type BadgeUpdateResponse as BadgeUpdateResponse,
+    type BadgeListResponse as BadgeListResponse,
+    type BadgeDeleteResponse as BadgeDeleteResponse,
+    type BadgeRevokeResponse as BadgeRevokeResponse,
+    type BadgeRewardResponse as BadgeRewardResponse,
+    type BadgeCreateParams as BadgeCreateParams,
+    type BadgeUpdateParams as BadgeUpdateParams,
+    type BadgeListParams as BadgeListParams,
+    type BadgeRevokeParams as BadgeRevokeParams,
+    type BadgeRewardParams as BadgeRewardParams,
+  };
+}