Class: Square::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/square/client.rb

Overview

square client class.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_client_instance: nil, timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put], environment: 'production', custom_url: 'https://connect.squareup.com', square_version: '2022-01-20', access_token: '', user_agent_detail: '', additional_headers: {}, config: nil) ⇒ Client

Returns a new instance of Client.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/square/client.rb', line 216

def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
               retry_interval: 1, backoff_factor: 2,
               retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
               retry_methods: %i[get put], environment: 'production',
               custom_url: 'https://connect.squareup.com',
               square_version: '2022-01-20', access_token: '',
               user_agent_detail: '', additional_headers: {}, config: nil)
  @config = if config.nil?
              Configuration.new(http_client_instance: http_client_instance,
                                timeout: timeout, max_retries: max_retries,
                                retry_interval: retry_interval,
                                backoff_factor: backoff_factor,
                                retry_statuses: retry_statuses,
                                retry_methods: retry_methods,
                                environment: environment,
                                custom_url: custom_url,
                                square_version: square_version,
                                access_token: access_token,
                                user_agent_detail: user_agent_detail,
                                additional_headers: additional_headers)
            else
              config
            end
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



4
5
6
 
# File 'lib/square/client.rb', line 4

def config
  @config
end

Instance Method Details

#apple_pay ⇒ ApplePayApi

Access to apple_pay controller.

Returns:



38
39
40
 
# File 'lib/square/client.rb', line 38

def apple_pay
  @apple_pay ||= ApplePayApi.new config
end

#bank_accounts ⇒ BankAccountsApi

Access to bank_accounts controller.

Returns:



44
45
46
 
# File 'lib/square/client.rb', line 44

def bank_accounts
  @bank_accounts ||= BankAccountsApi.new config
end

#bookings ⇒ BookingsApi

Access to bookings controller.

Returns:



50
51
52
 
# File 'lib/square/client.rb', line 50

def bookings
  @bookings ||= BookingsApi.new config
end

#cards ⇒ CardsApi

Access to cards controller.

Returns:

  • (CardsApi) —

    Returns the controller instance.



56
57
58
 
# File 'lib/square/client.rb', line 56

def cards
  @cards ||= CardsApi.new config
end

#cash_drawers ⇒ CashDrawersApi

Access to cash_drawers controller.

Returns:



62
63
64
 
# File 'lib/square/client.rb', line 62

def cash_drawers
  @cash_drawers ||= CashDrawersApi.new config
end

#catalog ⇒ CatalogApi

Access to catalog controller.

Returns:

  • (CatalogApi) —

    Returns the controller instance.



68
69
70
 
# File 'lib/square/client.rb', line 68

def catalog
  @catalog ||= CatalogApi.new config
end

#checkout ⇒ CheckoutApi

Access to checkout controller.

Returns:



146
147
148
 
# File 'lib/square/client.rb', line 146

def checkout
  @checkout ||= CheckoutApi.new config
end

#customer_groups ⇒ CustomerGroupsApi

Access to customer_groups controller.

Returns:



80
81
82
 
# File 'lib/square/client.rb', line 80

def customer_groups
  @customer_groups ||= CustomerGroupsApi.new config
end

#customer_segments ⇒ CustomerSegmentsApi

Access to customer_segments controller.

Returns:



86
87
88
 
# File 'lib/square/client.rb', line 86

def customer_segments
  @customer_segments ||= CustomerSegmentsApi.new config
end

#customers ⇒ CustomersApi

Access to customers controller.

Returns:



74
75
76
 
# File 'lib/square/client.rb', line 74

def customers
  @customers ||= CustomersApi.new config
end

#devices ⇒ DevicesApi

Access to devices controller.

Returns:

  • (DevicesApi) —

    Returns the controller instance.



92
93
94
 
# File 'lib/square/client.rb', line 92

def devices
  @devices ||= DevicesApi.new config
end

#disputes ⇒ DisputesApi

Access to disputes controller.

Returns:



98
99
100
 
# File 'lib/square/client.rb', line 98

def disputes
  @disputes ||= DisputesApi.new config
end

#employees ⇒ EmployeesApi

Access to employees controller.

Returns:



104
105
106
 
# File 'lib/square/client.rb', line 104

def employees
  @employees ||= EmployeesApi.new config
end

#gift_card_activities ⇒ GiftCardActivitiesApi

Access to gift_card_activities controller.

Returns:



116
117
118
 
# File 'lib/square/client.rb', line 116

def gift_card_activities
  @gift_card_activities ||= GiftCardActivitiesApi.new config
end

#gift_cards ⇒ GiftCardsApi

Access to gift_cards controller.

Returns:



110
111
112
 
# File 'lib/square/client.rb', line 110

