zavudev 0.7.0 → 0.9.0

data/lib/zavudev/resources/exports.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Exports
+      # Create a new data export job. The export will be processed asynchronously and
+      # the download URL will be available when status is 'completed'. Export links
+      # expire after 24 hours.
+      #
+      # @overload create(data_types:, date_from: nil, date_to: nil, request_options: {})
+      #
+      # @param data_types [Array<Symbol, Zavudev::Models::ExportCreateParams::DataType>] List of data types to include in the export.
+      #
+      # @param date_from [Time] Start date for data to export (inclusive).
+      #
+      # @param date_to [Time] End date for data to export (inclusive).
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::ExportCreateResponse]
+      #
+      # @see Zavudev::Models::ExportCreateParams
+      def create(params)
+        parsed, options = Zavudev::ExportCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/exports",
+          body: parsed,
+          model: Zavudev::Models::ExportCreateResponse,
+          options: options
+        )
+      end
+
+      # Get details of a specific data export, including download URL when completed.
+      #
+      # @overload retrieve(export_id, request_options: {})
+      #
+      # @param export_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::ExportRetrieveResponse]
+      #
+      # @see Zavudev::Models::ExportRetrieveParams
+      def retrieve(export_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/exports/%1$s", export_id],
+          model: Zavudev::Models::ExportRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # List data exports for this project.
+      #
+      # @overload list(cursor: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param cursor [String]
+      #
+      # @param limit [Integer]
+      #
+      # @param status [Symbol, Zavudev::Models::ExportListParams::Status] Status of a data export job.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Internal::Cursor<Zavudev::Models::DataExport>]
+      #
+      # @see Zavudev::Models::ExportListParams
+      def list(params = {})
+        parsed, options = Zavudev::ExportListParams.dump_request(params)
+        query = Zavudev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/exports",
+          query: query,
+          page: Zavudev::Internal::Cursor,
+          model: Zavudev::DataExport,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/zavudev/resources/invitations.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Invitations
+      # Some parameter documentations has been truncated, see
+      # {Zavudev::Models::InvitationCreateParams} for more details.
+      #
+      # Create a partner invitation link for a client to connect their WhatsApp Business
+      # account. The client will complete Meta's embedded signup flow and the resulting
+      # sender will be created in your project.
+      #
+      # @overload create(allowed_phone_countries: nil, client_email: nil, client_name: nil, client_phone: nil, expires_in_days: nil, phone_number_id: nil, request_options: {})
+      #
+      # @param allowed_phone_countries [Array<String>] ISO country codes for allowed phone numbers.
+      #
+      # @param client_email [String] Email of the client being invited.
+      #
+      # @param client_name [String] Name of the client being invited.
+      #
+      # @param client_phone [String] Phone number of the client in E.164 format.
+      #
+      # @param expires_in_days [Integer] Number of days until the invitation expires.
+      #
+      # @param phone_number_id [String] ID of a Zavu phone number to pre-assign for WhatsApp registration. If provided,
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::InvitationCreateResponse]
+      #
+      # @see Zavudev::Models::InvitationCreateParams
+      def create(params = {})
+        parsed, options = Zavudev::InvitationCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/invitations",
+          body: parsed,
+          model: Zavudev::Models::InvitationCreateResponse,
+          options: options
+        )
+      end
+
+      # Get invitation
+      #
+      # @overload retrieve(invitation_id, request_options: {})
+      #
+      # @param invitation_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::InvitationRetrieveResponse]
+      #
+      # @see Zavudev::Models::InvitationRetrieveParams
+      def retrieve(invitation_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/invitations/%1$s", invitation_id],
+          model: Zavudev::Models::InvitationRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # List partner invitations for this project.
+      #
+      # @overload list(cursor: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param cursor [String]
+      #
+      # @param limit [Integer]
+      #
+      # @param status [Symbol, Zavudev::Models::InvitationListParams::Status] Current status of the partner invitation.
+      #
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Internal::Cursor<Zavudev::Models::Invitation>]
+      #
+      # @see Zavudev::Models::InvitationListParams
+      def list(params = {})
+        parsed, options = Zavudev::InvitationListParams.dump_request(params)
+        query = Zavudev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/invitations",
+          query: query,
+          page: Zavudev::Internal::Cursor,
+          model: Zavudev::Invitation,
+          options: options
+        )
+      end
+
+      # Cancel an active invitation. The client will no longer be able to use the
+      # invitation link.
+      #
+      # @overload cancel(invitation_id, request_options: {})
+      #
+      # @param invitation_id [String]
+      # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Zavudev::Models::InvitationCancelResponse]
+      #
+      # @see Zavudev::Models::InvitationCancelParams
+      def cancel(invitation_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["v1/invitations/%1$s/cancel", invitation_id],
+          model: Zavudev::Models::InvitationCancelResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Zavudev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      class Brands
+        # Create a 10DLC brand registration. The brand starts in draft status. Submit it
+        # for review using the submit endpoint.
+        #
+        # @overload create(city:, country:, display_name:, email:, entity_type:, phone:, postal_code:, state:, street:, vertical:, company_name: nil, ein: nil, first_name: nil, last_name: nil, stock_exchange: nil, stock_symbol: nil, website: nil, request_options: {})
+        #
+        # @param city [String]
+        #
+        # @param country [String] Two-letter ISO country code.
+        #
+        # @param display_name [String] Display name of the brand.
+        #
+        # @param email [String]
+        #
+        # @param entity_type [Symbol, Zavudev::Models::Number10dlc::BrandCreateParams::EntityType] Business entity type for 10DLC brand registration.
+        #
+        # @param phone [String] Contact phone in E.164 format.
+        #
+        # @param postal_code [String]
+        #
+        # @param state [String]
+        #
+        # @param street [String]
+        #
+        # @param vertical [String] Industry vertical.
+        #
+        # @param company_name [String] Legal company name.
+        #
+        # @param ein [String] Employer Identification Number (format: XX-XXXXXXX).
+        #
+        # @param first_name [String]
+        #
+        # @param last_name [String]
+        #
+        # @param stock_exchange [String]
+        #
+        # @param stock_symbol [String]
+        #
+        # @param website [String]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::BrandCreateResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandCreateParams
+        def create(params)
+          parsed, options = Zavudev::Number10dlc::BrandCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/10dlc/brands",
+            body: parsed,
+            model: Zavudev::Models::Number10dlc::BrandCreateResponse,
+            options: options
+          )
+        end
+
+        # Get 10DLC brand
+        #
+        # @overload retrieve(brand_id, request_options: {})
+        #
+        # @param brand_id [String] 10DLC brand ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::BrandRetrieveResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandRetrieveParams
+        def retrieve(brand_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/10dlc/brands/%1$s", brand_id],
+            model: Zavudev::Models::Number10dlc::BrandRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Update a 10DLC brand in draft status. Cannot update after submission.
+        #
+        # @overload update(brand_id, city: nil, company_name: nil, country: nil, display_name: nil, ein: nil, email: nil, entity_type: nil, first_name: nil, last_name: nil, phone: nil, postal_code: nil, state: nil, stock_exchange: nil, stock_symbol: nil, street: nil, vertical: nil, website: nil, request_options: {})
+        #
+        # @param brand_id [String] 10DLC brand ID.
+        #
+        # @param city [String]
+        #
+        # @param company_name [String]
+        #
+        # @param country [String]
+        #
+        # @param display_name [String]
+        #
+        # @param ein [String]
+        #
+        # @param email [String]
+        #
+        # @param entity_type [Symbol, Zavudev::Models::Number10dlc::BrandUpdateParams::EntityType] Business entity type for 10DLC brand registration.
+        #
+        # @param first_name [String]
+        #
+        # @param last_name [String]
+        #
+        # @param phone [String]
+        #
+        # @param postal_code [String]
+        #
+        # @param state [String]
+        #
+        # @param stock_exchange [String]
+        #
+        # @param stock_symbol [String]
+        #
+        # @param street [String]
+        #
+        # @param vertical [String]
+        #
+        # @param website [String]
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::BrandUpdateResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandUpdateParams
+        def update(brand_id, params = {})
+          parsed, options = Zavudev::Number10dlc::BrandUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["v1/10dlc/brands/%1$s", brand_id],
+            body: parsed,
+            model: Zavudev::Models::Number10dlc::BrandUpdateResponse,
+            options: options
+          )
+        end
+
+        # List 10DLC brand registrations for this project.
+        #
+        # @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::Number10dlc::TenDlcBrand>]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandListParams
+        def list(params = {})
+          parsed, options = Zavudev::Number10dlc::BrandListParams.dump_request(params)
+          query = Zavudev::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "v1/10dlc/brands",
+            query: query,
+            page: Zavudev::Internal::Cursor,
+            model: Zavudev::Number10dlc::TenDlcBrand,
+            options: options
+          )
+        end
+
+        # Delete 10DLC brand
+        #
+        # @overload delete(brand_id, request_options: {})
+        #
+        # @param brand_id [String] 10DLC brand ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandDeleteParams
+        def delete(brand_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["v1/10dlc/brands/%1$s", brand_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # List available use cases for 10DLC campaign registration.
+        #
+        # @overload list_use_cases(request_options: {})
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::BrandListUseCasesResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandListUseCasesParams
+        def list_use_cases(params = {})
+          @client.request(
+            method: :get,
+            path: "v1/10dlc/brands/use-cases",
+            model: Zavudev::Models::Number10dlc::BrandListUseCasesResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Submit a draft brand to The Campaign Registry (TCR) for vetting. The brand must
+        # be in draft status. A $35 registration fee is charged from your balance.
+        #
+        # @overload submit(brand_id, request_options: {})
+        #
+        # @param brand_id [String] 10DLC brand ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::BrandSubmitResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandSubmitParams
+        def submit(brand_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["v1/10dlc/brands/%1$s/submit", brand_id],
+            model: Zavudev::Models::Number10dlc::BrandSubmitResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Sync the brand status with the registration provider. Use this to check for
+        # approval updates after submission.
+        #
+        # @overload sync_status(brand_id, request_options: {})
+        #
+        # @param brand_id [String] 10DLC brand ID.
+        #
+        # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Zavudev::Models::Number10dlc::BrandSyncStatusResponse]
+        #
+        # @see Zavudev::Models::Number10dlc::BrandSyncStatusParams
+        def sync_status(brand_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["v1/10dlc/brands/%1$s/sync", brand_id],
+            model: Zavudev::Models::Number10dlc::BrandSyncStatusResponse,
+            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/number_10dlc/campaigns/phone_numbers.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Zavudev
+  module Resources
+    class Number10dlc
+      class Campaigns
+        class PhoneNumbers
+          # List phone numbers assigned to a 10DLC campaign.
+          #
+          # @overload list(campaign_id, request_options: {})
+          #
+          # @param campaign_id [String] 10DLC campaign ID.
+          #
+          # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Zavudev::Models::Number10dlc::Campaigns::PhoneNumberListResponse]
+          #
+          # @see Zavudev::Models::Number10dlc::Campaigns::PhoneNumberListParams
+          def list(campaign_id, params = {})
+            @client.request(
+              method: :get,
+              path: ["v1/10dlc/campaigns/%1$s/phone-numbers", campaign_id],
+              model: Zavudev::Models::Number10dlc::Campaigns::PhoneNumberListResponse,
+              options: params[:request_options]
+            )
+          end
+
+          # Assign a US phone number to an approved 10DLC campaign. The campaign must be in
+          # approved status.
+          #
+          # @overload assign(campaign_id, phone_number_id:, request_options: {})
+          #
+          # @param campaign_id [String] 10DLC campaign ID.
+          #
+          # @param phone_number_id [String] ID of the phone number to assign.
+          #
+          # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Zavudev::Models::Number10dlc::Campaigns::PhoneNumberAssignResponse]
+          #
+          # @see Zavudev::Models::Number10dlc::Campaigns::PhoneNumberAssignParams
+          def assign(campaign_id, params)
+            parsed, options = Zavudev::Number10dlc::Campaigns::PhoneNumberAssignParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["v1/10dlc/campaigns/%1$s/phone-numbers", campaign_id],
+              body: parsed,
+              model: Zavudev::Models::Number10dlc::Campaigns::PhoneNumberAssignResponse,
+              options: options
+            )
+          end
+
+          # Remove a phone number assignment from a 10DLC campaign.
+          #
+          # @overload unassign(assignment_id, campaign_id:, request_options: {})
+          #
+          # @param assignment_id [String] Phone number assignment ID.
+          #
+          # @param campaign_id [String] 10DLC campaign ID.
+          #
+          # @param request_options [Zavudev::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Zavudev::Models::Number10dlc::Campaigns::PhoneNumberUnassignParams
+          def unassign(assignment_id, params)
+            parsed, options = Zavudev::Number10dlc::Campaigns::PhoneNumberUnassignParams.dump_request(params)
+            campaign_id =
+              parsed.delete(:campaign_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["v1/10dlc/campaigns/%1$s/phone-numbers/%2$s", campaign_id, assignment_id],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Zavudev::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end