@snagsolutions/sdk 0.1.0-alpha.17 → 0.1.0-alpha.170

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 });

package/src/resources/loyalty/index.ts

@@ -1,5 +1,10 @@
 // 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,
@@ -57,7 +62,6 @@ export {
   type QuestionsResponseListParams,
   type QuestionsResponseSubmitParams,
 } from './questions-responses';
-export { RuleChains } from './rule-chains';
 export {
   RuleEdits,
   type RuleEditListResponse,
@@ -67,8 +71,13 @@ export {
 } from './rule-edits';
 export {
   RuleGroups,
+  type RuleGroupCreateRuleGroupResponse,
+  type RuleGroupDeleteRuleGroupResponse,
   type RuleGroupGetRuleGroupsResponse,
+  type RuleGroupUpdateRuleGroupResponse,
+  type RuleGroupCreateRuleGroupParams,
   type RuleGroupGetRuleGroupsParams,
+  type RuleGroupUpdateRuleGroupParams,
 } from './rule-groups';
 export {
   Rules,
@@ -81,6 +90,7 @@ export {
   type RuleCreateParams,
   type RuleUpdateParams,
   type RuleListParams,
+  type RuleDeleteParams,
   type RuleCompleteParams,
   type RuleGetStatusParams,
 } from './rules';
@@ -90,4 +100,4 @@ export {
   type TransactionGetTransactionEntriesResponse,
   type TransactionCreateTransactionParams,
   type TransactionGetTransactionEntriesParams,
-} from './transactions';
+} from './transactions/index';

package/src/resources/loyalty/loyalty.ts

@@ -1,6 +1,12 @@
 // 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,
@@ -63,8 +69,6 @@ import {
   QuestionsResponseSubmitResponse,
   QuestionsResponses,
 } from './questions-responses';
-import * as RuleChainsAPI from './rule-chains';
-import { RuleChains } from './rule-chains';
 import * as RuleEditsAPI from './rule-edits';
 import {
   RuleEditListParams,
@@ -74,13 +78,23 @@ import {
   RuleEdits,
 } from './rule-edits';
 import * as RuleGroupsAPI from './rule-groups';
-import { RuleGroupGetRuleGroupsParams, RuleGroupGetRuleGroupsResponse, RuleGroups } 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,
@@ -90,20 +104,20 @@ import {
   RuleUpdateResponse,
   Rules,
 } from './rules';
-import * as TransactionsAPI from './transactions';
+import * as TransactionsAPI from './transactions/transactions';
 import {
   TransactionCreateTransactionParams,
   TransactionCreateTransactionResponse,
   TransactionGetTransactionEntriesParams,
   TransactionGetTransactionEntriesResponse,
   Transactions,
-} from './transactions';
+} from './transactions/transactions';
 
 export class Loyalty extends APIResource {
-  ruleChains: RuleChainsAPI.RuleChains = new RuleChainsAPI.RuleChains(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);
   multipliers: MultipliersAPI.Multipliers = new MultipliersAPI.Multipliers(this._client);
@@ -115,10 +129,10 @@ export class Loyalty extends APIResource {
   );
 }
 
-Loyalty.RuleChains = RuleChains;
 Loyalty.RuleGroups = RuleGroups;
 Loyalty.Transactions = Transactions;
 Loyalty.Accounts = Accounts;
+Loyalty.AccountStreaks = AccountStreaks;
 Loyalty.Badges = Badges;
 Loyalty.Currencies = Currencies;
 Loyalty.Multipliers = Multipliers;
@@ -128,12 +142,15 @@ Loyalty.Questions = Questions;
 Loyalty.QuestionsResponses = QuestionsResponses;
 
 export declare namespace Loyalty {
-  export { RuleChains as RuleChains };
-
   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 {
@@ -152,6 +169,12 @@ export declare namespace Loyalty {
     type AccountRetrieveRankParams as AccountRetrieveRankParams,
   };
 
+  export {
+    AccountStreaks as AccountStreaks,
+    type AccountStreakGetStreaksResponse as AccountStreakGetStreaksResponse,
+    type AccountStreakGetStreaksParams as AccountStreakGetStreaksParams,
+  };
+
   export {
     Badges as Badges,
     type BadgeCreateResponse as BadgeCreateResponse,
@@ -207,6 +230,7 @@ export declare namespace Loyalty {
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,
+    type RuleDeleteParams as RuleDeleteParams,
     type RuleCompleteParams as RuleCompleteParams,
     type RuleGetStatusParams as RuleGetStatusParams,
   };

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,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,
@@ -98,6 +133,8 @@ export interface MultiplierCreateResponse {
   userId: string;
 
   websiteId: string;
+
+  loyaltyRuleId?: string;
 }
 
 export namespace MultiplierCreateResponse {
@@ -141,6 +178,8 @@ export interface MultiplierUpdateResponse {
   userId: string;
 
   websiteId: string;
+
+  loyaltyRuleId?: string;
 }
 
 export namespace MultiplierUpdateResponse {
@@ -191,6 +230,8 @@ export namespace MultiplierListResponse {
     userId: string;
 
     websiteId: string;
+
+    loyaltyRuleId?: string;
   }
 
   export namespace Data {
@@ -239,6 +280,8 @@ export interface MultiplierDeleteByExternalIDResponse {
   userId: string;
 
   websiteId: string;
+
+  loyaltyRuleId?: string;
 }
 
 export namespace MultiplierDeleteByExternalIDResponse {
@@ -273,8 +316,6 @@ export interface MultiplierUpdateParams {
 }
 
 export interface MultiplierListParams {
-  discordUser?: string;
-
   externalIdentifier?: string;
 
   includeDeleted?: string;
@@ -285,8 +326,6 @@ export interface MultiplierListParams {
 
   startingAfter?: string;
 
-  twitterUser?: string;
-
   userGroupExternalIdentifier?: string;
 
   userGroupId?: string;

package/src/resources/loyalty/questions-responses.ts

@@ -8,6 +8,12 @@ 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 {

package/src/resources/loyalty/questions.ts

@@ -6,6 +6,17 @@ import * as Core from '../../core';
 export class Questions extends APIResource {
   /**
    * This endpoint allows you to create a new question.
+   *
+   * @example
+   * ```ts
+   * const question = await client.loyalty.questions.create({
+   *   loyaltyQuestionAnswers: [
+   *     { isCorrect: true, sortIdentifier: 1, text: 'Red' },
+   *   ],
+   *   loyaltyRuleId: '123e4567-e89b-12d3-a456-426614174000',
+   *   questionText: 'What is your favorite color?',
+   * });
+   * ```
    */
   create(body: QuestionCreateParams, options?: Core.RequestOptions): Core.APIPromise<QuestionCreateResponse> {
     return this._client.post('/api/loyalty/questions', { body, ...options });
@@ -13,6 +24,19 @@ export class Questions extends APIResource {
 
   /**
    * This endpoint allows you to update an existing question.
+   *
+   * @example
+   * ```ts
+   * const question = await client.loyalty.questions.update(
+   *   'id',
+   *   {
+   *     loyaltyQuestionAnswers: [
+   *       { isCorrect: true, sortIdentifier: 1, text: 'Red' },
+   *     ],
+   *     questionText: 'What is your favorite color?',
+   *   },
+   * );
+   * ```
    */
   update(
     id: string,
@@ -24,6 +48,13 @@ export class Questions extends APIResource {
 
   /**
    * This endpoint allows you to fetch questions for a loyalty rule.
+   *
+   * @example
+   * ```ts
+   * const questions = await client.loyalty.questions.list({
+   *   loyaltyRuleIds: '123e4567-e89b-12d3-a456-426614174000',
+   * });
+   * ```
    */
   list(query: QuestionListParams, options?: Core.RequestOptions): Core.APIPromise<QuestionListResponse> {
     return this._client.get('/api/loyalty/questions', { query, ...options });
@@ -188,12 +219,17 @@ export interface QuestionListParams {
   /**
    * UUID of the organization to fetch questions for
    */
-  organizationId: string;
+  organizationId?: string;
+
+  /**
+   * UUID of the user to fetch questions for
+   */
+  userId?: string;
 
   /**
    * UUID of the website to fetch questions for
    */
-  websiteId: string;
+  websiteId?: string;
 }
 
 export declare namespace Questions {