zavudev 0.7.0 → 0.8.0

data/lib/zavudev/resources/number_10dlc/campaigns.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      class Campaigns
+        # @return [Zavudev::Resources::Number10dlc::Campaigns::PhoneNumbers]
+        attr_reader :phone_numbers
+
+        # Create a 10DLC campaign under an existing brand. The campaign starts in draft
+        # status. Submit it for carrier review using the submit endpoint.
+        #
+        # @overload create(affiliate_marketing:, age_gated:, brand_id:, description:, direct_lending:, embedded_link:, embedded_phone:, name:, number_pooling:, sample_messages:, subscriber_help:, subscriber_opt_in:, subscriber_opt_out:, use_case:, help_message: nil, message_flow: nil, opt_in_keywords: nil, opt_out_keywords: nil, sub_use_cases: nil, request_options: {})
+        #
+        # @param affiliate_marketing [Boolean]
+        #
+        # @param age_gated [Boolean]
+        #
+        # @param brand_id [String] ID of the brand to create this campaign under.
+        #
+        # @param description [String]
+        #
+        # @param direct_lending [Boolean]
+        #
+        # @param embedded_link [Boolean]
+        #
+        # @param embedded_phone [Boolean]
+        #
+        # @param name [String]
+        #
+        # @param number_pooling [Boolean]
+        #
+        # @param sample_messages [Array<String>]
+        #
+        # @param subscriber_help [Boolean]
+        #
+        # @param subscriber_opt_in [Boolean]
+        #
+        # @param subscriber_opt_out [Boolean]
+        #
+        # @param use_case [String] Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).
+        #
+        # @param help_message [String]
+        #
+        # @param message_flow [String]
+        #
+        # @param opt_in_keywords [Array<String>]
+        #
+        # @param opt_out_keywords [Array<String>]
+        #
+        # @param sub_use_cases [Array<String>]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::CampaignCreateResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignCreateParams
+        def create(params)
+          parsed, options = Zavudev::Number10dlc::CampaignCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/10dlc/campaigns",
+            body: parsed,
+            model: Zavudev::Models::Number10dlc::CampaignCreateResponse,
+            options: options
+          )
+        end
+
+        # Get 10DLC campaign
+        #
+        # @overload retrieve(campaign_id, request_options: {})
+        #
+        # @param campaign_id [String] 10DLC campaign ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::CampaignRetrieveResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignRetrieveParams
+        def retrieve(campaign_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/10dlc/campaigns/%1$s", campaign_id],
+            model: Zavudev::Models::Number10dlc::CampaignRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Update a 10DLC campaign in draft status. Cannot update after submission.
+        #
+        # @overload update(campaign_id, description: nil, help_message: nil, message_flow: nil, name: nil, opt_in_keywords: nil, opt_out_keywords: nil, sample_messages: nil, request_options: {})
+        #
+        # @param campaign_id [String] 10DLC campaign ID.
+        #
+        # @param description [String]
+        #
+        # @param help_message [String]
+        #
+        # @param message_flow [String]
+        #
+        # @param name [String]
+        #
+        # @param opt_in_keywords [Array<String>]
+        #
+        # @param opt_out_keywords [Array<String>]
+        #
+        # @param sample_messages [Array<String>]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::CampaignUpdateResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignUpdateParams
+        def update(campaign_id, params = {})
+          parsed, options = Zavudev::Number10dlc::CampaignUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["v1/10dlc/campaigns/%1$s", campaign_id],
+            body: parsed,
+            model: Zavudev::Models::Number10dlc::CampaignUpdateResponse,
+            options: options
+          )
+        end
+
+        # List 10DLC campaign registrations for this project.
+        #
+        # @overload list(brand_id: nil, cursor: nil, limit: nil, request_options: {})
+        #
+        # @param brand_id [String] Filter campaigns by brand ID.
+        #
+        # @param cursor [String]
+        #
+        # @param limit [Integer]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Internal::Cursor<Zavudev::Models::Number10dlc::TenDlcCampaign>]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignListParams
+        def list(params = {})
+          parsed, options = Zavudev::Number10dlc::CampaignListParams.dump_request(params)
+          query = Zavudev::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "v1/10dlc/campaigns",
+            query: query.transform_keys(brand_id: "brandId"),
+            page: Zavudev::Internal::Cursor,
+            model: Zavudev::Number10dlc::TenDlcCampaign,
+            options: options
+          )
+        end
+
+        # Delete 10DLC campaign
+        #
+        # @overload delete(campaign_id, request_options: {})
+        #
+        # @param campaign_id [String] 10DLC campaign ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignDeleteParams
+        def delete(campaign_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["v1/10dlc/campaigns/%1$s", campaign_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Submit a draft campaign for carrier review. The campaign must be in draft status
+        # and its brand must be verified.
+        #
+        # @overload submit(campaign_id, request_options: {})
+        #
+        # @param campaign_id [String] 10DLC campaign ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::CampaignSubmitResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignSubmitParams
+        def submit(campaign_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["v1/10dlc/campaigns/%1$s/submit", campaign_id],
+            model: Zavudev::Models::Number10dlc::CampaignSubmitResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Sync the campaign status with the registration provider. Use this to check for
+        # approval updates after submission.
+        #
+        # @overload sync_status(campaign_id, request_options: {})
+        #
+        # @param campaign_id [String] 10DLC campaign ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::CampaignSyncStatusResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::CampaignSyncStatusParams
+        def sync_status(campaign_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["v1/10dlc/campaigns/%1$s/sync", campaign_id],
+            model: Zavudev::Models::Number10dlc::CampaignSyncStatusResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Zavudev::Client]
+        def initialize(client:)
+          @client = client
+          @phone_numbers = Zavudev::Resources::Number10dlc::Campaigns::PhoneNumbers.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/resources/number_10dlc.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      # @return [Zavudev::Resources::Number10dlc::Brands]
+      attr_reader :brands
+
+      # @return [Zavudev::Resources::Number10dlc::Campaigns]
+      attr_reader :campaigns
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+        @brands = Zavudev::Resources::Number10dlc::Brands.new(client: client)
+        @campaigns = Zavudev::Resources::Number10dlc::Campaigns.new(client: client)
+      end
+    end
+  end
+end

data/lib/zavudev/resources/plan.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Plan
+      # Get the current subscription plan for the API key's team, including tier,
+      # billing interval, and period dates.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::PlanRetrieveResponse]
+      #
+      # @see Zavudev::Models::PlanRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "v1/plan",
+          model: Zavudev::Models::PlanRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/zavudev/resources/senders/whatsapp_sync.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Senders
+      class WhatsappSync
+        # Get the current sync status for a sender's WhatsApp coexistence account. Only
+        # available for senders connected in coexistence mode (WhatsApp Business App +
+        # Cloud API).
+        #
+        # @overload retrieve(sender_id, request_options: {})
+        #
+        # @param sender_id [String]
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Senders::WhatsappSyncRetrieveResponse]
+        #
+        # @see Zavudev::Models::Senders::WhatsappSyncRetrieveParams
+        def retrieve(sender_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/senders/%1$s/whatsapp-sync", sender_id],
+            model: Zavudev::Models::Senders::WhatsappSyncRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Initiate contact names sync from the WhatsApp Business App. This imports contact
+        # names stored in the app to Zavu. Only available for coexistence accounts with
+        # active status.
+        #
+        # @overload start_contacts_sync(sender_id, request_options: {})
+        #
+        # @param sender_id [String]
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Senders::WhatsappSyncStartContactsSyncResponse]
+        #
+        # @see Zavudev::Models::Senders::WhatsappSyncStartContactsSyncParams
+        def start_contacts_sync(sender_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["v1/senders/%1$s/whatsapp-sync/contacts", sender_id],
+            model: Zavudev::Models::Senders::WhatsappSyncStartContactsSyncResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Initiate message history sync from the WhatsApp Business App. This sends a
+        # request to the account owner to approve sharing their conversation history. Only
+        # available for coexistence accounts with active status.
+        #
+        # @overload start_history_sync(sender_id, request_options: {})
+        #
+        # @param sender_id [String]
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Senders::WhatsappSyncStartHistorySyncResponse]
+        #
+        # @see Zavudev::Models::Senders::WhatsappSyncStartHistorySyncParams
+        def start_history_sync(sender_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["v1/senders/%1$s/whatsapp-sync/history", sender_id],
+            model: Zavudev::Models::Senders::WhatsappSyncStartHistorySyncResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Zavudev::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/resources/senders.rb

@@ -6,6 +6,9 @@ module Zavudev
       # @return [Zavudev::Resources::Senders::Agent]
       attr_reader :agent
 
+      # @return [Zavudev::Resources::Senders::WhatsappSync]
+      attr_reader :whatsapp_sync
+
       # Create sender
       #
       # @overload create(name:, phone_number:, set_as_default: nil, webhook_events: nil, webhook_url: nil, request_options: {})
@@ -240,6 +243,7 @@ module Zavudev
       def initialize(client:)
         @client = client
         @agent = Zavudev::Resources::Senders::Agent.new(client: client)
+        @whatsapp_sync = Zavudev::Resources::Senders::WhatsappSync.new(client: client)
       end
     end
   end

data/lib/zavudev/resources/sub_accounts/api_keys.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class SubAccounts
+      class APIKeys
+        # Create sub-account API key
+        #
+        # @overload create(id, name:, environment: nil, permissions: nil, request_options: {})
+        #
+        # @param id [String] Sub-account ID.
+        #
+        # @param name [String]
+        #
+        # @param environment [Symbol, Zavudev::Models::SubAccounts::APIKeyCreateParams::Environment]
+        #
+        # @param permissions [Array<String>]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::SubAccounts::APIKeyCreateResponse]
+        #
+        # @see Zavudev::Models::SubAccounts::APIKeyCreateParams
+        def create(id, params)
+          parsed, options = Zavudev::SubAccounts::APIKeyCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/sub-accounts/%1$s/api-keys", id],
+            body: parsed,
+            model: Zavudev::Models::SubAccounts::APIKeyCreateResponse,
+            options: options
+          )
+        end
+
+        # List sub-account API keys
+        #
+        # @overload list(id, request_options: {})
+        #
+        # @param id [String] Sub-account ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::SubAccounts::APIKeyListResponse]
+        #
+        # @see Zavudev::Models::SubAccounts::APIKeyListParams
+        def list(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/sub-accounts/%1$s/api-keys", id],
+            model: Zavudev::Models::SubAccounts::APIKeyListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Revoke sub-account API key
+        #
+        # @overload revoke(key_id, id:, request_options: {})
+        #
+        # @param key_id [String] API key ID.
+        #
+        # @param id [String] Sub-account ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Zavudev::Models::SubAccounts::APIKeyRevokeParams
+        def revoke(key_id, params)
+          parsed, options = Zavudev::SubAccounts::APIKeyRevokeParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["v1/sub-accounts/%1$s/api-keys/%2$s", id, key_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Zavudev::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/zavudev/resources/sub_accounts.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class SubAccounts
+      # @return [Zavudev::Resources::SubAccounts::APIKeys]
+      attr_reader :api_keys
+
+      # Some parameter documentations has been truncated, see
+      # {Zavudev::Models::SubAccountCreateParams} for more details.
+      #
+      # Create a new sub-account (project) with its own API key. All charges are billed
+      # to the parent team's balance. Use creditLimit to set a spending cap. The
+      # sub-account's API key is returned only in the creation response.
+      #
+      # @overload create(name:, credit_limit: nil, external_id: nil, metadata: nil, request_options: {})
+      #
+      # @param name [String] Name of the sub-account.
+      #
+      # @param credit_limit [Integer] Spending cap in cents. When reached, messages from this sub-account will be bloc
+      #
+      # @param external_id [String] External reference ID for your own tracking.
+      #
+      # @param metadata [Hash{Symbol=>Object}]
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::SubAccountCreateResponse]
+      #
+      # @see Zavudev::Models::SubAccountCreateParams
+      def create(params)
+        parsed, options = Zavudev::SubAccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/sub-accounts",
+          body: parsed,
+          model: Zavudev::Models::SubAccountCreateResponse,
+          options: options
+        )
+      end
+
+      # Get sub-account
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Sub-account ID.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::SubAccountRetrieveResponse]
+      #
+      # @see Zavudev::Models::SubAccountRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/sub-accounts/%1$s", id],
+          model: Zavudev::Models::SubAccountRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Update sub-account
+      #
+      # @overload update(id, credit_limit: nil, external_id: nil, metadata: nil, name: nil, status: nil, request_options: {})
+      #
+      # @param id [String] Sub-account ID.
+      #
+      # @param credit_limit [Integer, nil]
+      #
+      # @param external_id [String]
+      #
+      # @param metadata [Hash{Symbol=>Object}]
+      #
+      # @param name [String]
+      #
+      # @param status [Symbol, Zavudev::Models::SubAccountUpdateParams::Status]
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::SubAccountUpdateResponse]
+      #
+      # @see Zavudev::Models::SubAccountUpdateParams
+      def update(id, params = {})
+        parsed, options = Zavudev::SubAccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/sub-accounts/%1$s", id],
+          body: parsed,
+          model: Zavudev::Models::SubAccountUpdateResponse,
+          options: options
+        )
+      end
+
+      # List sub-accounts for this team.
+      #
+      # @overload list(cursor: nil, limit: nil, request_options: {})
+      #
+      # @param cursor [String]
+      # @param limit [Integer]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Internal::Cursor<Zavudev::Models::SubAccount>]
+      #
+      # @see Zavudev::Models::SubAccountListParams
+      def list(params = {})
+        parsed, options = Zavudev::SubAccountListParams.dump_request(params)
+        query = Zavudev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/sub-accounts",
+          query: query,
+          page: Zavudev::Internal::Cursor,
+          model: Zavudev::SubAccount,
+          options: options
+        )
+      end
+
+      # Deactivate a sub-account. Remaining balance is returned to the parent team and
+      # all API keys are revoked.
+      #
+      # @overload deactivate(id, request_options: {})
+      #
+      # @param id [String] Sub-account ID.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::SubAccountDeactivateResponse]
+      #
+      # @see Zavudev::Models::SubAccountDeactivateParams
+      def deactivate(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/sub-accounts/%1$s", id],
+          model: Zavudev::Models::SubAccountDeactivateResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get spending information for a sub-account. Returns the parent team's balance,
+      # the sub-account's total spending, and its credit limit (spending cap).
+      #
+      # @overload get_balance(id, request_options: {})
+      #
+      # @param id [String] Sub-account ID.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::SubAccountGetBalanceResponse]
+      #
+      # @see Zavudev::Models::SubAccountGetBalanceParams
+      def get_balance(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/sub-accounts/%1$s/balance", id],
+          model: Zavudev::Models::SubAccountGetBalanceResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+        @api_keys = Zavudev::Resources::SubAccounts::APIKeys.new(client: client)
+      end
+    end
+  end
+end