def gift_cards
  @gift_cards ||= GiftCardsApi.new config
end

#inventory ⇒ InventoryApi

Access to inventory controller.

Returns:



122
123
124
 
# File 'lib/square/client.rb', line 122

def inventory
  @inventory ||= InventoryApi.new config
end

#invoices ⇒ InvoicesApi

Access to invoices controller.

Returns:



128
129
130
 
# File 'lib/square/client.rb', line 128

def invoices
  @invoices ||= InvoicesApi.new config
end

#labor ⇒ LaborApi

Access to labor controller.

Returns:

  • (LaborApi) —

    Returns the controller instance.



134
135
136
 
# File 'lib/square/client.rb', line 134

def labor
  @labor ||= LaborApi.new config
end

#locations ⇒ LocationsApi

Access to locations controller.

Returns:



140
141
142
 
# File 'lib/square/client.rb', line 140

def locations
  @locations ||= LocationsApi.new config
end

#loyalty ⇒ LoyaltyApi

Access to loyalty controller.

Returns:

  • (LoyaltyApi) —

    Returns the controller instance.



158
159
160
 
# File 'lib/square/client.rb', line 158

def loyalty
  @loyalty ||= LoyaltyApi.new config
end

#merchants ⇒ MerchantsApi

Access to merchants controller.

Returns:



164
165
166
 
# File 'lib/square/client.rb', line 164

def merchants
  @merchants ||= MerchantsApi.new config
end

#mobile_authorization ⇒ MobileAuthorizationApi

Access to mobile_authorization controller.

Returns:



20
21
22
 
# File 'lib/square/client.rb', line 20

def mobile_authorization
  @mobile_authorization ||= MobileAuthorizationApi.new config
end

#o_auth ⇒ OAuthApi

Access to o_auth controller.

Returns:

  • (OAuthApi) —

    Returns the controller instance.



26
27
28
 
# File 'lib/square/client.rb', line 26

def o_auth
  @o_auth ||= OAuthApi.new config
end

#orders ⇒ OrdersApi

Access to orders controller.

Returns:

  • (OrdersApi) —

    Returns the controller instance.



170
171
172
 
# File 'lib/square/client.rb', line 170

def orders
  @orders ||= OrdersApi.new config
end

#payments ⇒ PaymentsApi

Access to payments controller.

Returns:



176
177
178
 
# File 'lib/square/client.rb', line 176

def payments
  @payments ||= PaymentsApi.new config
end

#refunds ⇒ RefundsApi

Access to refunds controller.

Returns:

  • (RefundsApi) —

    Returns the controller instance.



182
183
184
 
# File 'lib/square/client.rb', line 182

def refunds
  @refunds ||= RefundsApi.new config
end

#sdk_version ⇒ Object 



6
7
8
 
# File 'lib/square/client.rb', line 6

def sdk_version
  '17.1.0.20220120'
end

#sites ⇒ SitesApi

Access to sites controller.

Returns:

  • (SitesApi) —

    Returns the controller instance.



188
189
190
 
# File 'lib/square/client.rb', line 188

def sites
  @sites ||= SitesApi.new config
end

#snippets ⇒ SnippetsApi

Access to snippets controller.

Returns:



194
195
196
 
# File 'lib/square/client.rb', line 194

def snippets
  @snippets ||= SnippetsApi.new config
end

#square_version ⇒ Object 



10
11
12
 
# File 'lib/square/client.rb', line 10

def square_version
  config.square_version
end

#subscriptions ⇒ SubscriptionsApi

Access to subscriptions controller.

Returns:



200
201
202
 
# File 'lib/square/client.rb', line 200

def subscriptions
  @subscriptions ||= SubscriptionsApi.new config
end

#team ⇒ TeamApi

Access to team controller.

Returns:

  • (TeamApi) —

    Returns the controller instance.



206
207
208
 
# File 'lib/square/client.rb', line 206

def team
  @team ||= TeamApi.new config
end

#terminal ⇒ TerminalApi

Access to terminal controller.

Returns:



212
213
214
 
# File 'lib/square/client.rb', line 212

def terminal
  @terminal ||= TerminalApi.new config
end

#transactions ⇒ TransactionsApi

Access to transactions controller.

Returns:



152
153
154
 
# File 'lib/square/client.rb', line 152

def transactions
  @transactions ||= TransactionsApi.new config
end

#user_agent_detail ⇒ Object 



14
15
16
 
# File 'lib/square/client.rb', line 14

def user_agent_detail
  config.user_agent_detail
end

#v1_transactions ⇒ V1TransactionsApi

Access to v1_transactions controller.

Returns:



32
33
34
 
# File 'lib/square/client.rb', line 32

def v1_transactions
  @v1_transactions ||= V1TransactionsApi.new config
end