@snagsolutions/sdk 0.1.0-alpha.15 → 0.1.0-alpha.151

package/src/resources/{api/loyalty → loyalty}/currencies.ts

@@ -1,11 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
 
 export class Currencies extends APIResource {
   /**
    * Create a loyalty currency
+   *
+   * @example
+   * ```ts
+   * const currency = await client.loyalty.currencies.create({
+   *   decimals: 2,
+   *   name: 'Loyalty Points',
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174001',
+   *   symbol: 'LP',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174002',
+   * });
+   * ```
    */
   create(body: CurrencyCreateParams, options?: Core.RequestOptions): Core.APIPromise<CurrencyCreateResponse> {
     return this._client.post('/api/loyalty/currencies', { body, ...options });
@@ -13,12 +24,23 @@ export class Currencies extends APIResource {
 
   /**
    * Get loyalty currencies
+   *
+   * @example
+   * ```ts
+   * const currencies = await client.loyalty.currencies.list({
+   *   organizationId: '123e4567-e89b-12d3-a456-426614174001',
+   *   websiteId: '123e4567-e89b-12d3-a456-426614174002',
+   * });
+   * ```
    */
   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
@@ -118,6 +140,9 @@ export interface CurrencyListResponse {
 }
 
 export namespace CurrencyListResponse {
+  /**
+   * Schema for a loyalty currency
+   */
   export interface Data {
     /**
      * Unique identifier for the loyalty currency

package/src/resources/{api/loyalty → loyalty}/index.ts

@@ -1,11 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  AccountStreaks,
+  type AccountStreakGetStreaksResponse,
+  type AccountStreakGetStreaksParams,
+} from './account-streaks';
 export {
   Accounts,
   type AccountListResponse,
-  type AccountGetRankResponse,
+  type AccountRetrieveRankResponse,
   type AccountListParams,
-  type AccountGetRankParams,
+  type AccountRetrieveRankParams,
 } from './accounts';
 export {
   Badges,
@@ -28,15 +33,7 @@ export {
   type CurrencyCreateParams,
   type CurrencyListParams,
 } from './currencies';
-export {
-  Loyalty,
-  type LoyaltyCreateTransactionResponse,
-  type LoyaltyGetRuleGroupsResponse,
-  type LoyaltyListTransactionEntriesResponse,
-  type LoyaltyCreateTransactionParams,
-  type LoyaltyGetRuleGroupsParams,
-  type LoyaltyListTransactionEntriesParams,
-} from './loyalty';
+export { Loyalty } from './loyalty';
 export {
   Multipliers,
   type MultiplierCreateResponse,
@@ -72,6 +69,16 @@ export {
   type RuleEditListParams,
   type RuleEditRestoreParams,
 } from './rule-edits';
+export {
+  RuleGroups,
+  type RuleGroupCreateRuleGroupResponse,
+  type RuleGroupDeleteRuleGroupResponse,
+  type RuleGroupGetRuleGroupsResponse,
+  type RuleGroupUpdateRuleGroupResponse,
+  type RuleGroupCreateRuleGroupParams,
+  type RuleGroupGetRuleGroupsParams,
+  type RuleGroupUpdateRuleGroupParams,
+} from './rule-groups';
 export {
   Rules,
   type RuleCreateResponse,
@@ -83,6 +90,16 @@ export {
   type RuleCreateParams,
   type RuleUpdateParams,
   type RuleListParams,
+  type RuleDeleteParams,
   type RuleCompleteParams,
   type RuleGetStatusParams,
 } from './rules';
+export {
+  Transactions,
+  type TransactionCreateTransactionResponse,
+  type TransactionGetTransactionEntriesResponse,
+  type TransactionListRuleChainsResponse,
+  type TransactionCreateTransactionParams,
+  type TransactionGetTransactionEntriesParams,
+  type TransactionListRuleChainsParams,
+} from './transactions/index';

package/src/resources/loyalty/loyalty.ts

@@ -0,0 +1,259 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as AccountStreaksAPI from './account-streaks';
+import {
+  AccountStreakGetStreaksParams,
+  AccountStreakGetStreaksResponse,
+  AccountStreaks,
+} from './account-streaks';
+import * as AccountsAPI from './accounts';
+import {
+  AccountListParams,
+  AccountListResponse,
+  AccountRetrieveRankParams,
+  AccountRetrieveRankResponse,
+  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,
+  MultiplierDeleteByExternalIDParams,
+  MultiplierDeleteByExternalIDResponse,
+  MultiplierDeleteResponse,
+  MultiplierListParams,
+  MultiplierListResponse,
+  MultiplierUpdateParams,
+  MultiplierUpdateResponse,
+  Multipliers,
+} from './multipliers';
+import * as QuestionsAPI from './questions';
+import {
+  QuestionCreateParams,
+  QuestionCreateResponse,
+  QuestionListParams,
+  QuestionListResponse,
+  QuestionUpdateParams,
+  QuestionUpdateResponse,
+  Questions,
+} from './questions';
+import * as QuestionsResponsesAPI from './questions-responses';
+import {
+  QuestionsResponseListParams,
+  QuestionsResponseListResponse,
+  QuestionsResponseSubmitParams,
+  QuestionsResponseSubmitResponse,
+  QuestionsResponses,
+} from './questions-responses';
+import * as RuleEditsAPI from './rule-edits';
+import {
+  RuleEditListParams,
+  RuleEditListResponse,
+  RuleEditRestoreParams,
+  RuleEditRestoreResponse,
+  RuleEdits,
+} from './rule-edits';
+import * as RuleGroupsAPI from './rule-groups';
+import {
+  RuleGroupCreateRuleGroupParams,
+  RuleGroupCreateRuleGroupResponse,
+  RuleGroupDeleteRuleGroupResponse,
+  RuleGroupGetRuleGroupsParams,
+  RuleGroupGetRuleGroupsResponse,
+  RuleGroupUpdateRuleGroupParams,
+  RuleGroupUpdateRuleGroupResponse,
+  RuleGroups,
+} from './rule-groups';
+import * as RulesAPI from './rules';
+import {
+  RuleCompleteParams,
+  RuleCompleteResponse,
+  RuleCreateParams,
+  RuleCreateResponse,
+  RuleDeleteParams,
+  RuleDeleteResponse,
+  RuleGetStatusParams,
+  RuleGetStatusResponse,
+  RuleListParams,
+  RuleListResponse,
+  RuleUpdateParams,
+  RuleUpdateResponse,
+  Rules,
+} from './rules';
+import * as TransactionsAPI from './transactions/transactions';
+import {
+  TransactionCreateTransactionParams,
+  TransactionCreateTransactionResponse,
+  TransactionGetTransactionEntriesParams,
+  TransactionGetTransactionEntriesResponse,
+  TransactionListRuleChainsParams,
+  TransactionListRuleChainsResponse,
+  Transactions,
+} from './transactions/transactions';
+
+export class Loyalty extends APIResource {
+  ruleGroups: RuleGroupsAPI.RuleGroups = new RuleGroupsAPI.RuleGroups(this._client);
+  transactions: TransactionsAPI.Transactions = new TransactionsAPI.Transactions(this._client);
+  accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
+  accountStreaks: AccountStreaksAPI.AccountStreaks = new AccountStreaksAPI.AccountStreaks(this._client);
+  badges: BadgesAPI.Badges = new BadgesAPI.Badges(this._client);
+  currencies: CurrenciesAPI.Currencies = new CurrenciesAPI.Currencies(this._client);
+  multipliers: MultipliersAPI.Multipliers = new MultipliersAPI.Multipliers(this._client);
+  ruleEdits: RuleEditsAPI.RuleEdits = new RuleEditsAPI.RuleEdits(this._client);
+  rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
+  questions: QuestionsAPI.Questions = new QuestionsAPI.Questions(this._client);
+  questionsResponses: QuestionsResponsesAPI.QuestionsResponses = new QuestionsResponsesAPI.QuestionsResponses(
+    this._client,
+  );
+}
+
+Loyalty.RuleGroups = RuleGroups;
+Loyalty.Transactions = Transactions;
+Loyalty.Accounts = Accounts;
+Loyalty.AccountStreaks = AccountStreaks;
+Loyalty.Badges = Badges;
+Loyalty.Currencies = Currencies;
+Loyalty.Multipliers = Multipliers;
+Loyalty.RuleEdits = RuleEdits;
+Loyalty.Rules = Rules;
+Loyalty.Questions = Questions;
+Loyalty.QuestionsResponses = QuestionsResponses;
+
+export declare namespace Loyalty {
+  export {
+    RuleGroups as RuleGroups,
+    type RuleGroupCreateRuleGroupResponse as RuleGroupCreateRuleGroupResponse,
+    type RuleGroupDeleteRuleGroupResponse as RuleGroupDeleteRuleGroupResponse,
+    type RuleGroupGetRuleGroupsResponse as RuleGroupGetRuleGroupsResponse,
+    type RuleGroupUpdateRuleGroupResponse as RuleGroupUpdateRuleGroupResponse,
+    type RuleGroupCreateRuleGroupParams as RuleGroupCreateRuleGroupParams,
+    type RuleGroupGetRuleGroupsParams as RuleGroupGetRuleGroupsParams,
+    type RuleGroupUpdateRuleGroupParams as RuleGroupUpdateRuleGroupParams,
+  };
+
+  export {
+    Transactions as Transactions,
+    type TransactionCreateTransactionResponse as TransactionCreateTransactionResponse,
+    type TransactionGetTransactionEntriesResponse as TransactionGetTransactionEntriesResponse,
+    type TransactionListRuleChainsResponse as TransactionListRuleChainsResponse,
+    type TransactionCreateTransactionParams as TransactionCreateTransactionParams,
+    type TransactionGetTransactionEntriesParams as TransactionGetTransactionEntriesParams,
+    type TransactionListRuleChainsParams as TransactionListRuleChainsParams,
+  };
+
+  export {
+    Accounts as Accounts,
+    type AccountListResponse as AccountListResponse,
+    type AccountRetrieveRankResponse as AccountRetrieveRankResponse,
+    type AccountListParams as AccountListParams,
+    type AccountRetrieveRankParams as AccountRetrieveRankParams,
+  };
+
+  export {
+    AccountStreaks as AccountStreaks,
+    type AccountStreakGetStreaksResponse as AccountStreakGetStreaksResponse,
+    type AccountStreakGetStreaksParams as AccountStreakGetStreaksParams,
+  };
+
+  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,
+  };
+
+  export {
+    Currencies as Currencies,
+    type CurrencyCreateResponse as CurrencyCreateResponse,
+    type CurrencyListResponse as CurrencyListResponse,
+    type CurrencyCreateParams as CurrencyCreateParams,
+    type CurrencyListParams as CurrencyListParams,
+  };
+
+  export {
+    Multipliers as Multipliers,
+    type MultiplierCreateResponse as MultiplierCreateResponse,
+    type MultiplierUpdateResponse as MultiplierUpdateResponse,
+    type MultiplierListResponse as MultiplierListResponse,
+    type MultiplierDeleteResponse as MultiplierDeleteResponse,
+    type MultiplierDeleteByExternalIDResponse as MultiplierDeleteByExternalIDResponse,
+    type MultiplierCreateParams as MultiplierCreateParams,
+    type MultiplierUpdateParams as MultiplierUpdateParams,
+    type MultiplierListParams as MultiplierListParams,
+    type MultiplierDeleteByExternalIDParams as MultiplierDeleteByExternalIDParams,
+  };
+
+  export {
+    RuleEdits as RuleEdits,
+    type RuleEditListResponse as RuleEditListResponse,
+    type RuleEditRestoreResponse as RuleEditRestoreResponse,
+    type RuleEditListParams as RuleEditListParams,
+    type RuleEditRestoreParams as RuleEditRestoreParams,
+  };
+
+  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 RuleGetStatusResponse as RuleGetStatusResponse,
+    type RuleCreateParams as RuleCreateParams,
+    type RuleUpdateParams as RuleUpdateParams,
+    type RuleListParams as RuleListParams,
+    type RuleDeleteParams as RuleDeleteParams,
+    type RuleCompleteParams as RuleCompleteParams,
+    type RuleGetStatusParams as RuleGetStatusParams,
+  };
+
+  export {
+    Questions as Questions,
+    type QuestionCreateResponse as QuestionCreateResponse,
+    type QuestionUpdateResponse as QuestionUpdateResponse,
+    type QuestionListResponse as QuestionListResponse,
+    type QuestionCreateParams as QuestionCreateParams,
+    type QuestionUpdateParams as QuestionUpdateParams,
+    type QuestionListParams as QuestionListParams,
+  };
+
+  export {
+    QuestionsResponses as QuestionsResponses,
+    type QuestionsResponseListResponse as QuestionsResponseListResponse,
+    type QuestionsResponseSubmitResponse as QuestionsResponseSubmitResponse,
+    type QuestionsResponseListParams as QuestionsResponseListParams,
+    type QuestionsResponseSubmitParams as QuestionsResponseSubmitParams,
+  };
+}

package/src/resources/{api/loyalty → loyalty}/multipliers.ts

@@ -1,12 +1,20 @@
 // 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';
+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.
+   *
+   * @example
+   * ```ts
+   * const multiplier = await client.loyalty.multipliers.create({
+   *   multiplier: 0.01,
+   *   walletAddress: 'walletAddress',
+   * });
+   * ```
    */
   create(
     body: MultiplierCreateParams,
@@ -17,6 +25,13 @@ export class Multipliers extends APIResource {
 
   /**
    * Update an existing loyalty multiplier.
+   *
+   * @example
+   * ```ts
+   * const multiplier = await client.loyalty.multipliers.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   update(
     multiplierId: string,
@@ -37,6 +52,11 @@ export class Multipliers extends APIResource {
 
   /**
    * Get Loyalty Multipliers
+   *
+   * @example
+   * ```ts
+   * const multipliers = await client.loyalty.multipliers.list();
+   * ```
    */
   list(query?: MultiplierListParams, options?: Core.RequestOptions): Core.APIPromise<MultiplierListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<MultiplierListResponse>;
@@ -52,6 +72,13 @@ export class Multipliers extends APIResource {
 
   /**
    * Delete a loyalty multiplier by its ID.
+   *
+   * @example
+   * ```ts
+   * const multiplier = await client.loyalty.multipliers.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(multiplierId: string, options?: Core.RequestOptions): Core.APIPromise<MultiplierDeleteResponse> {
     return this._client.delete(`/api/loyalty/multipliers/${multiplierId}`, options);
@@ -59,6 +86,14 @@ export class Multipliers extends APIResource {
 
   /**
    * Delete a loyalty multiplier by its external identifier.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.multipliers.deleteByExternalId({
+   *     externalIdentifier: 'externalIdentifier',
+   *   });
+   * ```
    */
   deleteByExternalId(
     body: MultiplierDeleteByExternalIDParams,
@@ -90,14 +125,22 @@ export interface MultiplierCreateResponse {
 
   updatedAt: string;
 
+  /**
+   * Schema for a loyalty multiplier user
+   */
   user: MultiplierCreateResponse.User;
 
   userId: string;
 
   websiteId: string;
+
+  loyaltyRuleId?: string;
 }
 
 export namespace MultiplierCreateResponse {
+  /**
+   * Schema for a loyalty multiplier user
+   */
   export interface User {
     id: string;
 
@@ -127,14 +170,22 @@ export interface MultiplierUpdateResponse {
 
   updatedAt: string;
 
+  /**
+   * Schema for a loyalty multiplier user
+   */
   user: MultiplierUpdateResponse.User;
 
   userId: string;
 
   websiteId: string;
+
+  loyaltyRuleId?: string;
 }
 
 export namespace MultiplierUpdateResponse {
+  /**
+   * Schema for a loyalty multiplier user
+   */
   export interface User {
     id: string;
 
@@ -171,14 +222,22 @@ export namespace MultiplierListResponse {
 
     updatedAt: string;
 
+    /**
+     * Schema for a loyalty multiplier user
+     */
     user: Data.User;
 
     userId: string;
 
     websiteId: string;
+
+    loyaltyRuleId?: string;
   }
 
   export namespace Data {
+    /**
+     * Schema for a loyalty multiplier user
+     */
     export interface User {
       id: string;
 
@@ -213,14 +272,22 @@ export interface MultiplierDeleteByExternalIDResponse {
 
   updatedAt: string;
 
+  /**
+   * Schema for a loyalty multiplier user
+   */
   user: MultiplierDeleteByExternalIDResponse.User;
 
   userId: string;
 
   websiteId: string;
+
+  loyaltyRuleId?: string;
 }
 
 export namespace MultiplierDeleteByExternalIDResponse {
+  /**
+   * Schema for a loyalty multiplier user
+   */
   export interface User {
     id: string;
 
@@ -249,8 +316,6 @@ export interface MultiplierUpdateParams {
 }
 
 export interface MultiplierListParams {
-  discordUser?: string;
-
   externalIdentifier?: string;
 
   includeDeleted?: string;
@@ -261,8 +326,6 @@ export interface MultiplierListParams {
 
   startingAfter?: string;
 
-  twitterUser?: string;
-
   userGroupExternalIdentifier?: string;
 
   userGroupId?: string;

package/src/resources/{api/loyalty → loyalty}/questions-responses.ts

@@ -1,13 +1,19 @@
 // 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';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
 
 export class QuestionsResponses extends APIResource {
   /**
    * Retrieve responses submitted by the authenticated user, optionally filtered by
    * question IDs
+   *
+   * @example
+   * ```ts
+   * const questionsResponses =
+   *   await client.loyalty.questionsResponses.list();
+   * ```
    */
   list(
     query?: QuestionsResponseListParams,
@@ -26,6 +32,15 @@ export class QuestionsResponses extends APIResource {
 
   /**
    * This endpoint allows you to submit a response to a question.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.questionsResponses.submit({
+   *     loyaltyQuestionChoiceId:
+   *       '123e4567-e89b-12d3-a456-426614174001',
+   *   });
+   * ```
    */
   submit(
     body: QuestionsResponseSubmitParams,
@@ -123,10 +138,25 @@ export namespace QuestionsResponseSubmitResponse {
 }
 
 export interface QuestionsResponseListParams {
+  /**
+   * UUID of the organization to filter responses
+   */
+  organizationId?: string;
+
   /**
    * UUID(s) of the questions to filter responses
    */
   questionsId?: string | Array<string>;
+
+  /**
+   * UUID of the user to filter responses
+   */
+  userId?: string;
+
+  /**
+   * UUID of the website to filter responses
+   */
+  websiteId?: string;
 }
 
 export interface QuestionsResponseSubmitParams {
@@ -134,6 +164,21 @@ export interface QuestionsResponseSubmitParams {
    * UUID of the selected choice
    */
   loyaltyQuestionChoiceId: string;
+
+  /**
+   * UUID of the organization to filter responses
+   */
+  organizationId?: string;
+
+  /**
+   * UUID of the user who submitted the response
+   */
+  userId?: string;
+
+  /**
+   * UUID of the website to filter responses
+   */
+  websiteId?: string;
 }
 
 export declare namespace QuestionsResponses {