subtain-apimatic-sdk 2.4.69 → 3.1.0

data/lib/advanced_billing/controllers/reason_codes_controller.rb

@@ -1,158 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # ReasonCodesController
-  class ReasonCodesController < BaseController
-    # This method gives a merchant the option to retrieve a list of a particular
-    # code for a given Site by providing the unique numerical ID of the code.
-    # @param [Integer] reason_code_id Required parameter: The Chargify id of the
-    # reason code
-    # @return [ReasonCodeResponse] response from the API call
-    def read_reason_code(reason_code_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/reason_codes/{reason_code_id}.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(reason_code_id, key: 'reason_code_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ReasonCodeResponse.method(:from_hash))
-                   .local_error('404',
-                                'Not Found',
-                                APIException))
-        .execute
-    end
-
-    # This method gives a merchant the option to delete one reason code from the
-    # Churn Reason Codes. This code will be immediately removed. This action is
-    # not reversable.
-    # @param [Integer] reason_code_id Required parameter: The Chargify id of the
-    # reason code
-    # @return [ReasonCodesJsonResponse] response from the API call
-    def delete_reason_code(reason_code_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::DELETE,
-                                     '/reason_codes/{reason_code_id}.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(reason_code_id, key: 'reason_code_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ReasonCodesJsonResponse.method(:from_hash))
-                   .local_error('404',
-                                'Not Found',
-                                APIException))
-        .execute
-    end
-
-    # This method gives a merchant the option to retrieve a list of all of the
-    # current churn codes for a given site.
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # many records to fetch in each request. Default value is 20. The maximum
-    # allowed values is 200; any per_page value over 200 will be changed to 200.
-    # Use in query `per_page=200`.
-    # @return [Array[ReasonCodeResponse]] response from the API call
-    def list_reason_codes(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/reason_codes.json',
-                                     Server::DEFAULT)
-                   .query_param(new_parameter(options['page'], key: 'page'))
-                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ReasonCodeResponse.method(:from_hash))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # This method gives a merchant the option to update an existing reason code
-    # for a given site.
-    # @param [Integer] reason_code_id Required parameter: The Chargify id of the
-    # reason code
-    # @param [UpdateReasonCodeRequest] body Optional parameter: Example:
-    # @return [ReasonCodeResponse] response from the API call
-    def update_reason_code(reason_code_id,
-                           body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::PUT,
-                                     '/reason_codes/{reason_code_id}.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(reason_code_id, key: 'reason_code_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ReasonCodeResponse.method(:from_hash))
-                   .local_error('404',
-                                'Not Found',
-                                APIException))
-        .execute
-    end
-
-    # # Reason Codes Intro
-    # ReasonCodes are a way to gain a high level view of why your customers are
-    # cancelling the subcription to your product or service.
-    # Add a set of churn reason codes to be displayed in-app and/or the Chargify
-    # Billing Portal. As your subscribers decide to cancel their subscription,
-    # learn why they decided to cancel.
-    # ## Reason Code Documentation
-    # Full documentation on how Reason Codes operate within Chargify can be
-    # located under the following links.
-    # [Churn Reason
-    # Codes](https://chargify.zendesk.com/hc/en-us/articles/4407896775579#churn-
-    # reason-codes)
-    # ## Create Reason Code
-    # This method gives a merchant the option to create a reason codes for a
-    # given Site.
-    # @param [CreateReasonCodeRequest] body Optional parameter: Example:
-    # @return [ReasonCodeResponse] response from the API call
-    def create_reason_code(body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/reason_codes.json',
-                                     Server::DEFAULT)
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ReasonCodeResponse.method(:from_hash))
-                   .local_error('422',
-                                'Unprocessable Entity (WebDAV)',
-                                ErrorListResponseException))
-        .execute
-    end
-  end
-end

data/lib/advanced_billing/controllers/referral_codes_controller.rb

@@ -1,42 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # ReferralCodesController
-  class ReferralCodesController < BaseController
-    # Use this method to determine if the referral code is valid and applicable
-    # within your Site. This method is useful for validating referral codes that
-    # are entered by a customer.
-    # ## Referrals Documentation
-    # Full documentation on how to use the referrals feature in the Chargify UI
-    # can be located
-    # [here](https://chargify.zendesk.com/hc/en-us/articles/4407802831643).
-    # ## Server Response
-    # If the referral code is valid the status code will be `200` and the
-    # referral code will be returned. If the referral code is invalid, a `404`
-    # response will be returned.
-    # @param [String] code Required parameter: The referral code you are trying
-    # to validate
-    # @return [ReferralValidationResponse] response from the API call
-    def validate_referral_code(code)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/referral_codes/validate.json',
-                                     Server::DEFAULT)
-                   .query_param(new_parameter(code, key: 'code')
-                                 .is_required(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ReferralValidationResponse.method(:from_hash))
-                   .local_error('404',
-                                'Not Found',
-                                SingleStringErrorResponseException))
-        .execute
-    end
-  end
-end

