@snagsolutions/sdk 0.1.0-alpha.13 → 0.1.0-alpha.131

package/src/resources/loyalty/currencies.ts

@@ -6,6 +6,17 @@ 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,6 +24,14 @@ 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 });
@@ -303,7 +322,7 @@ export interface CurrencyListParams {
   /**
    * Maximum number of records to return
    */
-  limit?: number | null;
+  limit?: number;
 
   /**
    * Cursor for pagination; start after this ID

package/src/resources/loyalty/index.ts

@@ -1,6 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Accounts, type AccountListResponse, type AccountListParams } from './accounts';
+export {
+  AccountStreaks,
+  type AccountStreakGetStreaksResponse,
+  type AccountStreakGetStreaksParams,
+} from './account-streaks';
+export {
+  Accounts,
+  type AccountListResponse,
+  type AccountRetrieveRankResponse,
+  type AccountListParams,
+  type AccountRetrieveRankParams,
+} from './accounts';
 export {
   Badges,
   type BadgeCreateResponse,
@@ -29,17 +40,45 @@ export {
   type MultiplierUpdateResponse,
   type MultiplierListResponse,
   type MultiplierDeleteResponse,
+  type MultiplierDeleteByExternalIDResponse,
   type MultiplierCreateParams,
   type MultiplierUpdateParams,
   type MultiplierListParams,
+  type MultiplierDeleteByExternalIDParams,
 } from './multipliers';
+export {
+  Questions,
+  type QuestionCreateResponse,
+  type QuestionUpdateResponse,
+  type QuestionListResponse,
+  type QuestionCreateParams,
+  type QuestionUpdateParams,
+  type QuestionListParams,
+} from './questions';
+export {
+  QuestionsResponses,
+  type QuestionsResponseListResponse,
+  type QuestionsResponseSubmitResponse,
+  type QuestionsResponseListParams,
+  type QuestionsResponseSubmitParams,
+} from './questions-responses';
 export {
   RuleEdits,
-  type RuleEditRetrieveResponse,
+  type RuleEditListResponse,
   type RuleEditRestoreResponse,
-  type RuleEditRetrieveParams,
+  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,
@@ -47,15 +86,20 @@ export {
   type RuleListResponse,
   type RuleDeleteResponse,
   type RuleCompleteResponse,
-  type RuleStatusResponse,
+  type RuleGetStatusResponse,
   type RuleCreateParams,
   type RuleUpdateParams,
   type RuleListParams,
+  type RuleDeleteParams,
   type RuleCompleteParams,
-  type RuleStatusParams,
+  type RuleGetStatusParams,
 } from './rules';
 export {
-  TransactionEntries,
-  type TransactionEntryListResponse,
-  type TransactionEntryListParams,
-} from './transaction-entries';
+  Transactions,
+  type TransactionCreateTransactionResponse,
+  type TransactionGetTransactionEntriesResponse,
+  type TransactionListRuleChainsResponse,
+  type TransactionCreateTransactionParams,
+  type TransactionGetTransactionEntriesParams,
+  type TransactionListRuleChainsParams,
+} from './transactions/index';

package/src/resources/loyalty/loyalty.ts

@@ -1,8 +1,20 @@
 // 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, Accounts } from './accounts';
+import {
+  AccountListParams,
+  AccountListResponse,
+  AccountRetrieveRankParams,
+  AccountRetrieveRankResponse,
+  Accounts,
+} from './accounts';
 import * as BadgesAPI from './badges';
 import {
   BadgeCreateParams,
@@ -30,6 +42,8 @@ import * as MultipliersAPI from './multipliers';
 import {
   MultiplierCreateParams,
   MultiplierCreateResponse,
+  MultiplierDeleteByExternalIDParams,
+  MultiplierDeleteByExternalIDResponse,
   MultiplierDeleteResponse,
   MultiplierListParams,
   MultiplierListResponse,
@@ -37,109 +51,132 @@ import {
   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,
-  RuleEditRetrieveParams,
-  RuleEditRetrieveResponse,
   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,
-  RuleStatusParams,
-  RuleStatusResponse,
   RuleUpdateParams,
   RuleUpdateResponse,
   Rules,
 } from './rules';
-import * as TransactionEntriesAPI from './transaction-entries';
+import * as TransactionsAPI from './transactions/transactions';
 import {
-  TransactionEntries,
-  TransactionEntryListParams,
-  TransactionEntryListResponse,
-} from './transaction-entries';
+  TransactionCreateTransactionParams,
+  TransactionCreateTransactionResponse,
+  TransactionGetTransactionEntriesParams,
+  TransactionGetTransactionEntriesResponse,
+  TransactionListRuleChainsParams,
+  TransactionListRuleChainsResponse,
+  Transactions,
+} from './transactions/transactions';
 
 export class Loyalty extends APIResource {
-  rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
+  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);
-  transactionEntries: TransactionEntriesAPI.TransactionEntries = new TransactionEntriesAPI.TransactionEntries(
+  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,
   );
-  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.RuleGroups = RuleGroups;
+Loyalty.Transactions = Transactions;
 Loyalty.Accounts = Accounts;
-Loyalty.Multipliers = Multipliers;
+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 {
-    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,
+    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 {
-    RuleEdits as RuleEdits,
-    type RuleEditRetrieveResponse as RuleEditRetrieveResponse,
-    type RuleEditRestoreResponse as RuleEditRestoreResponse,
-    type RuleEditRetrieveParams as RuleEditRetrieveParams,
-    type RuleEditRestoreParams as RuleEditRestoreParams,
+    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 {
-    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,
+    AccountStreaks as AccountStreaks,
+    type AccountStreakGetStreaksResponse as AccountStreakGetStreaksResponse,
+    type AccountStreakGetStreaksParams as AccountStreakGetStreaksParams,
   };
 
   export {
@@ -156,4 +193,67 @@ export declare namespace Loyalty {
     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/loyalty/multipliers.ts

@@ -7,6 +7,14 @@ 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,10 +72,35 @@ 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);
   }
+
+  /**
+   * Delete a loyalty multiplier by its external identifier.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.loyalty.multipliers.deleteByExternalId({
+   *     externalIdentifier: 'externalIdentifier',
+   *   });
+   * ```
+   */
+  deleteByExternalId(
+    body: MultiplierDeleteByExternalIDParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MultiplierDeleteByExternalIDResponse> {
+    return this._client.delete('/api/loyalty/multipliers', { body, ...options });
+  }
 }
 
 /**
@@ -80,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;
 
@@ -117,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;
 
@@ -161,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;
 
@@ -181,6 +250,51 @@ export interface MultiplierDeleteResponse {
   id: string;
 }
 
+/**
+ * Schema for loyalty multiplier
+ */
+export interface MultiplierDeleteByExternalIDResponse {
+  id: string;
+
+  createdAt: string;
+
+  deletedAt: string | null;
+
+  description: string | null;
+
+  externalIdentifier: string | null;
+
+  multiplier: number;
+
+  organizationId: string;
+
+  title: string | null;
+
+  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;
+
+    walletAddress: string;
+  }
+}
+
 export interface MultiplierCreateParams {
   multiplier: number;
 
@@ -202,11 +316,9 @@ export interface MultiplierUpdateParams {
 }
 
 export interface MultiplierListParams {
-  discordUser?: string;
-
   externalIdentifier?: string;
 
-  includeDeleted?: boolean;
+  includeDeleted?: string;
 
   limit?: number;
 
@@ -214,7 +326,9 @@ export interface MultiplierListParams {
 
   startingAfter?: string;
 
-  twitterUser?: string;
+  userGroupExternalIdentifier?: string;
+
+  userGroupId?: string;
 
   userId?: string | Array<string>;
 
@@ -225,14 +339,20 @@ export interface MultiplierListParams {
   websiteId?: string;
 }
 
+export interface MultiplierDeleteByExternalIDParams {
+  externalIdentifier: string;
+}
+
 export declare namespace Multipliers {
   export {
     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,
   };
 }