data/lib/advanced_billing/controllers/sales_commissions_controller.rb

@@ -1,192 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # SalesCommissionsController
-  class SalesCommissionsController < BaseController
-    # Endpoint returns sales rep list with details
-    # ## Modified Authentication Process
-    # The Sales Commission API differs from other Chargify API endpoints. This
-    # resource is associated with the seller itself. Up to now all available
-    # resources were at the level of the site, therefore creating the API Key
-    # per site was a sufficient solution. To share resources at the seller
-    # level, a new authentication method was introduced, which is user
-    # authentication. Creating an API Key for a user is a required step to
-    # correctly use the Sales Commission API, more details
-    # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
-    # 0-2020-04-20-new-api-authentication).
-    # Access to the Sales Commission API endpoints is available to users with
-    # financial access, where the seller has the Advanced Analytics component
-    # enabled. For further information on getting access to Advanced Analytics
-    # please contact Chargify support.
-    # > Note: The request is at seller level, it means `<<subdomain>>` variable
-    # will be replaced by `app`
-    # @param [String] seller_id Required parameter: The Chargify id of your
-    # seller account
-    # @param [String] authorization Optional parameter: For authorization use
-    # user API key. See details
-    # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
-    # 0-2020-04-20-new-api-authentication).
-    # @param [TrueClass | FalseClass] live_mode Optional parameter: This
-    # parameter indicates if records should be fetched from live mode sites.
-    # Default value is true.
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # many records to fetch in each request. Default value is 100.
-    # @return [Array[ListSaleRepItem]] response from the API call
-    def list_sales_reps(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/sellers/{seller_id}/sales_reps.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(options['seller_id'], key: 'seller_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter(options['authorization'], key: 'Authorization'))
-                   .query_param(new_parameter(options['live_mode'], key: 'live_mode'))
-                   .query_param(new_parameter(options['page'], key: 'page'))
-                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ListSaleRepItem.method(:from_hash))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Endpoint returns sales rep and attached subscriptions details.
-    # ## Modified Authentication Process
-    # The Sales Commission API differs from other Chargify API endpoints. This
-    # resource is associated with the seller itself. Up to now all available
-    # resources were at the level of the site, therefore creating the API Key
-    # per site was a sufficient solution. To share resources at the seller
-    # level, a new authentication method was introduced, which is user
-    # authentication. Creating an API Key for a user is a required step to
-    # correctly use the Sales Commission API, more details
-    # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
-    # 0-2020-04-20-new-api-authentication).
-    # Access to the Sales Commission API endpoints is available to users with
-    # financial access, where the seller has the Advanced Analytics component
-    # enabled. For further information on getting access to Advanced Analytics
-    # please contact Chargify support.
-    # > Note: The request is at seller level, it means `<<subdomain>>` variable
-    # will be replaced by `app`
-    # @param [String] seller_id Required parameter: The Chargify id of your
-    # seller account
-    # @param [String] sales_rep_id Required parameter: The Chargify id of sales
-    # rep.
-    # @param [String] authorization Optional parameter: For authorization use
-    # user API key. See details
-    # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
-    # 0-2020-04-20-new-api-authentication).
-    # @param [TrueClass | FalseClass] live_mode Optional parameter: This
-    # parameter indicates if records should be fetched from live mode sites.
-    # Default value is true.
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # many records to fetch in each request. Default value is 100.
-    # @return [SaleRep] response from the API call
-    def read_sales_rep(seller_id,
-                       sales_rep_id,
-                       authorization: 'Bearer <<apiKey>>',
-                       live_mode: nil,
-                       page: 1,
-                       per_page: 100)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/sellers/{seller_id}/sales_reps/{sales_rep_id}.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(seller_id, key: 'seller_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .template_param(new_parameter(sales_rep_id, key: 'sales_rep_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter(authorization, key: 'Authorization'))
-                   .query_param(new_parameter(live_mode, key: 'live_mode'))
-                   .query_param(new_parameter(page, key: 'page'))
-                   .query_param(new_parameter(per_page, key: 'per_page'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SaleRep.method(:from_hash)))
-        .execute
-    end
-
-    # Endpoint returns subscriptions with associated sales reps
-    # ## Modified Authentication Process
-    # The Sales Commission API differs from other Chargify API endpoints. This
-    # resource is associated with the seller itself. Up to now all available
-    # resources were at the level of the site, therefore creating the API Key
-    # per site was a sufficient solution. To share resources at the seller
-    # level, a new authentication method was introduced, which is user
-    # authentication. Creating an API Key for a user is a required step to
-    # correctly use the Sales Commission API, more details
-    # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
-    # 0-2020-04-20-new-api-authentication).
-    # Access to the Sales Commission API endpoints is available to users with
-    # financial access, where the seller has the Advanced Analytics component
-    # enabled. For further information on getting access to Advanced Analytics
-    # please contact Chargify support.
-    # > Note: The request is at seller level, it means `<<subdomain>>` variable
-    # will be replaced by `app`
-    # @param [String] seller_id Required parameter: The Chargify id of your
-    # seller account
-    # @param [String] authorization Optional parameter: For authorization use
-    # user API key. See details
-    # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
-    # 0-2020-04-20-new-api-authentication).
-    # @param [TrueClass | FalseClass] live_mode Optional parameter: This
-    # parameter indicates if records should be fetched from live mode sites.
-    # Default value is true.
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # many records to fetch in each request. Default value is 100.
-    # @return [Array[SaleRepSettings]] response from the API call
-    def list_sales_commission_settings(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/sellers/{seller_id}/sales_commission_settings.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(options['seller_id'], key: 'seller_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter(options['authorization'], key: 'Authorization'))
-                   .query_param(new_parameter(options['live_mode'], key: 'live_mode'))
-                   .query_param(new_parameter(options['page'], key: 'page'))
-                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SaleRepSettings.method(:from_hash))
-                   .is_response_array(true))
-        .execute
-    end
-  end
-end

data/lib/advanced_billing/controllers/sites_controller.rb

@@ -1,96 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # SitesController
-  class SitesController < BaseController
-    # This endpoint returns public keys used for Chargify.js.
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # many records to fetch in each request. Default value is 20. The maximum
-    # allowed values is 200; any per_page value over 200 will be changed to 200.
-    # Use in query `per_page=200`.
-    # @return [ListPublicKeysResponse] response from the API call
-    def list_chargify_js_public_keys(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/chargify_js_keys.json',
-                                     Server::DEFAULT)
-                   .query_param(new_parameter(options['page'], key: 'page'))
-                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ListPublicKeysResponse.method(:from_hash)))
-        .execute
-    end
-
-    # This call is asynchronous and there may be a delay before the site data is
-    # fully deleted. If you are clearing site data for an automated test, you
-    # will need to build in a delay and/or check that there are no products,
-    # etc., in the site before proceeding.
-    # **This functionality will only work on sites in TEST mode. Attempts to
-    # perform this on sites in “live” mode will result in a response of 403
-    # FORBIDDEN.**
-    # @param [CleanupScope] cleanup_scope Optional parameter: `all`: Will clear
-    # all products, customers, and related subscriptions from the site.
-    # `customers`: Will clear only customers and related subscriptions (leaving
-    # the products untouched) for the site.  Revenue will also be reset to 0.
-    # Use in query `cleanup_scope=all`.
-    # @return [void] response from the API call
-    def clear_site(cleanup_scope: CleanupScope::ALL)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/sites/clear_data.json',
-                                     Server::DEFAULT)
-                   .query_param(new_parameter(cleanup_scope, key: 'cleanup_scope'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .is_response_void(true)
-                   .local_error('403',
-                                'Forbidden',
-                                APIException))
-        .execute
-    end
-
-    # This endpoint allows you to fetch some site data.
-    # Full documentation on Sites in the Chargify UI can be located
-    # [here](https://chargify.zendesk.com/hc/en-us/articles/4407870738587).
-    # Specifically, the [Clearing Site
-    # Data](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405428327309)
-    # section is extremely relevant to this endpoint documentation.
-    # #### Relationship invoicing enabled
-    # If site has RI enabled then you will see more settings like:
-    #     "customer_hierarchy_enabled": true,
-    #     "whopays_enabled": true,
-    #     "whopays_default_payer": "self"
-    # You can read more about these settings here:
-    #  [Who Pays & Customer
-    # Hierarchy](https://chargify.zendesk.com/hc/en-us/articles/4407746683291)
-    # @return [SiteResponse] response from the API call
-    def read_site
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/site.json',
-                                     Server::DEFAULT)
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SiteResponse.method(:from_hash)))
-        .execute
-    end
-  end
-end